You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-8Lines changed: 18 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,22 +14,31 @@ and best development practices for Python.
14
14
### Development features
15
15
16
16
- Supports `Python 3.9` and higher.
17
-
-[`Poetry`](https://python-poetry.org/) as a dependency manager. See configuration in [`pyproject.toml`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/pyproject.toml).
17
+
-[`Poetry`](https://python-poetry.org/) as a dependency manager. See configuration
18
+
in [`pyproject.toml`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/pyproject.toml).
18
19
- Automatic codestyle with [`Ruff formatter`](https://docs.astral.sh/ruff/formatter/)
19
20
- Linting with [`ruff`](https://github.com/astral-sh/ruff)
20
-
- Type checks with [`mypy`](https://mypy.readthedocs.io), security checks with [`safety`](https://github.com/pyupio/safety).
21
+
- Type checks with [`mypy`](https://mypy.readthedocs.io), security checks
22
+
with [`safety`](https://github.com/pyupio/safety).
21
23
- Dependencies check with [`deptry`](https://deptry.com/)
22
24
- Testing with [`pytest`](https://docs.pytest.org/en/latest/) and [`coverage`](https://github.com/nedbat/coveragepy).
23
25
- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.
24
-
- Ready-to-use [`.editorconfig`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.editorconfig), [`.dockerignore`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.dockerignore), and [`.gitignore`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.gitignore).
and [`.gitignore`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.gitignore).
25
29
26
30
### Deployment features
27
31
28
-
-`Github Actions` with linters and tests in the [workflow](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.github/workflows/%7B%7B%20cookiecutter.package_name%20%7D%7D.yml).
29
-
-`Gitlab CI` with linters and tests in the [pipeline](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.gitlab-ci.yml). Click [here](pages/gitlab.md) for detailed overview.
30
-
- Ready-to-use [`Makefile`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/Makefile) with formatting, linting, and testing. More details in [makefile-usage](#makefile-usage).
32
+
-`Github Actions` with linters and tests in
33
+
the [workflow](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.github/workflows/%7B%7B%20cookiecutter.package_name%20%7D%7D.yml).
34
+
-`Gitlab CI` with linters and tests in
35
+
the [pipeline](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.gitlab-ci.yml).
36
+
Click [here](pages/gitlab.md) for detailed overview.
37
+
- Ready-to-use [`Makefile`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/Makefile) with
38
+
formatting, linting, and testing. More details in [makefile-usage](#makefile-usage).
31
39
-[Dockerfile](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/Dockerfile) for your package.
32
-
-[docker-compose.yml](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/docker-compose.yml) for local development in Docker.
40
+
-[docker-compose.yml](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/docker-compose.yml) for
41
+
local development in Docker.
33
42
34
43
## How to use it
35
44
@@ -92,7 +101,8 @@ By running `make pre-commit-install`. Make sure to set up git first via `git ini
0 commit comments