packaging documentation: add notes on how to install created dist wheel

* 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
This commit is contained in:
CJ Steiner 2025-03-06 07:48:31 -06:00
parent 40dce4e009
commit 217c421fb1

View file

@ -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