1111
1212Poetry version must be greater or equal than 1.1.8. Otherwise it won't be able to install SQLAlchemy.
1313
14+ <div align =" center " >
15+ <img src =" https://user-images.githubusercontent.com/18153319/137182689-ce714440-7576-46a0-8f96-862a8469a28c.gif " />
16+ <p >Templator in action</p >
17+ </div >
18+
19+ You can install it directly from pypi with pip.
1420``` bash
1521python3 -m pip install fastapi_template
1622python3 -m fastapi_template
@@ -22,7 +28,7 @@ docker-compose -f deploy/docker-compose.yml --project-directory . build
2228docker-compose -f deploy/docker-compose.yml --project-directory . up --build
2329```
2430
25- If you want to install in from sources then try this:
31+ If you want to install it from sources, try this:
2632``` shell
2733python3 -m pip install poetry
2834python3 -m pip install .
@@ -34,37 +40,33 @@ Also you can use it with docker.
3440docker run --rm -it -v " $( pwd) :/projects" s3rius/fastapi_template
3541```
3642
37- <div align =" center " >
38- <img src =" https://user-images.githubusercontent.com/18153319/137182689-ce714440-7576-46a0-8f96-862a8469a28c.gif " />
39- <p >Templator in action</p >
40- </div >
41-
42-
4343## Features
4444
45- One of the coolest features is that this project is extremely handy.
46- You can choose between different databases and even ORMs.
45+ One of the coolest features is that this project is extremely configurable.
46+ You can choose between different databases and even ORMs, or
47+ you can even generate a project without a database!
4748Currently SQLAlchemy1.4, TortoiseORM, Piccolo and Ormar are supported.
4849
49-
50- This project can be run as TUI or CLI and has excellent code documentation.
50+ This project can run as TUI or CLI and has excellent code documentation.
5151
5252Generator features:
5353- You can choose between GraphQL and REST api;
5454- Different databases support;
5555- Different ORMs support;
5656- Optional migrations for each ORM except raw drivers;
57- - redis support;
58- - rabbitmq support;
57+ - Optional redis support;
58+ - Optional rabbitmq support;
5959- different CI\CD;
60- - Kubernetes config generation;
61- - Demo routers and models (This helps you to see how project is structured);
60+ - Optional Kubernetes config generation;
61+ - Optional Demo routers and models (This helps you to see how project is structured);
6262- Pre-commit integration;
6363- Generated tests with almost 90% coverage;
6464- Tests for the generator itself;
65- - Prometheus integration;
66- - Sentry integration;
67- - Opentelemetry integration.
65+ - Optional Prometheus integration;
66+ - Optional Sentry integration;
67+ - Optional Loguru logger;
68+ - Optional Opentelemetry integration.
69+
6870
6971This project can handle arguments passed through command line.
7072
@@ -78,7 +80,7 @@ usage: FastAPI template [-h] [--version] [--name PROJECT_NAME]
7880 [--orm {ormar,sqlalchemy,tortoise,psycopg,piccolo}]
7981 [--ci {none,gitlab_ci,github}] [--redis] [--rabbit]
8082 [--migrations] [--kube] [--dummy] [--routers]
81- [--swagger] [--prometheus] [--sentry]
83+ [--swagger] [--prometheus] [--sentry] [--loguru]
8284 [--opentelemetry] [--force] [--quite]
8385
8486optional arguments:
@@ -105,6 +107,7 @@ optional arguments:
105107 --swagger Enable self-hosted Swagger
106108 --prometheus Add prometheus integration
107109 --sentry Add sentry integration
110+ --loguru Add loguru logger
108111 --opentelemetry Add opentelemetry integration
109112 --force Owerrite directory if it exists
110113 --quite Do not ask for features during generation
0 commit comments