This template generator creates a FastAPI application for a REST API.
- Python 3.9+ (configurable)
- Poetry based dependency management
- FastAPI
- Correct ASGI Lifespan events management for FastAPI
- Session management, login/logout
- Cache using Redis (aioredis)
- Postgres asynchronous database access based on Encode Databases
- Docker image for deployment based on multi-stage builds
- Development tasks registered in a
Makefilefor easy access and management - Mercurial/Git hooks for
pre-commitandpre-pushevents - Linting based on flake8 (and plugins), blue, mypy and isort
- Asynchronous tests based on pytest, httpx and alt-pytest-asyncio
You must have cookiecutter installed:
$ pip install --user cookiecutter
You can use this template directly from its repository:
$ cookiecutter https://github.com/andredias/cookiecutter-fastapi.git
You will be prompted to enter a bunch of project config values. Then, Cookiecutter will generate a project from the template, using the values that you entered.
That's it!
There are a few templates and generators for FastAPI projects. All of them have their own opinionated group of implementation choices. Since I couldn't find any who met my needs or design preferences, I decided to create one of my own.