Feature-rich robust FastAPI template
Project description
Fast and flexible general-purpose template for your API.
With text user interface.
Usage
⚠️ Git, Python and Poetry must be installed and accessible ⚠️
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 SQLAlchemy14 and uses sqlalchemy orm and sessions, instead of raw drivers.
It has minimum to start new excellent project.
Generator features:
- Different databases to choose from.
- Alembic integration;
- redis support;
- CI\CD (Currently only gitlab-ci);
- Kubernetes config.
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] [--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 {none,sqlite,mysql,postgresql}
Database
--ci Add CI/CD support
--redis Add redis support
--alembic Add alembic support
--kube Add kubernetes configs
--force Owerrite directory if 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.0.0.tar.gz
(19.3 kB
view hashes)
Built Distribution
Close
Hashes for fastapi_template-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ca5fa8db437b768fc559aeb50873f8d3029caef7f276ce6aa2f1d71b53f3d8c |
|
MD5 | 407c69e00d9679cc66443656812335df |
|
BLAKE2b-256 | 7970081991ad4c768c17b719632a50506874b80606f76d8ee89826c2ab014a2d |