diff --git a/README.md b/README.md index 3de5768f066255c91bd89fd406b238901738381d..3bca5cd278cfb8a589db6400de0911eb687b1a8f 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,7 @@ <div align="center"> <img src="https://raw.githubusercontent.com/s3rius/FastAPI-template/master/images/logo.png" width=700> -<div><i>Fast and flexible general-purpose template for your API.</i></div> -</div> - -<div align="center"> -<img src="https://raw.githubusercontent.com/s3rius/FastAPI-template/master/images/ui-example.png" width=700> -<div><i>With text user interface.</i></div> +<div><i>Flexible and Lightweight general-purpose template for FastAPI.</i></div> </div> ## Usage @@ -35,28 +30,28 @@ python3 -m fastapi_template ## Features -Template is made with SQLAlchemy14 and uses sqlalchemy orm and sessions, +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. +- Kubernetes config generation. This project can handle arguments passed through command line. ```shell $ python -m fastapi_template --help -usage: FastAPI template [-h] [--name PROJECT_NAME] - [--description PROJECT_DESCRIPTION] +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] + [--ci {CIType.none,CIType.gitlab_ci,CIType.github}] [--redis] [--alembic] [--kube] [--force] optional arguments: -h, --help show this help message and exit diff --git a/images/ui-example.png b/images/ui-example.png deleted file mode 100644 index 7d2a6c08766a6f418073b6d0a5a2eb8d38d264e0..0000000000000000000000000000000000000000 Binary files a/images/ui-example.png and /dev/null differ diff --git a/pyproject.toml b/pyproject.toml index 048a53ab67312f65d1ccd98bdfc398de6148efda..c8e94d33edf8ff8e7997fb0c6390d12255336bfd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "fastapi_template" -version = "2.1.5" +version = "2.1.6" description = "Feature-rich robust FastAPI template" authors = ["Pavel Kirilin <win10@list.ru>"] packages = [