Skip to content

uv-Main

uv

uvimageimageimageActions statusDiscord

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

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"

With pip.

pip install uv
  • or pipx
pipx install uv

Standalone Installer

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

uv self update

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

Documentation⚓︎

uv's documentation is available at uv Docs

Tip

  • uv may also be installed with pip, Homebrew, and more. See all of the methods on the installation page
uv manages Project Dependencies and Environments
  • 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.4

$ 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

Features⚓︎

Projects⚓︎

uv manages Project Dependencies and Environments(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
  • uv also supports building and publishing projects, even if they're not managed with uv. See the publish guide to learn more.

Scripts⚓︎

Manages deps & envs for Single-file 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]>

Tools⚓︎

uv similar to pipx

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

    ------------
  < What the hell! >
    ------------
      \   ^__^
       \  (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 Allows Switching Between 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`

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.

Platform-independent requirements.

  • 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.

Scripts⚓︎

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`

Versioning Policy⚓︎

Versioning Policy

See uv's versioning policy document.

Contributing⚓︎

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?⚓︎

How do you pronounce uv?

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

How should I stylize uv?⚓︎

How should I stylize uv?

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

Acknowledgements⚓︎

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⚓︎

License

uv is licensed under either of - Apache License, Version 2.0, LICENSE-APACHE.

MIT license LICENSE-MIT.

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.

Mercurial⚓︎

Install Mercurial

apt install mercurial

dnf install mercurial

pacman -S mercurial

emerge mercurial

brew install mercurial

Binary packages can be installed using pkg:

pkg install mercurial

Alternatively, you can install from source via the ports collection:

cd /usr/ports/devel/mercurial
make install

Using the winget package manager:

winget install Mercurial.Mercurial -e

Or download from the list of binary releases.

Using the winget package manager:

winget install TortoiseHg.TortoiseHg -e

Or download from the list of binary releases.

Git⚓︎

Git

$ apt install git

$ dnf install git
Install uv⚓︎

Install uv

$ curl -LsSf astral.sh | sh

PS> powershell -ExecutionPolicy ByPass -c "irm astral.sh | iex"