Sharify API

This is a template project to build api using the FastAPI framework.

Start the application

Debug

You'll need to setup the virtual environment using:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt -r requirements-dev.txt

The run script will start the app with the DEBUG flag turned on.

make run

Dockerfile

The project can be started in production mode using docker-compose

docker-compose up --build

Documentation

FastAPI projects are self documenting, visit/docs.

Code Quality

Tests

pytest is used for testing.

make test

Lint

flake8 is used for linting.

make lint

Coverage

The coverage script will create an html file in ./htmlcov and output a minimal report.

make coverage

License

FastAPI-template is MIT licensed.