Feature-rich robust FastAPI template
Project description
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 {DatabaseType.none,DatabaseType.sqlite,DatabaseType.mysql,DatabaseType.postgresql}]
[--ci {CIType.none,CIType.gitlab_ci,CIType.github}] [--redis] [--alembic] [--kube] [--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 {DatabaseType.none,DatabaseType.sqlite,DatabaseType.mysql,DatabaseType.postgresql}
Database
--ci {CIType.none,CIType.gitlab_ci,CIType.github}
Choose CI support
--redis Add redis support
--alembic Add alembic support
--kube Add kubernetes configs
--force Owerrite directory if it exists
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fastapi_template-2.1.6.tar.gz
(20.6 kB
view hashes)
Built Distribution
Close
Hashes for fastapi_template-2.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8818a1ebb5cda288152c10101da06510722b7dc1e1a7d30f72e777024e63e531 |
|
MD5 | f78a247e8f4b7cc736b69b9121847471 |
|
BLAKE2b-256 | 6cae739f7e7a93a549619eb757ebf86e92664cb29cdfac0bb4abd1e7c3c0af2c |