Skip to content

Commit 75e3a1f

Browse files
committed
Update README.md
1 parent 2814d93 commit 75e3a1f

File tree

1 file changed

+13
-46
lines changed

1 file changed

+13
-46
lines changed

README.md

Lines changed: 13 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,24 @@ and best development practices for Python.
1313

1414
### Development features
1515

16-
- Supports `Python 3.9` and higher.
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).
19-
- Automatic codestyle with [`Ruff formatter`](https://docs.astral.sh/ruff/formatter/)
16+
- Supports `Python 3.9 - 3.13`
17+
- [`uv`](https://docs.astral.sh/uv/) as a package manager.
18+
- Automatic codestyle with [`ruff formatter`](https://docs.astral.sh/ruff/formatter/)
2019
- Linting with [`ruff`](https://github.com/astral-sh/ruff)
2120
- Type checks with [`mypy`](https://mypy.readthedocs.io), security checks
2221
with [`safety`](https://github.com/pyupio/safety).
2322
- Dependencies check with [`deptry`](https://deptry.com/)
2423
- Testing with [`pytest`](https://docs.pytest.org/en/latest/) and [`coverage`](https://github.com/nedbat/coveragepy).
2524
- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.
26-
-
27-
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),
28-
and [`.gitignore`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/.gitignore).
25+
- 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).
2926

3027
### Deployment features
3128

3229
- `Github Actions` with linters and tests in
3330
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).
3431
- `Gitlab CI` with linters and tests in
3532
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.
33+
Click [here](pages/gitlab.md) for a detailed overview.
3734
- Ready-to-use [`Makefile`](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/Makefile) with
3835
formatting, linting, and testing. More details in [makefile-usage](#makefile-usage).
3936
- [Dockerfile](%7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/Dockerfile) for your package.
@@ -69,16 +66,12 @@ The input variables, with their default values:
6966
| `git_platform` | `github` | Git platform (Github/Gitlab) |
7067
| `username` | `username` | User or organization name for Git platform |
7168
| `git_repo_url` | based on `git_platform`, `project_name` and `username` | URL to the git repository |
72-
| `python_version` | `3.9` | Python version. One of `3.9`, `3.10`, `3.11`, `3.12`. It is used for builds, CI and formatters. |
69+
| `python_version` | `3.9` | Python version. One of `3.9`, `3.10`, `3.11`, `3.12`, `3.13`. It is used for builds, CI and formatters. |
7370
| `line_length` | 88 | The max length per line. Must be between 50 and 300. |
7471
| `install_pydantic` | true | If `pydantic` with `mypy` plugin should be installed |
7572

7673
All input values will be saved in the `cookiecutter-config-file.yml` file so that you won't lose them. 😉
7774

78-
#### Demo
79-
80-
[![Demo of github.com/TezRomacH/python-package-template](https://asciinema.org/a/422052.svg)](https://asciinema.org/a/422052)
81-
8275
### More details
8376

8477
Your project will contain `README.md` file with instructions for development, deployment, etc. You can
@@ -87,7 +80,7 @@ before.
8780

8881
### Initial set up
8982

90-
#### Initialize `poetry`
83+
#### Initialize `uv`
9184

9285
By running `make install`
9386

@@ -105,19 +98,13 @@ contains a lot of functions
10598
for faster development.
10699

107100
<details>
108-
<summary>1. Download and remove Poetry</summary>
101+
<summary>1. Download uv</summary>
109102
<p>
110103

111-
To download and install Poetry run:
112-
113-
```bash
114-
make poetry-download
115-
```
116-
117-
To uninstall
104+
To download and install uv run:
118105

119106
```bash
120-
make poetry-remove
107+
make uv-install
121108
```
122109

123110
</p>
@@ -161,10 +148,10 @@ Codestyle checks only, without rewriting files:
161148
make check-codestyle
162149
```
163150

164-
Update all dev libraries to the latest version using one comand
151+
Update all libraries to the latest version using one command
165152

166153
```bash
167-
make update-dev-deps
154+
make update
168155
```
169156

170157
</p>
@@ -174,11 +161,7 @@ make update-dev-deps
174161
<summary>4. Code security</summary>
175162
<p>
176163

177-
```bash
178-
make check-safety
179-
```
180-
181-
This command launches `Poetry` integrity checks as well as identifies security issues with `Safety`
164+
This command identifies security issues with `Safety`
182165

183166
```bash
184167
make check-safety
@@ -230,22 +213,6 @@ make lint
230213
<summary>8. Docker</summary>
231214
<p>
232215

233-
```bash
234-
make docker-build
235-
```
236-
237-
which is equivalent to:
238-
239-
```bash
240-
make docker-build VERSION=latest
241-
```
242-
243-
Remove docker image with
244-
245-
```bash
246-
make docker-remove
247-
```
248-
249216
Run with docker compose
250217

251218
```bash

0 commit comments

Comments
 (0)