Metadata-Version: 2.1
Name: aa-fastapi-template
Version: 0.16.5
Summary: A robust and sensible baseline for kick-starting any new FastAPI application.
Author-email: Aaron Imbrock <aaron@sizza.net>
Maintainer-email: Aaron Imbrock <aaron@sizza.net>
License: Copyright Aaron Imbrock 2024
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: Documentation, https://github.com/aaron-imbrock/aa-fastapi-template
Project-URL: Homepage, https://pypi.org/project/aa-fastapi-template/
Project-URL: Issues, https://github.com/aaron-imbrock/aa-fastapi-template/issues
Project-URL: Repository, https://github.com/aaron-imbrock/aa-fastapi-template
Keywords: fastapi
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Framework :: FastAPI
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: asyncpg ==0.29.0
Requires-Dist: environs ==10.3.0
Requires-Dist: fastapi ==0.110.0
Requires-Dist: mypy ==1.8.0
Requires-Dist: psycopg2-binary ==2.9.9
Requires-Dist: pydantic ==2.6.2
Requires-Dist: python-dotenv ==1.0.1
Requires-Dist: sqlalchemy ==2.0.27
Requires-Dist: sqlmodel ==0.0.16
Requires-Dist: uvicorn ==0.27.1
Provides-Extra: build
Requires-Dist: setuptools ; extra == 'build'
Requires-Dist: build ; extra == 'build'
Requires-Dist: twine ; extra == 'build'
Provides-Extra: dev
Requires-Dist: aa-fastapi-template[tests] ; extra == 'dev'
Requires-Dist: black ==24.2.0 ; extra == 'dev'
Requires-Dist: httpx ==0.27.0 ; extra == 'dev'
Requires-Dist: isort ==5.13.2 ; extra == 'dev'
Requires-Dist: ruff ==0.2.2 ; extra == 'dev'
Requires-Dist: toml ==0.10.2 ; extra == 'dev'
Requires-Dist: types-toml ==0.10.8.7 ; extra == 'dev'
Provides-Extra: tests
Requires-Dist: pytest ==8.0.2 ; extra == 'tests'
Requires-Dist: pytest-mock ==3.12.0 ; extra == 'tests'
Requires-Dist: hypothesis ==6.98.11 ; extra == 'tests'
Requires-Dist: pytest-cov ==4.1.0 ; extra == 'tests'
Requires-Dist: pytest-xdist ==3.5.0 ; extra == 'tests'
Requires-Dist: pytest-md ==0.2.0 ; extra == 'tests'
Requires-Dist: pytest-emoji ==0.2.0 ; extra == 'tests'
Requires-Dist: tox ==4.13.0 ; extra == 'tests'

# 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](https://github.com/aaron-imbrock/aa-fastapi-template/issues)
- Pull Requests: Submit pull requests with your changes/fixes.
