/hummingbird-v2

Primary LanguagePython

Hummingbird V2

Project Resources

  • Language: Python 3.7
  • Package manager: pip
  • Main dependencies: Flask 1.1.1, Flask-RESTPus
  • Tests: unittests

Setup dependencies

cd hummingbird-v2
virtualenv venv
source venv/bin/activate
pip install -r src/requirements.txt
pip install -r requirements_local.txt

Variables setup

export PYTHONPATH=$PYTHONPATH:$(pwd)/src
export FLASK_ENV=development

Running local machine

export PYTHONPATH=$PYTHONPATH:$(pwd)/src
export FLASK_ENV=development
python src/main.py

Running with docker-compose

docker-compose up --build

Swagger API Doc

http://127.0.0.1:5000/data_api/v1/

To Setup database locally

  • Local
export FLASK_APP=src/main.py
export FLASK_ENV=development
flask db init --directory=local_migrations
flask db migrate --directory=local_migrations
flask db upgrade --directory=local_migrations

To run tests locally

export PYTHONPATH=$PYTHONPATH:$(pwd)/src
export FLASK_ENV=testing
python tests/runner.py

To run Flake 8 For Style Guide Enforcement

flake8 src