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.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.

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.16.5.tar.gz (5.0 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.16.5-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aa-fastapi-template-0.16.5.tar.gz
Algorithm Hash digest
SHA256 a410632f90965281203f499227e23d41ab8a2d1b27d21518baf92c9a30372d34
MD5 c3f2548ba9e88b421c28d20d7720bcdf
BLAKE2b-256 f41589f15192fa1b4f0d08ad686e5c61ff777d2a45936ad862dcfaa9fd0c6277

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aa_fastapi_template-0.16.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f33ebf11bddbb661f9999893b05ab111dcbc69eac4a6bba01bb32034000e42bc
MD5 44bffeebe8e2f15407f5ddf73ef257ce
BLAKE2b-256 7af90c60b9cc8c33e8f4adc59531113299be4a39e3595d36f37b8cb8d5fff296

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