Skip to content

Commit aec873c

Browse files
KemingHegithub-actions[bot]
authored andcommitted
docs(src/assets/): update uv official documentation
1 parent cc90c00 commit aec873c

File tree

13 files changed

+192
-53
lines changed

13 files changed

+192
-53
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-10-28T22:05:37Z",
5-
"commit_sha": "61c67bebcbd21d7900e6ce511107287a078cb29c"
4+
"updated_at": "2025-11-04T22:05:25Z",
5+
"commit_sha": "148b694b6b1607042d4c267ae339e9ad93866499"
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.9.5,<0.10.0"]
34+
requires = ["uv_build>=0.9.7,<0.10.0"]
3535
build-backend = "uv_build"
3636
```
3737

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

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

113113
[build-system]
114-
requires = ["uv_build>=0.9.5,<0.10.0"]
114+
requires = ["uv_build>=0.9.7,<0.10.0"]
115115
build-backend = "uv_build"
116116
```
117117

@@ -134,7 +134,7 @@ dependencies = []
134134
example-pkg = "example_pkg:main"
135135

136136
[build-system]
137-
requires = ["uv_build>=0.9.5,<0.10.0"]
137+
requires = ["uv_build>=0.9.7,<0.10.0"]
138138
build-backend = "uv_build"
139139
```
140140

@@ -195,7 +195,7 @@ requires-python = ">=3.11"
195195
dependencies = []
196196

197197
[build-system]
198-
requires = ["uv_build>=0.9.5,<0.10.0"]
198+
requires = ["uv_build>=0.9.7,<0.10.0"]
199199
build-backend = "uv_build"
200200
```
201201

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

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

7777
[build-system]
78-
requires = ["uv_build>=0.9.5,<0.10.0"]
78+
requires = ["uv_build>=0.9.7,<0.10.0"]
7979
build-backend = "uv_build"
8080
```
8181

@@ -106,7 +106,7 @@ tqdm = { git = "https://github.com/tqdm/tqdm" }
106106
members = ["packages/*"]
107107

108108
[build-system]
109-
requires = ["uv_build>=0.9.5,<0.10.0"]
109+
requires = ["uv_build>=0.9.7,<0.10.0"]
110110
build-backend = "uv_build"
111111
```
112112

@@ -188,7 +188,7 @@ dependencies = ["bird-feeder", "tqdm>=4,<5"]
188188
bird-feeder = { path = "packages/bird-feeder" }
189189

190190
[build-system]
191-
requires = ["uv_build>=0.9.5,<0.10.0"]
191+
requires = ["uv_build>=0.9.7,<0.10.0"]
192192
build-backend = "uv_build"
193193
```
194194

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

Lines changed: 2 additions & 2 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.9.5/install.sh | sh
28+
$ curl -LsSf https://astral.sh/uv/0.9.7/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.9.5/install.ps1 | iex"
44+
PS> powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/0.9.7/install.ps1 | iex"
4545
```
4646

4747
!!! tip

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.9.5 AS uv
95+
FROM ghcr.io/astral-sh/uv:0.9.7 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.9.5 AS uv
337+
FROM ghcr.io/astral-sh/uv:0.9.7 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.9.5`
34+
- `ghcr.io/astral-sh/uv:{major}.{minor}.{patch}`, e.g., `ghcr.io/astral-sh/uv:0.9.7`
3535
- `ghcr.io/astral-sh/uv:{major}.{minor}`, e.g., `ghcr.io/astral-sh/uv:0.8` (the latest patch
3636
version)
3737

@@ -95,7 +95,7 @@ And the following derived images are available:
9595

9696
As with the distroless image, each derived image is published with uv version tags as
9797
`ghcr.io/astral-sh/uv:{major}.{minor}.{patch}-{base}` and
98-
`ghcr.io/astral-sh/uv:{major}.{minor}-{base}`, e.g., `ghcr.io/astral-sh/uv:0.9.5-alpine`.
98+
`ghcr.io/astral-sh/uv:{major}.{minor}-{base}`, e.g., `ghcr.io/astral-sh/uv:0.9.7-alpine`.
9999

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

138138
```dockerfile
139-
COPY --from=ghcr.io/astral-sh/uv:0.9.5 /uv /uvx /bin/
139+
COPY --from=ghcr.io/astral-sh/uv:0.9.7 /uv /uvx /bin/
140140
```
141141

142142
!!! tip
@@ -154,7 +154,7 @@ COPY --from=ghcr.io/astral-sh/uv:0.9.5 /uv /uvx /bin/
154154
Or, with the installer:
155155

156156
```dockerfile
157-
ADD https://astral.sh/uv/0.9.5/install.sh /uv-installer.sh
157+
ADD https://astral.sh/uv/0.9.7/install.sh /uv-installer.sh
158158
```
159159

160160
### Installing a project
@@ -590,5 +590,5 @@ Verified OK
590590
!!! tip
591591

592592
These examples use `latest`, but best practice is to verify the attestation for a specific
593-
version tag, e.g., `ghcr.io/astral-sh/uv:0.9.5`, or (even better) the specific image digest,
593+
version tag, e.g., `ghcr.io/astral-sh/uv:0.9.7`, or (even better) the specific image digest,
594594
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.9.5"
50+
version: "0.9.7"
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.9.5
22+
rev: 0.9.7
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.9.5
33+
rev: 0.9.7
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.9.5
44+
rev: 0.9.7
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.9.5
57+
rev: 0.9.7
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.9.5
71+
rev: 0.9.7
7272
hooks:
7373
# Compile requirements
7474
- id: pip-compile

src/assets/uv/pip/compatibility.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,3 +489,25 @@ the file. For example, a wheel named `foo-1.0.0-py3-none-any.whl` that contains
489489
the version is `1.0.1` will be rejected by uv, but accepted by pip.
490490

491491
To force uv to accept such wheels, set `UV_SKIP_WHEEL_FILENAME_CHECK=1` in the environment.
492+
493+
## Package name normalization
494+
495+
By default, uv normalizes package names to match their
496+
[PEP 503-compliant forms](https://packaging.python.org/en/latest/specifications/name-normalization/#name-normalization)
497+
and uses those normalized names in all output contexts. This differs from pip, which tends to
498+
preserve the verbatim package name as published on the registry.
499+
500+
For example, `uv pip list` displays normalized packages names (e.g., `docstring-parser`), while
501+
`pip list` displays non-normalized package names (e.g., `docstring_parser`):
502+
503+
```shell
504+
(venv) $ diff --side-by-side <(pip list) <(uv pip list)
505+
Package Version Package Version
506+
---------------- ------- ---------------- -------
507+
docstring_parser 0.16 | docstring-parser 0.16
508+
jaraco.classes 3.4.0 | jaraco-classes 3.4.0
509+
more-itertools 10.7.0 more-itertools 10.7.0
510+
pip 25.1 pip 25.1
511+
PyMuPDFb 1.24.10 | pymupdfb 1.24.10
512+
PyPDF2 3.0.1 | pypdf2 3.0.1
513+
```

0 commit comments

Comments
 (0)