A robust and sensible baseline for kick-starting any new FastAPI application.
Project description
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.
Prerequisites
- Python 3.10 or higher
- pip (Python package installer)
Installation
# 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] only adds testing libraries, the [dev] option installs both 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 | ruff |
| psycopg2-binary | pytest-emoji | toml |
| pydantic | pytest-md | types-toml |
| python-dotenv | pytest-mock | |
| sqlalchemy | pytest-xdist | |
| sqlmodel | ||
| 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aa-fastapi-template-0.14.tar.gz.
File metadata
- Download URL: aa-fastapi-template-0.14.tar.gz
- Upload date:
- Size: 4.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f08ec9723cbb66caeaef9bd02b11be1bc2a70535c13bb771ad2b0e3a1692e5c2
|
|
| MD5 |
a3d9b39f6f25dd69bb571cb40ce0e855
|
|
| BLAKE2b-256 |
4d2fb31df5d6120aa00064db63f8b7b4dc8006fd11a134720d0cc3f501feccd6
|
File details
Details for the file aa_fastapi_template-0.14-py3-none-any.whl.
File metadata
- Download URL: aa_fastapi_template-0.14-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e764a5b91844c6d2bb7aea33f6a05e2f89d2ed4fcd953811b22cbad9a725e34
|
|
| MD5 |
71945989b62af61307e10ce46df21909
|
|
| BLAKE2b-256 |
5e6197227bd3191483cabcee2c0f21760655aa25259f0e25e7afebb97a0edf58
|