Feature rich robust FastAPI template.

s3rius Last update: Feb 28, 2024

Flexible general-purpose template for FastAPI.

Usage

⚠️ Git, Python and Poetry must be installed and accessible ⚠️

Poetry version must be greater or equal than 1.1.8. Otherwise it won't be able to install SQLAlchemy.

Templator in action

You can install it directly from pypi with pip.

python3 -m pip install fastapi_template
python3 -m fastapi_template
# or fastapi_template
# Answer all the questions
# 🍪 Enjoy your new project 🍪
cd new_project
docker-compose -f deploy/docker-compose.yml --project-directory . build
docker-compose -f deploy/docker-compose.yml --project-directory . up --build

If you want to install it from sources, try this:

python3 -m pip install poetry
python3 -m pip install .
python3 -m fastapi_template

Also, you can use it with docker.

docker run --rm -it -v "$(pwd):/projects" s3rius/fastapi_template

Features

One of the coolest features is that this project is extremely configurable. You can choose between different databases and even ORMs, or you can even generate a project without a database! Currently SQLAlchemy 2.0, TortoiseORM, Piccolo and Ormar are supported.

This project can run as TUI or CLI and has excellent code documentation.

Generator features:

Pydantic V2 (Where it's possible. Some libs doesn't have support);
You can choose between GraphQL and REST api;
Uvicorn and gunicorn;
Different databases support;
Different ORMs support;
Optional migrations for each ORM except raw drivers;
Optional redis support;
Optional rabbitmq support;
different CI\CD;
Optional Kubernetes config generation;
Optional Demo routers and models (This helps you to see how project is structured);
Pre-commit integration;
Generated tests with almost 90% coverage;
Tests for the generator itself;
Optional Prometheus integration;
Optional Sentry integration;
Optional Loguru logger;
Optional Opentelemetry integration.
Optional taskiq integration.

This project can handle arguments passed through command line.

$ python -m fastapi_template --help

Usage: fastapi_template [OPTIONS]

Options:
  -n, --name TEXT                 Name of your awesome project
  -V, --version                   Prints current version
  --force                         Owerrite directory if it exists
  --quite                         Do not ask for features during generation
  --api-type [rest|graphql]       Select API type for your application
  --db [none|sqlite|mysql|postgresql]
                                  Select a database for your app
  --orm [none|ormar|sqlalchemy|tortoise|psycopg|piccolo]
                                  Choose Object–Relational Mapper lib
  --ci [none|gitlab_ci|github]    Select a CI for your app
  --redis                         Add redis support
  --rabbit                        Add RabbitMQ support
  --taskiq                        Add Taskiq support
  --migrations                    Add Migrations
  --kube                          Add kubernetes configs
  --dummy                         Add dummy model
  --routers                       Add example routers
  --swagger                       Add self hosted swagger
  --prometheus                    Add prometheus compatible metrics
  --sentry                        Add sentry integration
  --loguru                        Add loguru logger
  --opentelemetry                 Add opentelemetry integration
  --traefik                       Adds traefik labels to docker container
  --kafka                         Add Kafka support
  --gunicorn                      Add gunicorn server
  --help                          Show this message and exit.

Feature rich robust FastAPI template.

Usage

Features

Providing accurate JSON and Python dicts about the many public information available about MNO

Programmer & Developer Cook-Book | Covers Programming Languages, Databases, Linux Commands and more.

Convert sqlite databases to JSON files

A python CLI script to create Entity Relationship Diagrams from JSON/YAML code.

The Python JSON Comparison package

Object serialization/deserialization tools for python.

trycast parses JSON-like values whose shape is defined by TypedDicts and other standard Python type hints.

The Python fake data producer for Apache Kafka® is a complete demo app allowing you to quickly produce JSON fake streaming datasets and push it to an Apache Kafka topic.

A flexible json diff framework for minimalist.