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.1.tar.gz (4.5 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.1-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aa-fastapi-template-0.15.1.tar.gz
  • Upload date:
  • Size: 4.5 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.1.tar.gz
Algorithm Hash digest
SHA256 182508346964ff58836fbcdb8929c23482efcaf099e6995c1a3a838b5c5288e9
MD5 1a68872dc9127966968051f9a8c32e07
BLAKE2b-256 c337e80ab755cfa14368b588ef3224e323bc44930f95eddbe697e92cde115f99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aa_fastapi_template-0.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6c45678d8a2cb944ab14c820c40bcba08aa9ee6a9f801a9e51db6a6977f13531
MD5 d2c925c2ec0049da837c9d0c0b06b90f
BLAKE2b-256 a5315bf4794b69f95dd6316f455d2736fa538b4bf407db6168226e84e078a6bd

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