uv/docs/guides/publish.md
2024-08-07 08:25:26 -05:00

1.5 KiB

Publishing a package

uv does not yet have dedicated commands for building and publishing a package. Instead, you can use the PyPA tools build and twine, both of which can be invoked via uvx.

Building your package

Build your package with the official build frontend:

$ uvx --from build pyproject-build --installer uv

!!! note

Using `--installer uv` is not required, but uses uv instead of the default, pip, for faster
builds.

The build artifacts will be placed in dist/.

Publishing your package

Publish your package with twine:

$ uvx twine upload dist/*

!!! tip

To provide credentials, use the `TWINE_USERNAME` and `TWINE_PASSWORD` environment variables.

Installing your package

Test that the package can be installed and imported with uv run:

$ uv run --with <PACKAGE> --no-project -- python -c "import <PACKAGE>"

The --no-project flag is used to avoid installing the package from your local project directory.

!!! tip

If you have recently installed the package, you may need to include the
`--refresh-package <PACKAGE>` option to avoid using a cached version of the package.

Next steps

To learn more about publishing packages, check out the PyPA guides on building and publishing.

Or, read on for more details about the concepts in uv.