| Name | aa-fastapi-template JSON |
| Version |
0.25.0
JSON |
| download |
| home_page | None |
| Summary | A robust and sensible baseline for kick-starting any new FastAPI application. |
| upload_time | 2024-04-20 03:07:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| 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. |
| keywords |
fastapi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "aa-fastapi-template",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Aaron Imbrock <aaron@sizza.net>",
"keywords": "fastapi",
"author": null,
"author_email": "Aaron Imbrock <aaron@sizza.net>",
"download_url": "https://files.pythonhosted.org/packages/13/dc/3bbcbe37ac9dd3bad110fba7132cd98488766cb1389e71f55a440ca1a041/aa_fastapi_template-0.25.0.tar.gz",
"platform": null,
"description": "# AA FastAPI Template\n\nA 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.\n\nAs 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.\n\nThis 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.\n\n## Prerequisites\n\n- Python 3.10 or higher\n- pip (Python package installer)\n\n## Usage\n\n # Using pip:\n pip install aa-fastapi-template\n\n # tests\n pip install aa-fastapi-template[tests]\n\n # dev\n pip install aa-fastapi-template[dev]\n\nThe base package provides the essential tools for creating FastAPI applications.\n\nWhile `[tests]` adds testing libraries, the `[dev]` option installs both the testing and development tools.\n\n## Package Options\n\nIncluded within each package are:\n\n| aa-fastapi-template | aa-fastapi-template[tests] | aa-fastapi-template[dev] |\n|------------------------|-----------------------------|---------------------------|\n| asyncpg | + aa-fastapi-template | + aa-fastapi-template[tests] |\n| environs | hypothesis | black |\n| fastapi | pytest | httpx |\n| mypy | pytest-cov | isort |\n| psycopg2-binary | pytest-emoji | ruff |\n| pydantic | pytest-md | types |\n| python-dotenv | pytest-mock | types-toml |\n| sqlalchemy | pytest-xdist | |\n| sqlmodel | tox | |\n| uvicorn | | |\n\n## Contributing\n\nWe 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.\n\n- Issues: Use the [GitHub Issues page](https://github.com/aaron-imbrock/aa-fastapi-template/issues)\n- Pull Requests: Submit pull requests with your changes/fixes.\n",
"bugtrack_url": null,
"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. ",
"summary": "A robust and sensible baseline for kick-starting any new FastAPI application.",
"version": "0.25.0",
"project_urls": {
"Documentation": "https://github.com/aaron-imbrock/aa-fastapi-template",
"Homepage": "https://pypi.org/project/aa-fastapi-template/",
"Issues": "https://github.com/aaron-imbrock/aa-fastapi-template/issues",
"Repository": "https://github.com/aaron-imbrock/aa-fastapi-template"
},
"split_keywords": [
"fastapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec3b1cb700ca0dcab7c3803c906ba2627e45b01b50d239fd38eaafdb037629b4",
"md5": "d437c9d73531cc473fb5dc7861e20b9f",
"sha256": "f6f4e9f6921a4b5ed8db5a64a3c90bb117af0f5187759c6532bcd0779eec080b"
},
"downloads": -1,
"filename": "aa_fastapi_template-0.25.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d437c9d73531cc473fb5dc7861e20b9f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4265,
"upload_time": "2024-04-20T03:07:16",
"upload_time_iso_8601": "2024-04-20T03:07:16.559556Z",
"url": "https://files.pythonhosted.org/packages/ec/3b/1cb700ca0dcab7c3803c906ba2627e45b01b50d239fd38eaafdb037629b4/aa_fastapi_template-0.25.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13dc3bbcbe37ac9dd3bad110fba7132cd98488766cb1389e71f55a440ca1a041",
"md5": "9104741f0d31b42aedf292bf4cad793d",
"sha256": "bd52106c264d640a516528f5d20e48e3a250b3666331b3fe3c8b93afed8c9c55"
},
"downloads": -1,
"filename": "aa_fastapi_template-0.25.0.tar.gz",
"has_sig": false,
"md5_digest": "9104741f0d31b42aedf292bf4cad793d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4984,
"upload_time": "2024-04-20T03:07:18",
"upload_time_iso_8601": "2024-04-20T03:07:18.819467Z",
"url": "https://files.pythonhosted.org/packages/13/dc/3bbcbe37ac9dd3bad110fba7132cd98488766cb1389e71f55a440ca1a041/aa_fastapi_template-0.25.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-20 03:07:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aaron-imbrock",
"github_project": "aa-fastapi-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "aa-fastapi-template"
}
