@@ -33,9 +33,9 @@ $ cd tmuxp
33
33
34
34
### Bootstrap
35
35
36
- The easiest way to configure a dev environment is through [ poetry ] . This
36
+ The easiest way to configure a dev environment is through [ uv ] . This
37
37
automatically will manage virtualenv and python dependencies for tmuxp.
38
- For information on installing poetry visit the [ poetry 's documentation] .
38
+ For information on installing uv visit the [ uv 's documentation] .
39
39
40
40
To begin developing, check out the code from github:
41
41
@@ -48,34 +48,29 @@ $ cd tmuxp
48
48
```
49
49
50
50
You can create a virtualenv, and install all of the locked
51
- packages as listed in poetry .lock:
51
+ packages as listed in uv .lock:
52
52
53
53
``` console
54
- $ poetry install
54
+ $ uv sync --all-extras --dev
55
55
```
56
56
57
57
If you ever need to update packages during your development session, the
58
- following command can be used to update all packages as per poetry settings or
59
- individual package (second command):
58
+ following command can be used to update all packages as per uv settings:
60
59
61
60
``` console
62
- $ poetry update
61
+ $ uv sync --all-extras --dev --upgrade
63
62
```
64
63
65
- ``` console
66
- $ poetry update requests
67
- ```
68
-
69
- Then activate it to your current tty / terminal session with:
64
+ Then before any python command in tty / terminal session, run with:
70
65
71
66
``` console
72
- $ poetry shell
67
+ $ uv run [command]
73
68
```
74
69
75
70
That is it! You are now ready to code!
76
71
77
- [ poetry ] : https://python-poetry.org/
78
- [ poetry 's documentation] : https://python-poetry.org/docs/
72
+ [ uv ] : https://github.com/astral-sh/uv
73
+ [ uv 's documentation] : https://docs.astral.sh/uv
79
74
80
75
### Advanced: Manual virtualenv
81
76
@@ -134,7 +129,7 @@ $ make watch_test
134
129
### Manual (just the command, please)
135
130
136
131
``` console
137
- $ poetry run py.test
132
+ $ uv run py.test
138
133
```
139
134
140
135
or:
@@ -159,19 +154,19 @@ $ env PYTEST_ADDOPTS="-verbose" make start
159
154
Pick a file:
160
155
161
156
``` console
162
- $ env PYTEST_ADDOPTS=" tests/workspace/test_builder.py" poetry run make start
157
+ $ env PYTEST_ADDOPTS=" tests/workspace/test_builder.py" uv run make start
163
158
```
164
159
165
160
Drop into ` test_automatic_rename_option() ` in ` tests/workspace/test_builder.py ` :
166
161
167
162
``` console
168
- $ env PYTEST_ADDOPTS=" -s -x -vv tests/workspace/test_builder.py" poetry run make start
163
+ $ env PYTEST_ADDOPTS=" -s -x -vv tests/workspace/test_builder.py" uv run make start
169
164
```
170
165
171
166
Drop into ` test_automatic_rename_option() ` in ` tests/workspace/test_builder.py ` and stop on first error:
172
167
173
168
``` console
174
- $ env PYTEST_ADDOPTS=" -s -x -vv tests/workspace/test_builder.py::test_automatic_rename_option" poetry run make start
169
+ $ env PYTEST_ADDOPTS=" -s -x -vv tests/workspace/test_builder.py::test_automatic_rename_option" uv run make start
175
170
```
176
171
177
172
Drop into ` pdb ` on first error:
@@ -299,10 +294,8 @@ $ cd doc
299
294
$ make watch
300
295
```
301
296
302
- If you're not source'd via ` poetry shell ` , you can use this:
303
-
304
297
``` console
305
- $ make SPHINXBUILD=' poetry run sphinx-build' watch
298
+ $ make SPHINXBUILD=' uv run sphinx-build' watch
306
299
```
307
300
308
301
(tmuxp-developer-config)=
@@ -335,10 +328,10 @@ The project uses [ruff] to handle formatting, sorting imports and linting.
335
328
336
329
```` {tab} Command
337
330
338
- poetry :
331
+ uv :
339
332
340
333
```console
341
- $ poetry run ruff
334
+ $ uv run ruff
342
335
```
343
336
344
337
If you setup manually:
@@ -369,10 +362,10 @@ requires [`entr(1)`].
369
362
370
363
```` {tab} Fix files
371
364
372
- poetry :
365
+ uv :
373
366
374
367
```console
375
- $ poetry run ruff check . --fix
368
+ $ uv run ruff check . --fix
376
369
```
377
370
378
371
If you setup manually:
@@ -389,10 +382,10 @@ $ ruff check . --fix
389
382
390
383
```` {tab} Command
391
384
392
- poetry :
385
+ uv :
393
386
394
387
```console
395
- $ poetry run ruff format .
388
+ $ uv run ruff format .
396
389
```
397
390
398
391
If you setup manually:
@@ -417,10 +410,10 @@ $ make ruff_format
417
410
418
411
```` {tab} Command
419
412
420
- poetry :
413
+ uv :
421
414
422
415
```console
423
- $ poetry run mypy .
416
+ $ uv run mypy .
424
417
```
425
418
426
419
If you setup manually:
0 commit comments