Skip to content

Commit f1dac12

Browse files
committed
Add FastAPI features to README
1 parent f7cae95 commit f1dac12

File tree

4 files changed

+16
-3
lines changed

4 files changed

+16
-3
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Python template with CI/CD ready for production
2222

2323
## Features
2424

25+
### Main Features
26+
2527
- Management of dependencies with [Poetry](https://python-poetry.org)
2628
- Generation of documentation based on Markdown with [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material)
2729
- Automatic check of the pythonic style with [flake8](https://flake8.pycqa.org), [black](https://black.readthedocs.io) and [isort](https://pycqa.github.io/isort)
@@ -32,4 +34,9 @@ Python template with CI/CD ready for production
3234
- Automatic publish to [PyPI](https://pypi.org)
3335
- Automatic dependency update check with [dependabot](https://github.com/dependabot)
3436

37+
### FastAPI Features
38+
39+
- Configuration for deploy on [Heroku](https://www.heroku.com)
40+
- Configuration for deploy with [Docker](https://www.docker.com)
41+
3542
> All of the above via [GitHub Actions](https://github.com/features/actions) and [GitHub Pages](https://pages.github.com)

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Python template with CI/CD ready for production
2222

2323
## Features
2424

25+
### Main Features
26+
2527
- Management of dependencies with [Poetry](https://python-poetry.org)
2628
- Generation of documentation based on Markdown with [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material)
2729
- Automatic check of the pythonic style with [flake8](https://flake8.pycqa.org), [black](https://black.readthedocs.io) and [isort](https://pycqa.github.io/isort)
@@ -32,4 +34,9 @@ Python template with CI/CD ready for production
3234
- Automatic publish to [PyPI](https://pypi.org)
3335
- Automatic dependency update check with [dependabot](https://github.com/dependabot)
3436

37+
### FastAPI Features
38+
39+
- Configuration for deploy on [Heroku](https://www.heroku.com)
40+
- Configuration for deploy with [Docker](https://www.docker.com)
41+
3542
> All of the above via [GitHub Actions](https://github.com/features/actions) and [GitHub Pages](https://pages.github.com)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "template"
3-
version = "0.3.0"
3+
version = "0.3.1"
44
description = "Python template with CI/CD ready for production"
55
authors = ["leynier <[email protected]>"]
66
homepage = "https://github.com/leynier/python-template"

tests/test_template.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
from typer.testing import CliRunner
2-
31
from template.main import app
2+
from typer.testing import CliRunner
43

54
runner = CliRunner()
65

0 commit comments

Comments
 (0)