Skip to content

Commit 5d0bd1b

Browse files
KemingHegithub-actions[bot]
authored andcommitted
docs(src/assets/): update uv official documentation
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 8fc9568 commit 5d0bd1b

File tree

15 files changed

+174
-40
lines changed

15 files changed

+174
-40
lines changed

src/assets/uv/_metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"source_repo": "astral-sh/uv",
33
"docs_path": "docs",
4-
"updated_at": "2025-07-29T22:05:21Z",
5-
"commit_sha": "11fe8f70f9148f96168015777402a764f83ee923"
4+
"updated_at": "2025-08-05T22:05:31Z",
5+
"commit_sha": "ce37286814dbb802c422f0926487cfab7aefd2b7"
66
}

src/assets/uv/concepts/build-backend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To use uv as a build backend in an existing project, add `uv_build` to the
3131

3232
```toml title="pyproject.toml"
3333
[build-system]
34-
requires = ["uv_build>=0.8.3,<0.9.0"]
34+
requires = ["uv_build>=0.8.5,<0.9.0"]
3535
build-backend = "uv_build"
3636
```
3737

src/assets/uv/concepts/projects/init.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ dependencies = []
111111
example-pkg = "example_pkg:main"
112112

113113
[build-system]
114-
requires = ["hatchling"]
115-
build-backend = "hatchling.build"
114+
requires = ["uv_build>=0.8.5,<0.9.0"]
115+
build-backend = "uv_build"
116116
```
117117

118118
!!! tip
@@ -134,8 +134,8 @@ dependencies = []
134134
example-pkg = "example_pkg:main"
135135

136136
[build-system]
137-
requires = ["hatchling"]
138-
build-backend = "hatchling.build"
137+
requires = ["uv_build>=0.8.5,<0.9.0"]
138+
build-backend = "uv_build"
139139
```
140140

141141
The command can be executed with `uv run`:
@@ -195,8 +195,8 @@ requires-python = ">=3.11"
195195
dependencies = []
196196

197197
[build-system]
198-
requires = ["hatchling"]
199-
build-backend = "hatchling.build"
198+
requires = ["uv_build>=0.8.5,<0.9.0"]
199+
build-backend = "uv_build"
200200
```
201201

202202
!!! tip

src/assets/uv/concepts/projects/workspaces.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ bird-feeder = { workspace = true }
7575
members = ["packages/*"]
7676

7777
[build-system]
78-
requires = ["hatchling"]
79-
build-backend = "hatchling.build"
78+
requires = ["uv_build>=0.8.5,<0.9.0"]
79+
build-backend = "uv_build"
8080
```
8181

8282
In this example, the `albatross` project depends on the `bird-feeder` project, which is a member of
@@ -106,8 +106,8 @@ tqdm = { git = "https://github.com/tqdm/tqdm" }
106106
members = ["packages/*"]
107107

108108
[build-system]
109-
requires = ["hatchling"]
110-
build-backend = "hatchling.build"
109+
requires = ["uv_build>=0.8.5,<0.9.0"]
110+
build-backend = "uv_build"
111111
```
112112

113113
Every workspace member would, by default, install `tqdm` from GitHub, unless a specific member
@@ -188,8 +188,8 @@ dependencies = ["bird-feeder", "tqdm>=4,<5"]
188188
bird-feeder = { path = "packages/bird-feeder" }
189189

190190
[build-system]
191-
requires = ["hatchling"]
192-
build-backend = "hatchling.build"
191+
requires = ["uv_build>=0.8.5,<0.9.0"]
192+
build-backend = "uv_build"
193193
```
194194

195195
This approach conveys many of the same benefits, but allows for more fine-grained control over

src/assets/uv/concepts/tools.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,40 @@ $ uvx -w <extra-package> <tool-package>
209209
If the requested version conflicts with the requirements of the tool package, package resolution
210210
will fail and the command will error.
211211

212+
## Installing executables from additional packages
213+
214+
When installing a tool, you may want to include executables from additional packages in the same
215+
tool environment. This is useful when you have related tools that work together or when you want to
216+
install multiple executables that share dependencies.
217+
218+
The `--with-executables-from` option allows you to specify additional packages whose executables
219+
should be installed alongside the main tool:
220+
221+
```console
222+
$ uv tool install --with-executables-from <package1>,<package2> <tool-package>
223+
```
224+
225+
For example, to install Ansible along with executables from `ansible-core` and `ansible-lint`:
226+
227+
```console
228+
$ uv tool install --with-executables-from ansible-core,ansible-lint ansible
229+
```
230+
231+
This will install all executables from the `ansible`, `ansible-core`, and `ansible-lint` packages
232+
into the same tool environment, making them all available on the `PATH`.
233+
234+
The `--with-executables-from` option can be combined with other installation options:
235+
236+
```console
237+
$ uv tool install --with-executables-from ansible-core --with mkdocs-material ansible
238+
```
239+
240+
Note that `--with-executables-from` differs from `--with` in that:
241+
242+
- `--with` includes additional packages as dependencies but does not install their executables
243+
- `--with-executables-from` includes both the packages as dependencies and installs their
244+
executables
245+
212246
## Python versions
213247

214248
Each tool environment is linked to a specific Python version. This uses the same Python version

src/assets/uv/getting-started/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ uv provides a standalone installer to download and install uv:
2525
Request a specific version by including it in the URL:
2626

2727
```console
28-
$ curl -LsSf https://astral.sh/uv/0.8.3/install.sh | sh
28+
$ curl -LsSf https://astral.sh/uv/0.8.5/install.sh | sh
2929
```
3030

3131
=== "Windows"
@@ -41,7 +41,7 @@ uv provides a standalone installer to download and install uv:
4141
Request a specific version by including it in the URL:
4242

4343
```pwsh-session
44-
PS> powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/0.8.3/install.ps1 | iex"
44+
PS> powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/0.8.5/install.ps1 | iex"
4545
```
4646

4747
!!! tip
@@ -151,7 +151,7 @@ $ uv self update
151151
!!! tip
152152

153153
Updating uv will re-run the installer and can modify your shell profiles. To disable this
154-
behavior, set `INSTALLER_NO_MODIFY_PATH=1`.
154+
behavior, set `UV_NO_MODIFY_PATH=1`.
155155

156156
When another installation method is used, self-updates are disabled. Use the package manager's
157157
upgrade method instead. For example, with `pip`:

src/assets/uv/guides/integration/aws-lambda.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ the second stage, we'll copy this directory over to the final image, omitting th
9292
other unnecessary files.
9393

9494
```dockerfile title="Dockerfile"
95-
FROM ghcr.io/astral-sh/uv:0.8.3 AS uv
95+
FROM ghcr.io/astral-sh/uv:0.8.5 AS uv
9696

9797
# First, bundle the dependencies into the task root.
9898
FROM public.ecr.aws/lambda/python:3.13 AS builder
@@ -334,7 +334,7 @@ And confirm that opening http://127.0.0.1:8000/ in a web browser displays, "Hell
334334
Finally, we'll update the Dockerfile to include the local library in the deployment package:
335335

336336
```dockerfile title="Dockerfile"
337-
FROM ghcr.io/astral-sh/uv:0.8.3 AS uv
337+
FROM ghcr.io/astral-sh/uv:0.8.5 AS uv
338338

339339
# First, bundle the dependencies into the task root.
340340
FROM public.ecr.aws/lambda/python:3.13 AS builder

src/assets/uv/guides/integration/docker.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ $ docker run --rm -it ghcr.io/astral-sh/uv:debian uv --help
3131
The following distroless images are available:
3232

3333
- `ghcr.io/astral-sh/uv:latest`
34-
- `ghcr.io/astral-sh/uv:{major}.{minor}.{patch}`, e.g., `ghcr.io/astral-sh/uv:0.8.3`
34+
- `ghcr.io/astral-sh/uv:{major}.{minor}.{patch}`, e.g., `ghcr.io/astral-sh/uv:0.8.5`
3535
- `ghcr.io/astral-sh/uv:{major}.{minor}`, e.g., `ghcr.io/astral-sh/uv:0.8` (the latest patch
3636
version)
3737

@@ -75,7 +75,7 @@ And the following derived images are available:
7575

7676
As with the distroless image, each derived image is published with uv version tags as
7777
`ghcr.io/astral-sh/uv:{major}.{minor}.{patch}-{base}` and
78-
`ghcr.io/astral-sh/uv:{major}.{minor}-{base}`, e.g., `ghcr.io/astral-sh/uv:0.8.3-alpine`.
78+
`ghcr.io/astral-sh/uv:{major}.{minor}-{base}`, e.g., `ghcr.io/astral-sh/uv:0.8.5-alpine`.
7979

8080
In addition, starting with `0.8` each derived image also sets `UV_TOOL_BIN_DIR` to `/usr/local/bin`
8181
to allow `uv tool install` to work as expected with the default user.
@@ -116,7 +116,7 @@ Note this requires `curl` to be available.
116116
In either case, it is best practice to pin to a specific uv version, e.g., with:
117117

118118
```dockerfile
119-
COPY --from=ghcr.io/astral-sh/uv:0.8.3 /uv /uvx /bin/
119+
COPY --from=ghcr.io/astral-sh/uv:0.8.5 /uv /uvx /bin/
120120
```
121121

122122
!!! tip
@@ -134,7 +134,7 @@ COPY --from=ghcr.io/astral-sh/uv:0.8.3 /uv /uvx /bin/
134134
Or, with the installer:
135135

136136
```dockerfile
137-
ADD https://astral.sh/uv/0.8.3/install.sh /uv-installer.sh
137+
ADD https://astral.sh/uv/0.8.5/install.sh /uv-installer.sh
138138
```
139139

140140
### Installing a project
@@ -560,5 +560,5 @@ Verified OK
560560
!!! tip
561561

562562
These examples use `latest`, but best practice is to verify the attestation for a specific
563-
version tag, e.g., `ghcr.io/astral-sh/uv:0.8.3`, or (even better) the specific image digest,
563+
version tag, e.g., `ghcr.io/astral-sh/uv:0.8.5`, or (even better) the specific image digest,
564564
such as `ghcr.io/astral-sh/uv:0.5.27@sha256:5adf09a5a526f380237408032a9308000d14d5947eafa687ad6c6a2476787b4f`.

src/assets/uv/guides/integration/github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
uses: astral-sh/setup-uv@v6
4848
with:
4949
# Install a specific version of uv.
50-
version: "0.8.3"
50+
version: "0.8.5"
5151
```
5252
5353
## Setting up Python

src/assets/uv/guides/integration/pre-commit.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To make sure your `uv.lock` file is up to date even if your `pyproject.toml` fil
1919
repos:
2020
- repo: https://github.com/astral-sh/uv-pre-commit
2121
# uv version.
22-
rev: 0.8.3
22+
rev: 0.8.5
2323
hooks:
2424
- id: uv-lock
2525
```
@@ -30,7 +30,7 @@ To keep a `requirements.txt` file in sync with your `uv.lock` file:
3030
repos:
3131
- repo: https://github.com/astral-sh/uv-pre-commit
3232
# uv version.
33-
rev: 0.8.3
33+
rev: 0.8.5
3434
hooks:
3535
- id: uv-export
3636
```
@@ -41,7 +41,7 @@ To compile requirements files:
4141
repos:
4242
- repo: https://github.com/astral-sh/uv-pre-commit
4343
# uv version.
44-
rev: 0.8.3
44+
rev: 0.8.5
4545
hooks:
4646
# Compile requirements
4747
- id: pip-compile
@@ -54,7 +54,7 @@ To compile alternative requirements files, modify `args` and `files`:
5454
repos:
5555
- repo: https://github.com/astral-sh/uv-pre-commit
5656
# uv version.
57-
rev: 0.8.3
57+
rev: 0.8.5
5858
hooks:
5959
# Compile requirements
6060
- id: pip-compile
@@ -68,7 +68,7 @@ To run the hook over multiple files at the same time, add additional entries:
6868
repos:
6969
- repo: https://github.com/astral-sh/uv-pre-commit
7070
# uv version.
71-
rev: 0.8.3
71+
rev: 0.8.5
7272
hooks:
7373
# Compile requirements
7474
- id: pip-compile

0 commit comments

Comments
 (0)