Usage
⚠️ Git, Python and UV must be installed and accessible ⚠️
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 up --build
If you want to install it from sources, try this:
python3 -m pip install uv
python3 -m pip install .
python3 -m fastapi_template
Also, you can use it with docker.
docker run --rm -it -v "$(pwd):/projects" ghcr.io/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, Ormar and Beanie 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 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
--quiet Do not ask for features during generation
--api-type [rest|graphql] Select API type for your application
--db [none|sqlite|mysql|postgresql|mongodb]
Select a database for your app
--orm [none|ormar|sqlalchemy|tortoise|psycopg|piccolo|beanie]
Choose Object–Relational Mapper lib
--ci [none|gitlab_ci|github] Select a CI for your app
--redis Add redis support
--add_users Add fastapi-users support
--rabbit Add RabbitMQ support
--taskiq Add Taskiq support
--migrations Add Migrations
--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
--cookie-auth Add authentication via cookie support
--jwt-auth Add JWT auth support
--help Show this message and exit.
1 maintainer
Metadata
1 maintainer
Release files for fastapi_template 6.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| fastapi_template-6.1.2.tar.gz | 802.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fastapi_template-6.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.7 MB
Release files / fastapi_template-6.1.2.tar.gz
| Download URL | fastapi_template-6.1.2.tar.gz |
|---|---|
| Size | 802.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3a8532700baf643850838a307f63c447364c9eeb692890c1af6057873fa1b13c
|
|
BLAKE2b-256 checksum How to use checksums |
3c9454fe6bad909f4cb3e0ba16ed3b2a2b38d2f2d8b7df074b1221a62e7a637a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / fastapi_template-6.1.2-py3-none-any.whl
| Download URL | fastapi_template-6.1.2-py3-none-any.whl |
|---|---|
| Size | 873.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e1c135c5a8550c765c485f328940e56dd6af71a6909517e2663f7ca04997ca4d
|
|
BLAKE2b-256 checksum How to use checksums |
be07b2d2cf96832b8362e416f23a1a6834a240120b7b59e0cc9e2df83b5b596c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for fastapi_template 6.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
