View on GitHub

Hummingbird

🐦 Tap our app, it closes the pay gap

Installing Hummingbird

Environment

Python Version

Hummingbird supports a minimum of Python 3.5 and a maximum of Python 3.7 with all options enabled, and Python 3.8 with machine learning disabled.

Dependencies

The following distributions will be automatically installed with downloading and installing Hummingbird.

Optional Dependencies

Virtual Environments

You can use a virtual environment to manage the dependencies for your project, both in development and in production. However, it is not necessary as these packages do not often have conflicts (with the exception of machine learning packages) and production is often already containerized.

You can read the Flask documentation here on virtual environments if you are curious what problems a virtual environment may solve for you, since they will separate your Python project into its own separate group which may be of benefit to you.

You can use venv in order to initialize a Python virtual environment, since Hummingbird requires Python 3.5 or newer. Do not follow Python 2 instructions for creating a virtual environment as directed by Flask, which is a dependency of Hummingbird.

Fast Installation

You can create a quick virtual environment in Python 3 by first creating a project folder with structure:

mkdir ProjectName
cd ProjectName
python -m venv venv

and then you can activate it by running

. venv/bin/activate

In Windows, you would run the same commands to create a project folder, but you activate it with the following script instead:

venv\Scripts\Activate.bat

Getting Packages

After creating a virtual environment or using your main development environment, you can simply run:

pip install -r requirements.txt