An extremely fast Python package and project manager, written in Rust.
Find a file
konsti 7316bd01a3
Build backend: Support namespace packages (#13833)
Unlike regular packages, specifying all `__init__.py` directories for a
namespace package would be very verbose There is e.g.
https://github.com/python-poetry/poetry/tree/main/src/poetry, which has
18 modules, or https://github.com/googleapis/api-common-protos which is
inconsistently nested. For both the Google Cloud SDK, there are both
packages with a single module and those with complex structures, with
many having multiple modules due to versioning through `<module>_v1`
versioning. The Azure SDK seems to use one module per package (it's not
explicitly documented but seems to follow from the process in
https://azure.github.io/azure-sdk/python_design.html#azure-sdk-distribution-packages
and
ccb0e03a3d/doc/dev/packaging.md).

For simplicity with complex projects, we add a `namespace = true` switch
which disabled checking for an `__init__.py`. We only check that there's
no `<module_root>/<module_name>/__init__.py` and otherwise add the whole
`<module_root>/<module_name>` folder. This comes at the cost of
`namespace = true` effectively creating an opt-out from our usual checks
that allows creating an almost entirely arbitrary package.

For simple projects with only a single module, the module name can be
dotted to point to the target module, so the build still gets checked:

```toml
[tool.uv.build-backend]
module-name = "poetry.core"
```

## Alternatives

### Declare all packages

We could make `module-name` a list and allow or require declaring all
packages:

```toml
[tool.uv.build-backend]
module-name = ["cloud_sdk.service.storage", "cloud_sdk.service.storage_v1", "cloud_sdk.billing.storage"]
```

Or for Poetry:

```toml
[tool.uv.build-backend]
module-name = [
    "poetry.config",
    "poetry.console",
    "poetry.inspection",
    "poetry.installation",
    "poetry.json",
    "poetry.layouts",
    "poetry.masonry",
    "poetry.mixology",
    "poetry.packages",
    "poetry.plugins",
    "poetry.publishing",
    "poetry.puzzle",
    "poetry.pyproject",
    "poetry.repositories",
    "poetry.toml",
    "poetry.utils",
    "poetry.vcs",
    "poetry.version"
]
```

### Support multiple namespaces

We could also allow namespace packages with multiple root level module:

```toml
[tool.uv.build-backend]
module-name = ["cloud_sdk.my_ext", "local_sdk.my_ext"]
```

For lack of use cases, we delegate this to creating a workspace with one
package per module.

## Implementation

Due to the more complex options for the module name, I'm moving
verification on deserialization later, dropping the source span we'd get
from serde. We also don't show similarly named directories anymore.

---------

Co-authored-by: Andrew Gallant <andrew@astral.sh>
2025-06-12 17:23:58 +00:00
.cargo Don't build uv-dev by default (#6827) 2024-08-29 15:44:13 -04:00
.config Abort tests running for more than 60s to catch deadlocks (#3694) 2024-05-21 13:19:57 +00:00
.github build-binaries for riscv64 (#12688) 2025-06-10 11:18:28 -04:00
assets Add top-level benchmark to the README (#2622) 2024-03-22 16:07:31 -04:00
changelogs Remove the configuration section in favor of concepts / reference (#13842) 2025-06-05 17:09:49 +00:00
crates Build backend: Support namespace packages (#13833) 2025-06-12 17:23:58 +00:00
docs Build backend: Support namespace packages (#13833) 2025-06-12 17:23:58 +00:00
ecosystem Remove av pin in transformers (#13518) 2025-05-18 19:59:34 -04:00
python/uv A minimal build backend for uv: uv_build (#11446) 2025-03-06 13:27:20 -06:00
scripts Hint at tool.uv.required-environments (#13575) 2025-06-06 19:15:52 +00:00
.editorconfig Ignore UV_CACHE_DIR in help tests (#7895) 2024-10-04 09:41:25 -05:00
.gitattributes Mark .inc files as Rust for GitHub Linguist (#9890) 2024-12-13 22:17:23 +00:00
.gitignore Optimize Version display (#13643) 2025-05-26 15:17:07 +02:00
.ignore github: include /.github/ in ripgrep searches by default (#12243) 2025-03-17 12:13:49 -05:00
.pre-commit-config.yaml Update pre-commit dependencies (#13907) 2025-06-09 14:28:16 -04:00
.prettierignore Remove the configuration section in favor of concepts / reference (#13842) 2025-06-05 17:09:49 +00:00
.python-versions Update packse scenarios (#13688) 2025-05-28 08:58:38 -05:00
_typos.toml uv/tests: add new 'ecosystem' integration tests (#5970) 2024-08-13 09:48:00 -04:00
BENCHMARKS.md Update BENCHMARKS.md (#6258) 2024-08-20 16:42:57 +00:00
Cargo.lock Update Rust crate fs-err to v3.1.1 (#13910) 2025-06-09 14:29:12 -04:00
Cargo.toml Add zstd and deflate to Accept-Encoding (#13982) 2025-06-11 22:42:47 -04:00
CHANGELOG.md Fix extra newline in changelog (#13918) 2025-06-09 11:48:59 -05:00
clippy.toml Use fs_err for paths in symlinking errors (#13303) 2025-05-05 16:29:27 +00:00
CONTRIBUTING.md Update dockerfile path in contributing docs (#13751) 2025-06-02 08:16:20 +00:00
Dockerfile Explicitly install the rust toolchain before the target during Docker builds (#11936) 2025-03-03 17:17:56 -06:00
LICENSE-APACHE Update copyright year (#10297) 2025-01-04 18:31:36 +00:00
LICENSE-MIT Update copyright year (#10297) 2025-01-04 18:31:36 +00:00
mkdocs.insiders.yml Watch for changes to the template file during documentation serve (#9244) 2024-11-19 22:39:38 -06:00
mkdocs.public.yml Move content from the mkdocs.public.yml into the template (#11246) 2025-02-05 16:13:46 +00:00
mkdocs.template.yml Add an llms.txt to uv (#13929) 2025-06-10 07:46:49 -04:00
PIP_COMPATIBILITY.md Move pip compatibility guide to the documentation (#6213) 2024-08-20 11:31:46 -05:00
pyproject.toml Bump version to 0.7.12 (#13892) 2025-06-06 19:42:06 +00:00
README.md add pronunciation to README (#5336) 2025-05-27 16:11:54 +00:00
ruff.toml uv/tests: add new 'ecosystem' integration tests (#5970) 2024-08-13 09:48:00 -04:00
rust-toolchain.toml Bump version to 0.7.6 (#13537) 2025-05-19 19:46:11 -04:00
SECURITY.md Add CVE disclosure to security policy (#11037) 2025-01-28 14:36:53 -06:00
STYLE.md Improve and fix some documents (#8749) 2024-11-01 09:44:04 -04:00
uv.schema.json Build backend: Support namespace packages (#13833) 2025-06-12 17:23:58 +00:00

uv

uv image image image Actions status Discord

An extremely fast Python package and project manager, written in Rust.

Shows a bar chart with benchmark results.

Installing Trio's dependencies with a warm cache.

Highlights

uv is backed by Astral, the creators of Ruff.

Installation

Install uv with our standalone installers:

# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh
# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Or, from PyPI:

# With pip.
pip install uv
# Or pipx.
pipx install uv

If installed via the standalone installer, uv can update itself to the latest version:

uv self update

See the installation documentation for details and alternative installation methods.

Documentation

uv's documentation is available at docs.astral.sh/uv.

Additionally, the command line reference documentation can be viewed with uv help.

Features

Projects

uv manages project dependencies and environments, with support for lockfiles, workspaces, and more, similar to rye or poetry:

$ uv init example
Initialized project `example` at `/home/user/example`

$ cd example

$ uv add ruff
Creating virtual environment at: .venv
Resolved 2 packages in 170ms
   Built example @ file:///home/user/example
Prepared 2 packages in 627ms
Installed 2 packages in 1ms
 + example==0.1.0 (from file:///home/user/example)
 + ruff==0.5.0

$ uv run ruff check
All checks passed!

$ uv lock
Resolved 2 packages in 0.33ms

$ uv sync
Resolved 2 packages in 0.70ms
Audited 1 package in 0.02ms

See the project documentation to get started.

uv also supports building and publishing projects, even if they're not managed with uv. See the publish guide to learn more.

Scripts

uv manages dependencies and environments for single-file scripts.

Create a new script and add inline metadata declaring its dependencies:

$ echo 'import requests; print(requests.get("https://astral.sh"))' > example.py

$ uv add --script example.py requests
Updated `example.py`

Then, run the script in an isolated virtual environment:

$ uv run example.py
Reading inline script metadata from: example.py
Installed 5 packages in 12ms
<Response [200]>

See the scripts documentation to get started.

Tools

uv executes and installs command-line tools provided by Python packages, similar to pipx.

Run a tool in an ephemeral environment using uvx (an alias for uv tool run):

$ uvx pycowsay 'hello world!'
Resolved 1 package in 167ms
Installed 1 package in 9ms
 + pycowsay==0.0.0.2
  """

  ------------
< hello world! >
  ------------
   \   ^__^
    \  (oo)\_______
       (__)\       )\/\
           ||----w |
           ||     ||

Install a tool with uv tool install:

$ uv tool install ruff
Resolved 1 package in 6ms
Installed 1 package in 2ms
 + ruff==0.5.0
Installed 1 executable: ruff

$ ruff --version
ruff 0.5.0

See the tools documentation to get started.

Python versions

uv installs Python and allows quickly switching between versions.

Install multiple Python versions:

$ uv python install 3.10 3.11 3.12
Searching for Python versions matching: Python 3.10
Searching for Python versions matching: Python 3.11
Searching for Python versions matching: Python 3.12
Installed 3 versions in 3.42s
 + cpython-3.10.14-macos-aarch64-none
 + cpython-3.11.9-macos-aarch64-none
 + cpython-3.12.4-macos-aarch64-none

Download Python versions as needed:

$ uv venv --python 3.12.0
Using Python 3.12.0
Creating virtual environment at: .venv
Activate with: source .venv/bin/activate

$ uv run --python pypy@3.8 -- python --version
Python 3.8.16 (a9dbdca6fc3286b0addd2240f11d97d8e8de187a, Dec 29 2022, 11:45:30)
[PyPy 7.3.11 with GCC Apple LLVM 13.1.6 (clang-1316.0.21.2.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>>>

Use a specific Python version in the current directory:

$ uv python pin 3.11
Pinned `.python-version` to `3.11`

See the Python installation documentation to get started.

The pip interface

uv provides a drop-in replacement for common pip, pip-tools, and virtualenv commands.

uv extends their interfaces with advanced features, such as dependency version overrides, platform-independent resolutions, reproducible resolutions, alternative resolution strategies, and more.

Migrate to uv without changing your existing workflows — and experience a 10-100x speedup — with the uv pip interface.

Compile requirements into a platform-independent requirements file:

$ uv pip compile docs/requirements.in \
   --universal \
   --output-file docs/requirements.txt
Resolved 43 packages in 12ms

Create a virtual environment:

$ uv venv
Using Python 3.12.3
Creating virtual environment at: .venv
Activate with: source .venv/bin/activate

Install the locked requirements:

$ uv pip sync docs/requirements.txt
Resolved 43 packages in 11ms
Installed 43 packages in 208ms
 + babel==2.15.0
 + black==24.4.2
 + certifi==2024.7.4
 ...

See the pip interface documentation to get started.

Platform support

See uv's platform support document.

Versioning policy

See uv's versioning policy document.

Contributing

We are passionate about supporting contributors of all levels of experience and would love to see you get involved in the project. See the contributing guide to get started.

FAQ

How do you pronounce uv?

It's pronounced as "you - vee" (/juː viː/)

How should I stylize uv?

Just "uv", please. See the style guide for details.

Acknowledgements

uv's dependency resolver uses PubGrub under the hood. We're grateful to the PubGrub maintainers, especially Jacob Finkelman, for their support.

uv's Git implementation is based on Cargo.

Some of uv's optimizations are inspired by the great work we've seen in pnpm, Orogene, and Bun. We've also learned a lot from Nathaniel J. Smith's Posy and adapted its trampoline for Windows support.

License

uv is licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in uv by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any additional terms or conditions.