Skip to main content

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.

As of v0.15.0 all dependencies are pinned. The only exceptions are black, ruff, and httpx.

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)

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] 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 ruff
psycopg2-binary pytest-emoji toml
pydantic pytest-md types-toml
python-dotenv pytest-mock
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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa-fastapi-template-0.15.3.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aa_fastapi_template-0.15.3-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file aa-fastapi-template-0.15.3.tar.gz.

File metadata

  • Download URL: aa-fastapi-template-0.15.3.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for aa-fastapi-template-0.15.3.tar.gz
Algorithm Hash digest
SHA256 0b549076a144d58b2f9b6bad6eb93a20e842fe8789e9306a1995d18d57192b87
MD5 fb364810bbf4695978661137e33de600
BLAKE2b-256 025e2873d355704e0e1de597a1840a81c34b1041f9458e6cee7142efa0f559ec

See more details on using hashes here.

File details

Details for the file aa_fastapi_template-0.15.3-py3-none-any.whl.

File metadata

File hashes

Hashes for aa_fastapi_template-0.15.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c9276257cfe16e6a15f4cb257c961abd305d6d83c66b379206e0877575710f60
MD5 551dec0933d476cdf9db29118449b5a0
BLAKE2b-256 ee77200c78be548c99644b95bd5808b08aa11994ba9cf7db3529e0603fa98c2b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page