Skip to content

Commit eb9861a

Browse files
committed
docs: add uv installation alternatives
1 parent 185ef50 commit eb9861a

File tree

3 files changed

+107
-0
lines changed

3 files changed

+107
-0
lines changed

CHANGES

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

11+
[uv](https://docs.astral.sh/uv/):
12+
13+
```console
14+
$ uv tool install g
15+
```
16+
17+
Working inside a uv-managed project:
18+
19+
```console
20+
$ uv add g
21+
```
22+
23+
For one-off use without installing globally:
24+
25+
```console
26+
$ uvx g
27+
```
28+
1129
[pipx](https://pypa.github.io/pipx/docs/):
1230

1331
```console

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,24 @@ git, subversion (`svn`), or mercurial (`hg`).
1515
$ pip install --user g
1616
```
1717

18+
Or install with [uv](https://docs.astral.sh/uv/):
19+
20+
```console
21+
$ uv tool install g
22+
```
23+
24+
Working inside a uv-managed project:
25+
26+
```console
27+
$ uv add g
28+
```
29+
30+
For one-off use without installing globally:
31+
32+
```console
33+
$ uvx g
34+
```
35+
1836
```console
1937
$ g
2038
```
@@ -29,6 +47,20 @@ You can test the unpublished version of g before its released.
2947
$ pip install --user --upgrade --pre g
3048
```
3149

50+
- [uv](https://docs.astral.sh/uv/):
51+
52+
```console
53+
$ uv tool install g
54+
```
55+
56+
```console
57+
$ uv add g
58+
```
59+
60+
```console
61+
$ uvx g
62+
```
63+
3264
- [pipx](https://pypa.github.io/pipx/docs/):
3365

3466
```console

docs/quickstart.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,40 @@ For latest official version:
1010
$ pip install --user g
1111
```
1212

13+
Or install with [uv](https://docs.astral.sh/uv/):
14+
15+
```console
16+
$ uv tool install g
17+
```
18+
19+
Add g to a uv-managed project:
20+
21+
```console
22+
$ uv add g
23+
```
24+
25+
Run g once without installing globally:
26+
27+
```console
28+
$ uvx g
29+
```
30+
1331
Upgrading:
1432

1533
```console
1634
$ pip install --user --upgrade g
1735
```
1836

37+
Or with uv:
38+
39+
```console
40+
$ uv tool upgrade g
41+
```
42+
43+
```console
44+
$ uv add g
45+
```
46+
1947
(developmental-releases)=
2048

2149
### Developmental releases
@@ -30,6 +58,20 @@ In their versions you will see notification like `a1`, `b1`, and `rc1`, respecti
3058
$ pip install --user --upgrade --pre g
3159
```
3260

61+
- [uv]\:
62+
63+
```console
64+
$ uv tool install g
65+
```
66+
67+
```console
68+
$ uv add g
69+
```
70+
71+
```console
72+
$ uvx g
73+
```
74+
3375
- [pipx]\:
3476

3577
```console
@@ -46,6 +88,20 @@ via trunk (can break easily):
4688
$ pip install --user -e git+https://github.com/vcs-python/g.git#egg=g
4789
```
4890

91+
- [uv]\:
92+
93+
```console
94+
$ uv tool install git+https://github.com/vcs-python/g.git
95+
```
96+
97+
```console
98+
$ uv add git+https://github.com/vcs-python/g.git
99+
```
100+
101+
```console
102+
$ uvx --from git+https://github.com/vcs-python/g.git g --version
103+
```
104+
49105
- [pipx]\:
50106

51107
```console
@@ -54,3 +110,4 @@ via trunk (can break easily):
54110

55111
[pip]: https://pip.pypa.io/en/stable/
56112
[pipx]: https://pypa.github.io/pipx/docs/
113+
[uv]: https://docs.astral.sh/uv/

0 commit comments

Comments
 (0)