@@ -7,7 +7,7 @@ structure and workflow. At a later point these will refer to that website for do
7
7
8
8
## Bootstrap the project
9
9
10
- Install and [ git] and [ poetry ]
10
+ Install and [ git] and [ uv ]
11
11
12
12
Clone:
13
13
@@ -22,10 +22,10 @@ $ cd vcspull
22
22
Install packages:
23
23
24
24
``` console
25
- $ poetry install -E " docs test coverage lint "
25
+ $ uv sync --all-extras --dev
26
26
```
27
27
28
- [ installation documentation ] : https://python-poetry.org/docs/# installation
28
+ [ installation documentation ] : https://docs.astral.sh/uv/getting-started/ installation/
29
29
[ git ] : https://git-scm.com/
30
30
31
31
## Development loop
@@ -55,7 +55,7 @@ $ make watch_test
55
55
#### Manual (just the command, please)
56
56
57
57
``` console
58
- $ poetry run py.test
58
+ $ uv run py.test
59
59
```
60
60
61
61
or:
@@ -169,16 +169,16 @@ The project uses [ruff] to handle formatting, sorting imports and linting.
169
169
170
170
```` {tab} Command
171
171
172
- poetry :
172
+ uv :
173
173
174
174
```console
175
- $ poetry run ruff
175
+ $ uv run ruff check .
176
176
```
177
177
178
178
If you setup manually:
179
179
180
180
```console
181
- $ ruff .
181
+ $ ruff check .
182
182
```
183
183
184
184
````
@@ -203,16 +203,16 @@ requires [`entr(1)`].
203
203
204
204
```` {tab} Fix files
205
205
206
- poetry :
206
+ uv :
207
207
208
208
```console
209
- $ poetry run ruff . --fix
209
+ $ uv run ruff check . --fix
210
210
```
211
211
212
212
If you setup manually:
213
213
214
214
```console
215
- $ ruff . --fix
215
+ $ ruff check . --fix
216
216
```
217
217
218
218
````
@@ -223,10 +223,10 @@ $ ruff . --fix
223
223
224
224
```` {tab} Command
225
225
226
- poetry :
226
+ uv :
227
227
228
228
```console
229
- $ poetry run ruff format .
229
+ $ uv run ruff format .
230
230
```
231
231
232
232
If you setup manually:
@@ -251,10 +251,10 @@ $ make ruff_format
251
251
252
252
```` {tab} Command
253
253
254
- poetry :
254
+ uv :
255
255
256
256
```console
257
- $ poetry run mypy .
257
+ $ uv run mypy .
258
258
```
259
259
260
260
If you setup manually:
@@ -297,7 +297,7 @@ See `[tool.mypy]` in pyproject.toml.
297
297
298
298
## Publishing to PyPI
299
299
300
- [ poetry ] handles virtualenv creation, package requirements, versioning,
300
+ [ uv ] handles virtualenv creation, package requirements, versioning,
301
301
building, and publishing. Therefore there is no setup.py or requirements files.
302
302
303
303
Update ` __version__ ` in ` __about__.py ` and ` pyproject.toml ` ::
@@ -306,10 +306,11 @@ Update `__version__` in `__about__.py` and `pyproject.toml`::
306
306
git tag v0.1.1
307
307
git push
308
308
git push --tags
309
- poetry build
310
- poetry publish
311
309
312
- [ poetry ] : https://python-poetry.org/
310
+ GitHub Actions will detect the new git tag, and in its own workflow run `uv
311
+ build` and push to PyPI.
312
+
313
+ [ uv ] : https://github.com/astral-sh/uv
313
314
[ entr(1) ] : http://eradman.com/entrproject/
314
315
[ `entr(1)` ] : http://eradman.com/entrproject/
315
316
[ ruff format ] : https://docs.astral.sh/ruff/formatter/
0 commit comments