aa-fastapi-template

AA FastAPI Template

A robust and sensible baseline for kick-starting any new FastAPI application. This template provides a comprehensive setup for developing high-performance web applications with FastAPI, including optional, opinionated development and testing dependencies to enhance your development workflow.

As of v0.15.10 all dependencies are pinned. Testing and build quality are still a work in progress though. For now everything should work but please check the Contributing section below if you find issues.

This package isn't really intended to be used in the same environment as other projects. Since the dependencies here are pinned care should be taken to avoid version conflicts pulled in for other packages.

Prerequisites

• Python 3.10 or higher
• pip (Python package installer)

Usage

# Using pip:
pip install aa-fastapi-template

# tests
pip install aa-fastapi-template[tests]

# dev
pip install aa-fastapi-template[dev]

The base package provides the essential tools for creating FastAPI applications.

While [tests] adds testing libraries, the [dev] option installs both the testing and development tools.

Package Options

Included within each package are:

aa-fastapi-template	aa-fastapi-template[tests]	aa-fastapi-template[dev]
asyncpg	+ aa-fastapi-template	+ aa-fastapi-template[tests]
environs	hypothesis	black
fastapi	pytest	httpx
mypy	pytest-cov	isort
psycopg2-binary	pytest-emoji	ruff
pydantic	pytest-md	types
python-dotenv	pytest-mock	types-toml
sqlalchemy	pytest-xdist
sqlmodel	tox
uvicorn

Contributing

We welcome contributions to the AA FastAPI Template! If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

• Issues: Use the GitHub Issues page
• Pull Requests: Submit pull requests with your changes/fixes.