Flux API

Prerequisites

Required

• Python 3.6.x or higher
• PostgreSQL 10.x or higher

Optional

• Redis 4.0.x or higher (for rate limiting, otherwise in-memory storage is used)

Getting started

Create local Postgres database

sudo service postgresql start
sudo su - postgres -c "create user mash with password mash"
sudo su - postgres -c "createdb flux"
sudo -u postgres psql
grant all privileges on database flux to mash;

Create venv and install requirements

python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt ; pip3 install -r requirements_dev.txt

Run database migrations

flask db upgrade

Run app

flask run

Testing

Run the test suite

python -m pytest --cov=app --cov-report=term-missing --cov-branch