30 lines (20 loc) · 1.15 KB

Python API Project Template

This project bootstraps a template to create toy Python API.

Requirements

Docker
Python > 3.10
Poetry as dependency management tool. If you need to change some library version from pyproject.toml, run poetry lock.

Then run poetry env info -p to make sure the environment setup was done properly.

Development

For every change in the pyproject.toml run poetry.lock
Run poetry install to install the dependencies to a new environment
Run source $(poetry env info --path)/bin/activate to activate the poetry environment (Tested on MacOS)

Makefile Commands

make format_code: rewrites source code using black and isort to keep it in the standard format
make lint: checks the source code for syntax violations
make test: Run unit tests
make run: FastAPI will be up at http://localhost:8000/

Documentation

The project OpenAPI is available at http://localhost:8000/docs
Further documentation can be placed in the docs folder.