cookiecutter-fastapi

KO | EN

gitlite — search

#python #react #typescript #golang #android #rust #deep-learning #macos #nodejs #java #kubernetes #pytorch #mcp #open-source

cookiecutter-fastapi

(★ 164)

Cookiecutter fastapi is a framework for jumpstarting production-ready fastapi projects quickly.

File Explorer

Download Latest Version (.zip)

- - pre-commit-auto-update.yml
  - test.yml
- dependabot.yml
- FUNDING.yml
- - profiles_settings.xml
  - Project_Default.xml
- .gitignore
- cookiecutter-fastapi.iml
- misc.xml
- modules.xml
- saveactions_settings.xml
- vcs.xml
- codeofconduct.md
- conf.py
- contributing.md
- deployment.md
- index.md
- license.md
- requirements.txt
- userguide.md
- post_gen_project.py
- __init__.py
- test_project_generation.py
- - __init__.py
  - __main__.py
  - health.py
  - initial_data.py
  - lifetime.py
  - main.py
  - worker.py
- .env.template
- .gitignore
- .pre-commit-config.yaml
- Dockerfile
- gunicorn.conf.py
- justfile
- manage.py
- Procfile
- pyproject.toml
- README.md
- runtime.txt
- setup.cfg
- {% if cookiecutter.license == 'Apache-2.0' -%} LICENSE {%- endif %}
- {% if cookiecutter.license == 'MIT' -%} LICENSE {%- endif %}
.gitignore
.readthedocs.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
cookiecutter.json
justfile
LICENSE
pyproject.toml
README.md
uv.lock

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Cookiecutter Fastapi

[![PyPI](https://img.shields.io/pypi/v/cookiecutter-fastapi.svg)][pypi_]
[![Status](https://img.shields.io/pypi/status/cookiecutter-fastapi.svg)][status]
[![Read the documentation at https://cookiecutter-fastapi.readthedocs.io/](https://img.shields.io/readthedocs/cookiecutter-fastapi/latest.svg?label=Read%20the%20Docs)][read the docs]
[![python](https://img.shields.io/pypi/pyversions/cookiecutter-fastapi)](https://github.com/Tobi-De/cookiecutter-fastapi)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Tobi-De/cookiecutter-fastapi/blob/main/LICENSE)
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](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 [saq](https://github.com/tobymao/saq) 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.

You could also use [cruft](https://github.com/cruft/cruft) to be able to keep your project up to date with the latest changes:

```shell
pip install cruft
cruft create https://github.com/Tobi-De/cookiecutter-fastapi
```
It work pretty much the same way as cookiecutter but you'll be able to update your project with the latest changes by running `cruft update`.

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

[license]: https://github.com/tobi-de/cookiecutter-fastapi/blob/main/LICENSE
[contributor guide]: https://github.com/tobi-de/cookiecutter-fastapi/blob/main/CONTRIBUTING.md

cookiecutter-fastapi

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

cookiecutter-fastapi

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README