Cookiecutter Flask OpenAPI

Pipenv GUIDE

Requirements

Python 3.9.5 Installed
DB and DB Test Up and Running (See README_DOCKER)
Pipenv Installed

Set your Pipenv to create virtualenv inside the project

export PIPENV_VENV_IN_PROJECT=1

Create the virtual environment

pipenv check

Install Python Packages

pipenv sync --dev

Run the API

pipenv run flask db upgrade
pipenv run flask run

Then,

access 🚀 http://localhost:5000/api to access the API documentation
access 🚀 http://localhost:5000/api/status to check the API statuses
access 🚀 http://localhost:5000/api/news to list News

Tests

pipenv run pytest

Linter && Code Style

pylint flask_cookie/**/*.py
black -l 88 --check flask_cookie/

Extra

Check the Makefile and run make help where it has all commands above shortcuts and more...