@@ -9,10 +9,10 @@ git clone {{ cookiecutter.git_repo_url }}.git
99cd {{ cookiecutter.project_name.lower ().replace(' ' , ' -' ) }}
1010```
1111
12- 2 . If you don't have ` Poetry ` installed run:
12+ 2 . If you don't have ` uv ` installed run:
1313
1414``` bash
15- make poetry -download
15+ make uv -download
1616```
1717
18183 . Initialize poetry and install ` pre-commit ` hooks:
@@ -30,22 +30,18 @@ make format lint test
3030
3131### Makefile usage
3232
33- [ ` Makefile ` ] ({{ cookiecutter.git_repo_url }}/blob/master/Makefile) contains a lot of functions for faster development.
33+ [ ` Makefile ` ] ( %7B%7B%20cookiecutter.project_name.lower().replace('%20',%20'-')%20%7D%7D/Makefile )
34+ contains a lot of functions
35+ for faster development.
3436
3537<details >
36- <summary >1. Download and remove Poetry </summary >
38+ <summary >1. Download uv </summary >
3739<p >
3840
39- To download and install Poetry run:
41+ To download and install uv run:
4042
4143``` bash
42- make poetry-download
43- ```
44-
45- To uninstall
46-
47- ``` bash
48- make poetry-remove
44+ make uv-install
4945```
5046
5147</p >
@@ -61,7 +57,7 @@ Install requirements:
6157make install
6258```
6359
64- Pre-commit hooks could be installed after ` git init ` via
60+ Pre-commit hooks coulb be installed after ` git init ` via
6561
6662``` bash
6763make pre-commit-install
@@ -74,7 +70,7 @@ make pre-commit-install
7470<summary >3. Codestyle</summary >
7571<p >
7672
77- Automatic formatting uses ` ruff ` .
73+ Automatic formatting uses ` ruff ` formatter
7874
7975``` bash
8076make codestyle
@@ -89,10 +85,10 @@ Codestyle checks only, without rewriting files:
8985make check-codestyle
9086```
9187
92- Update all dev libraries to the latest version using one command
88+ Update all libraries to the latest version using one command
9389
9490``` bash
95- make update-dev-deps
91+ make update
9692```
9793
9894</p >
@@ -102,29 +98,23 @@ make update-dev-deps
10298<summary >4. Code security</summary >
10399<p >
104100
105- This command identifies security issues with ` Safety ` :
101+ This command identifies security issues with ` Safety `
106102
107103``` bash
108104make check-safety
109105```
110106
111- To validate ` pyproject.toml ` use
112-
113- ``` bash
114- make check-poetry
115- ```
116-
117107</p >
118108</details >
119109
120110<details >
121- <summary >5. Linting and type checks</summary >
111+ <summary >5. Type checks</summary >
122112<p >
123113
124- Run static linting with ` ruff ` and ` mypy ` :
114+ Run ` mypy ` static type checker
125115
126116``` bash
127- make static-lint
117+ make mypy
128118```
129119
130120</p >
@@ -134,7 +124,7 @@ make static-lint
134124<summary >6. Tests with coverage</summary >
135125<p >
136126
137- Run tests:
127+ Run ` pytest `
138128
139129``` bash
140130make test
@@ -160,55 +150,19 @@ make lint
160150<summary >8. Docker</summary >
161151<p >
162152
163- ``` bash
164- make docker-build
165- ```
166-
167- which is equivalent to:
168-
169- ``` bash
170- make docker-build VERSION=latest
171- ```
172-
173- Remove docker image with
153+ Run with docker compose
174154
175155``` bash
176- make docker-remove
156+ make docker-up
177157```
178158
179- More information [ about docker] ({{ cookiecutter.git_repo_url }}/tree/master/docker).
180-
181159</p >
182160</details >
183161
184162<details >
185163<summary >9. Cleanup</summary >
186164<p >
187- Delete pycache files
188-
189- ``` bash
190- make pycache-remove
191- ```
192-
193- Remove package build
194-
195- ``` bash
196- make build-remove
197- ```
198-
199- Delete .DS_STORE files
200-
201- ``` bash
202- make dsstore-remove
203- ```
204-
205- Remove .mypycache
206-
207- ``` bash
208- make mypycache-remove
209- ```
210-
211- Or to remove all above run:
165+ Delete cache and build files:
212166
213167``` bash
214168make cleanup
0 commit comments