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.4.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.4-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aa-fastapi-template-0.15.4.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.4.tar.gz
Algorithm Hash digest
SHA256 12415f44843e1d422a3e85bce428692d99b8866a8ca88910ccde828e7893bd77
MD5 12960b4cd30e9caea8807cc18f415fb9
BLAKE2b-256 68b57578fc58b593c221d90e3a6ad7c673c075258d9867cee1158a9af46ee64a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aa_fastapi_template-0.15.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3b33e7e801fe97f9c4cd37c963a84092db20b52b6214dbce24088597c21c3a21
MD5 62232a88de43ac2ef63c71ffdd999fde
BLAKE2b-256 546e80d75a60855544f416ca8aa6821696d76e60ff86ee5fe04659f3e0ca2800

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