Flexible and Lightweight 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.
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 . up --build
If you want to install in from sources then try this:
python3 -m pip install poetry
python3 -m pip install .
python3 -m fastapi_template
Features
Template is made with SQLAlchemy1.4 and uses sqlalchemy orm and sessions, instead of raw drivers.
It has minimum to start new excellent project.
Pre-commit integrations and excellent code documentation.
Generator features:
- Different databases to choose from.
- Alembic integration;
- redis support;
- different CI\CD templates;
- Kubernetes config generation.
This project can handle arguments passed through command line.
$ python -m fastapi_template --help
usage: FastAPI template [-h] [--name PROJECT_NAME]
[--description PROJECT_DESCRIPTION]
[--db {none,sqlite,mysql,postgresql}]
[--ci {none,gitlab,github}] [--redis] [--alembic]
[--kube] [--dummy] [--routers] [--swagger] [--force]
optional arguments:
-h, --help show this help message and exit
--name PROJECT_NAME Name of your awesome project
--description PROJECT_DESCRIPTION
Project description
--db {none,sqlite,mysql,postgresql}
Database
--ci {none,gitlab,github}
Choose CI support
--redis Add redis support
--alembic Add alembic support
--kube Add kubernetes configs
--dummy, --dummy-model
Add dummy model
--routers Add exmaple routers
--swagger Eanble self-hosted swagger
--force Owerrite directory if it exists
1 maintainer
Release files for fastapi_template 2.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fastapi_template-2.4.1.tar.gz | 728.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fastapi_template-2.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.5 MB
Release files / fastapi_template-2.4.1.tar.gz
| Download URL | fastapi_template-2.4.1.tar.gz |
|---|---|
| Size | 728.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
34d56203bb1369fbf205cca1e538f5238f78a07dfe787c2d7ac649ae72d09d40
|
|
BLAKE2b-256 checksum How to use checksums |
de5e732c3e0a530abb9749a77a4a139f1623a642d147c0f70e61211e1666f5b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.8 CPython/3.8.11 Linux/5.8.0-1040-azure
|
Release files / fastapi_template-2.4.1-py3-none-any.whl
| Download URL | fastapi_template-2.4.1-py3-none-any.whl |
|---|---|
| Size | 753.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a12c6bc4182064e307b4944b9c0cf33ef262eb22ef6a231f799332d32550ef9c
|
|
BLAKE2b-256 checksum How to use checksums |
48f96dafaafcb819049d4732708169b05bb38cf0279a5db80619afe43c28234c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.8 CPython/3.8.11 Linux/5.8.0-1040-azure
|
