# Cookiecutter Fastapi
[][pypi_]
[][status]
[][read the docs]
[](https://github.com/Tobi-De/cookiecutter-fastapi)
[](https://github.com/Tobi-De/cookiecutter-fastapi/blob/main/LICENSE)
[](https://github.com/psf/black)
[read the docs]: https://cookiecutter-fastapi.readthedocs.io/
[pypi_]: https://pypi.org/project/fastapi-paginator/
[status]: https://pypi.org/project/fastapi-paginator/
A [Cookiecutter](https://github.com/audreyr/cookiecutter) template for [fastapi](https://fastapi.tiangolo.com) projects, inspired by [cookiecutter-django](https://github.com/cookiecutter/cookiecutter-django).
✨📚✨ [Read the full documentation][read the docs]
## Features
- [fastapi-users](https://github.com/fastapi-users/fastapi-users) for users authentication and management
- [Pydantic](https://pydantic-docs.helpmanual.io/) for settings management
- Include a cli tool built with [typer](https://github.com/tiangolo/typer) to simplify project management
- [Pre-commit](https://pre-commit.com/) integration included by default
- [Tortoise-orm](https://tortoise.github.io/) and [aerich](https://github.com/tortoise/aerich) database setup by default but switchable
- Limit-offset pagination helpers included
- Sending emails using [aiosmtplib](https://aiosmtplib.readthedocs.io/en/stable/client.html) or [Amazon SES](https://aws.amazon.com/fr/ses/)
- Optional integration with [sentry](https://docs.sentry.io/platforms/python/) for error logging
- Production [Dockerfile](https://www.docker.com/) included
- Integration with [arq](https://github.com/samuelcolvin/arq) for background tasks
- Optional setup of HTML templates rendering using [jinja2](https://jinja.palletsprojects.com/en/3.1.x/)
- [Procfile](https://devcenter.heroku.com/articles/procfile) for deploying to heroku
- Implement the [Health Check API patterns](https://microservices.io/patterns/observability/health-check-api.html) on your fastapi application
### ORM/ODM options
- [Tortoise ORM](https://tortoise.github.io/)
- [Beanie](https://github.com/roman-right/beanie)
## Usage
Install the cookiecutter package:
```shell
pip install cookiecutter black isort
```
**Note**: `Black` and `isort` are used to format your project right after it has been generated.
Now run it against this repo:
```shell
cookiecutter https://github.com/Tobi-De/cookiecutter-fastapi
```
You'll be prompted for some values. Provide them, then a fastapi project will be created for you.
## Contributing
Contributions are very welcome. To learn more, see the [Contributor Guide].
## License
Distributed under the terms of the [MIT license][license],
_Cookiecutter Fastapi_ is free and open source software.
## Issues
If you encounter any problems,
please [file an issue] along with a detailed description.
[file an issue]: https://github.com/tobi-de/cookiecutter-fastapi/issues
<!-- github-only -->
[license]: https://github.com/tobi-de/cookiecutter-fastapi/blob/main/LICENSE
[contributor guide]: https://github.com/tobi-de/cookiecutter-fastapi/blob/main/CONTRIBUTING.md
Raw data
{
"_id": null,
"home_page": "https://cookiecutter-fastapi.readthedocs.io/en/latest/",
"name": "cookiecutter-fastapi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "fastapi,python,cookiecutter,project template,tortoise-orm,beanie,SQLModel",
"author": "Tobi-De",
"author_email": "tobidegnon@proton.me",
"download_url": "https://files.pythonhosted.org/packages/7a/e8/dd56eba65a4d80ec3f4333053ecc77ef5b00c2caf69049fd0466afc1e1f4/cookiecutter_fastapi-0.1.3.tar.gz",
"platform": null,
"description": "# Cookiecutter Fastapi\n\n[][pypi_]\n[][status]\n[][read the docs]\n[](https://github.com/Tobi-De/cookiecutter-fastapi)\n[](https://github.com/Tobi-De/cookiecutter-fastapi/blob/main/LICENSE)\n[](https://github.com/psf/black)\n\n[read the docs]: https://cookiecutter-fastapi.readthedocs.io/\n[pypi_]: https://pypi.org/project/fastapi-paginator/\n[status]: https://pypi.org/project/fastapi-paginator/\n\nA [Cookiecutter](https://github.com/audreyr/cookiecutter) template for [fastapi](https://fastapi.tiangolo.com) projects, inspired by [cookiecutter-django](https://github.com/cookiecutter/cookiecutter-django).\n\n\u2728\ud83d\udcda\u2728 [Read the full documentation][read the docs]\n\n## Features\n\n- [fastapi-users](https://github.com/fastapi-users/fastapi-users) for users authentication and management\n- [Pydantic](https://pydantic-docs.helpmanual.io/) for settings management\n- Include a cli tool built with [typer](https://github.com/tiangolo/typer) to simplify project management\n- [Pre-commit](https://pre-commit.com/) integration included by default\n- [Tortoise-orm](https://tortoise.github.io/) and [aerich](https://github.com/tortoise/aerich) database setup by default but switchable\n- Limit-offset pagination helpers included\n- Sending emails using [aiosmtplib](https://aiosmtplib.readthedocs.io/en/stable/client.html) or [Amazon SES](https://aws.amazon.com/fr/ses/)\n- Optional integration with [sentry](https://docs.sentry.io/platforms/python/) for error logging\n- Production [Dockerfile](https://www.docker.com/) included\n- Integration with [arq](https://github.com/samuelcolvin/arq) for background tasks\n- Optional setup of HTML templates rendering using [jinja2](https://jinja.palletsprojects.com/en/3.1.x/)\n- [Procfile](https://devcenter.heroku.com/articles/procfile) for deploying to heroku\n- Implement the [Health Check API patterns](https://microservices.io/patterns/observability/health-check-api.html) on your fastapi application\n\n### ORM/ODM options\n\n- [Tortoise ORM](https://tortoise.github.io/)\n- [Beanie](https://github.com/roman-right/beanie)\n\n## Usage\n\nInstall the cookiecutter package:\n\n```shell\npip install cookiecutter black isort\n```\n\n**Note**: `Black` and `isort` are used to format your project right after it has been generated.\n\nNow run it against this repo:\n\n```shell\ncookiecutter https://github.com/Tobi-De/cookiecutter-fastapi\n```\n\nYou'll be prompted for some values. Provide them, then a fastapi project will be created for you.\n\n## Contributing\n\nContributions are very welcome. To learn more, see the [Contributor Guide].\n\n## License\n\nDistributed under the terms of the [MIT license][license],\n_Cookiecutter Fastapi_ is free and open source software.\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue] along with a detailed description.\n\n[file an issue]: https://github.com/tobi-de/cookiecutter-fastapi/issues\n\n<!-- github-only -->\n\n[license]: https://github.com/tobi-de/cookiecutter-fastapi/blob/main/LICENSE\n[contributor guide]: https://github.com/tobi-de/cookiecutter-fastapi/blob/main/CONTRIBUTING.md\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cookiecutter for fastapi projects",
"version": "0.1.3",
"split_keywords": [
"fastapi",
"python",
"cookiecutter",
"project template",
"tortoise-orm",
"beanie",
"sqlmodel"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "900ab1f4bc5daff1d1bab14fe3eff202",
"sha256": "0017517bcbd06683038c9c5fdc7c38c28f736531f33f0881e391937f3db80019"
},
"downloads": -1,
"filename": "cookiecutter_fastapi-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "900ab1f4bc5daff1d1bab14fe3eff202",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 4819,
"upload_time": "2022-12-12T15:18:05",
"upload_time_iso_8601": "2022-12-12T15:18:05.970759Z",
"url": "https://files.pythonhosted.org/packages/3c/41/9d1034604030d8f98bd7e8e58ed6c2fee298bd8c7ea5d62218931bd697ff/cookiecutter_fastapi-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "222cf9738e2505eb70aff5a834f22140",
"sha256": "a3992c7bf3144bd44663ae935d0c382031baa3817c125f754886b73bb92fd620"
},
"downloads": -1,
"filename": "cookiecutter_fastapi-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "222cf9738e2505eb70aff5a834f22140",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 4884,
"upload_time": "2022-12-12T15:18:07",
"upload_time_iso_8601": "2022-12-12T15:18:07.537146Z",
"url": "https://files.pythonhosted.org/packages/7a/e8/dd56eba65a4d80ec3f4333053ecc77ef5b00c2caf69049fd0466afc1e1f4/cookiecutter_fastapi-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-12 15:18:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "cookiecutter-fastapi"
}
JSON