Skip to content

Commit 1ce0620

Browse files
committed
docs: add uv alternatives to install instructions
1 parent 2a85211 commit 1ce0620

File tree

6 files changed

+143
-0
lines changed

6 files changed

+143
-0
lines changed

CHANGES

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ To install the unreleased tmuxp version, see [developmental releases](https://tm
88
$ pip install --user --upgrade --pre tmuxp
99
```
1010

11+
[uv](https://docs.astral.sh/uv/getting-started/features/#python-versions):
12+
13+
```console
14+
$ uv add 'tmuxp>=1.10.0b1'
15+
```
16+
17+
[uvx](https://docs.astral.sh/uv/guides/tools/):
18+
19+
```console
20+
$ uvx --from 'tmuxp>=1.10.0b1' tmuxp
21+
```
22+
1123
[pipx](https://pypa.github.io/pipx/docs/):
1224

1325
```console
@@ -1493,6 +1505,24 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
14931505
14941506
```
14951507

1508+
Inside a [uv](https://docs.astral.sh/uv/getting-started/features/#python-versions)
1509+
project you can add `ipdb` as a development dependency instead:
1510+
1511+
```{code-block} sh
1512+
1513+
$ uv add --dev ipdb
1514+
1515+
```
1516+
1517+
For a pipx-style ad hoc execution, reach for
1518+
[uvx](https://docs.astral.sh/uv/guides/tools/):
1519+
1520+
```{code-block} sh
1521+
1522+
$ uvx --from ipdb ipdb3 --help
1523+
1524+
```
1525+
14961526
You can execute python directly via `-c`:
14971527

14981528
```{code-block} sh

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@ pip:
2424
$ pip install --user tmuxp
2525
```
2626

27+
If you're managing the project with [uv](https://docs.astral.sh/uv/), add tmuxp as a dependency instead:
28+
29+
```console
30+
$ uv add tmuxp
31+
```
32+
33+
To run tmuxp without installing it globally, similar to `pipx`, invoke it with
34+
[uvx](https://docs.astral.sh/uv/guides/tools/):
35+
36+
```console
37+
$ uvx tmuxp
38+
```
39+
2740
Homebrew:
2841

2942
```console
@@ -52,6 +65,19 @@ Developmental releases:
5265
pip install --user --upgrade --pre tmuxp
5366
```
5467

68+
Or request the pre-release from a uv project environment:
69+
70+
```console
71+
uv add 'tmuxp>=1.10.0b1'
72+
```
73+
74+
75+
- [uvx](https://docs.astral.sh/uv/guides/tools/):
76+
77+
```console
78+
uvx tmuxp
79+
```
80+
5581
- [pipx](https://pypa.github.io/pipx/docs/):
5682

5783
```console

docs/cli/completion.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ Provisional support for completions in tmuxp 1.17+ are powered by [shtab](https:
1818
$ pip install shtab --user
1919
```
2020

21+
With a [uv](https://docs.astral.sh/uv/getting-started/features/#python-versions) project you can add it directly as a development dependency:
22+
23+
```console
24+
$ uv add --dev shtab
25+
```
26+
27+
Or reach for [uvx](https://docs.astral.sh/uv/guides/tools/) when you want a pipx-style ephemeral install:
28+
29+
```console
30+
$ uvx shtab --help
31+
```
32+
2133
:::{tab} bash
2234

2335
```bash

docs/cli/shell.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,18 @@ compatible debuggers, for instance [ipdb][ipdb]:
5757
$ pip install --user ipdb
5858
```
5959

60+
Inside a [uv](https://docs.astral.sh/uv/getting-started/features/#python-versions)-managed project you can add `ipdb` as a development dependency:
61+
62+
```console
63+
$ uv add --dev ipdb
64+
```
65+
66+
For a pipx-style ad hoc install, run it through [uvx](https://docs.astral.sh/uv/guides/tools/):
67+
68+
```console
69+
$ uvx --from ipdb ipdb3 --help
70+
```
71+
6072
```console
6173
$ env PYTHONBREAKPOINT=ipdb.set_trace tmuxp shell
6274
```

docs/developing.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,21 @@ This has `pip`, a python package manager install the python package
9797
in the current directory. `-e` means `--editable`, which means you can
9898
adjust the code and the installed software will reflect the changes.
9999

100+
When you manage dependencies with
101+
[uv](https://docs.astral.sh/uv/getting-started/features/#python-versions),
102+
add the checkout as an editable development dependency instead:
103+
104+
```console
105+
$ uv add --dev --editable .
106+
```
107+
108+
Prefer a one-off, pipx-style execution while you hack? Call tmuxp via
109+
[uvx](https://docs.astral.sh/uv/guides/tools/):
110+
111+
```console
112+
$ uvx tmuxp
113+
```
114+
100115
```console
101116
$ tmuxp
102117
```

docs/quickstart.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,34 @@ Ensure you have at least tmux **>= 1.8** and python **>= 3.7**.
1010
$ pip install --user tmuxp
1111
```
1212

13+
If you're managing dependencies with [uv]_ inside a project environment,
14+
add tmuxp directly to your lockfile:
15+
16+
```console
17+
$ uv add tmuxp
18+
```
19+
20+
To run tmuxp without installing it globally—similar to what you'd do with
21+
`pipx`—invoke it via [uvx]_:
22+
23+
```console
24+
$ uvx tmuxp
25+
```
26+
1327
You can upgrade to the latest release with:
1428

1529
```console
1630
$ pip install --user --upgrade tmuxp
1731
```
1832

33+
Within a uv-managed project you can upgrade by refreshing the lockfile and
34+
syncing the environment:
35+
36+
```console
37+
$ uv lock --upgrade-package tmuxp
38+
$ uv sync
39+
```
40+
1941
Then install {ref}`completion`.
2042

2143
If you are a Homebrew user you can install it with:
@@ -38,6 +60,18 @@ In their versions you will see notification like `a1`, `b1`, and `rc1`, respecti
3860
$ pip install --user --upgrade --pre tmuxp
3961
```
4062

63+
- [uv]_:
64+
65+
```console
66+
$ uv add 'tmuxp>=1.10.0b1'
67+
```
68+
69+
- [uvx]_:
70+
71+
```console
72+
$ uvx --from 'tmuxp>=1.10.0b1' tmuxp
73+
```
74+
4175
- [pipx]\:
4276

4377
```console
@@ -54,6 +88,18 @@ via trunk (can break easily):
5488
$ pip install --user -e git+https://github.com/tmux-python/tmuxp.git#egg=tmuxp
5589
```
5690

91+
- [uv]_:
92+
93+
```console
94+
$ uv add "tmuxp @ git+https://github.com/tmux-python/tmuxp.git@master"
95+
```
96+
97+
- [uvx]_:
98+
99+
```console
100+
$ uvx --from "tmuxp @ git+https://github.com/tmux-python/tmuxp.git@master" tmuxp
101+
```
102+
57103
- [pipx]\:
58104

59105
```console
@@ -62,6 +108,8 @@ via trunk (can break easily):
62108

63109
[pip]: https://pip.pypa.io/en/stable/
64110
[pipx]: https://pypa.github.io/pipx/docs/
111+
[uv]: https://docs.astral.sh/uv/getting-started/features/#python-versions
112+
[uvx]: https://docs.astral.sh/uv/guides/tools/
65113

66114
## Commands
67115

0 commit comments

Comments
 (0)