Skip to content

Commit

Permalink
packaging documentation: add notes on how to install created dist wheel
Browse files Browse the repository at this point in the history
* Seems like users should test the built distribution prior to uploading
  to pypi
* Provides quick instructions to install the wheel for use in running
  tests
  • Loading branch information
clintonsteiner committed Mar 6, 2025
1 parent 40dce4e commit 217c421
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/concepts/projects/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,23 @@ You can limit `uv build` to building a source distribution with `uv build --sdis
distribution with `uv build --wheel`, or build both distributions from source with
`uv build --sdist --wheel`.

## Install and test the created dist wheel

Create a venv

```console
$ uv venv
$ uv pip install dist/package.whl
```

Validate source of module

```console
$ uv pip show package
```

uv will now use the wheel version of the package - since the dependency is satisfied

## Build constraints

`uv build` accepts `--build-constraint`, which can be used to constrain the versions of any build
Expand Down

0 comments on commit 217c421

Please sign in to comment.