cookiecutter-fastapi 0.1.1

Cookiecutter for fastapi projects

Cookiecutter Fastapi

A Cookiecutter template for fastapi projects, inspired by cookiecutter-django.

✨📚✨ Read the full documentation

Features

• fastapi-users for users authentication and management
• Pydantic for settings management
• Include a cli tool built with typer to simplify project management
• Pre-commit integration included by default
• Tortoise-orm and aerich database setup by default but switchable
• Limit-offset pagination helpers included
• Run tests with unittest or pytest
• Sending emails using aiosmtplib or Amazon SES
• Optional integration with sentry for error logging
• Docker and docker-compose for production using Traefik
• Optional setup of HTML templates rendering using jinja2
• Optional static files serving using whitenoise
• Procfile for deploying to heroku
• Optional integration with fastapi-storages for media files storage
• Implement the Health Check API patterns on your fastapi application
• Renders fastapi projects with 100% starting test coverage

Task queues manager options

• Arq
• Procrastinate
• Celery

ORM/ODM options

• Tortoise ORM
• RedisOM
• Beanie
• SQLModel

Usage

Install the cookiecutter package:

pip install cookiecutter

Now run it against this repo:

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, Cookiecutter Fastapi is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.