Skip to content

Commit 53852df

Browse files
henryiiigaborbernat
authored andcommitted
docs: uv example
Signed-off-by: Henry Schreiner <[email protected]>
1 parent b983371 commit 53852df

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ $ python -m build
2727
```
2828

2929
This will build the package in an isolated environment, generating a
30-
source-distribution and wheel in the directory `dist/`.
31-
See the [documentation](https://build.pypa.io) for full information.
30+
source-distribution and wheel in the directory `dist/`. See the
31+
[documentation](https://build.pypa.io) for full information. Build is also
32+
available via the command line as `pyproject-build` once installed.
3233

3334
### Common arguments
3435

@@ -58,12 +59,18 @@ $ pipx run build
5859

5960
#### uv
6061

61-
If you want to use [uv][] to speed up the virtual environment creation, you can use
62-
`--installer=uv`. You can get a Python wheel for `uv` with the `[uv]` extra.
63-
Combining both suggestions yields the following:
62+
If you want to use [uv][] to speed up the virtual environment creation, you can
63+
use `--installer=uv`. You can get a Python wheel for `uv` with the `[uv]`
64+
extra. For example, using pipx like above:
6465

6566
```console
66-
$ pipx run build[uv] --installer=uv
67+
$ pipx run 'build[uv]' --installer uv
68+
```
69+
70+
If you already have uv, you don't need the extra. For example:
71+
72+
```console
73+
$ uvx --from build pyproject-build --installer uv
6774
```
6875

6976
#### cibuildwheel

0 commit comments

Comments
 (0)