Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/astral-sh/uv

An extremely fast Python package and project manager, written in Rust.
https://github.com/astral-sh/uv

Last synced: 3 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/astral-sh/uv
Owner: astral-sh
License: apache-2.0
Created: 2023-10-02T20:24:11.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-10-29T08:36:46.000Z (about 1 month ago)
Last Synced: 2024-10-29T09:54:01.712Z (about 1 month ago)
Language: Rust
Homepage: https://docs.astral.sh/uv
Size: 44.2 MB
Stars: 24,584
Watchers: 51
Forks: 711
Open Issues: 941
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE

Awesome Lists containing this project

awesome-repositories - astral-sh/uv - An extremely fast Python package and project manager, written in Rust. (Rust)
jimsghstars - astral-sh/uv - An extremely fast Python package and project manager, written in Rust. (Rust)
awesome - astral-sh/uv - An extremely fast Python package and project manager, written in Rust. (Rust)

README

        # uv

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

[![image](https://img.shields.io/pypi/v/uv.svg)](https://pypi.python.org/pypi/uv)

[![image](https://img.shields.io/pypi/l/uv.svg)](https://pypi.python.org/pypi/uv)

[![image](https://img.shields.io/pypi/pyversions/uv.svg)](https://pypi.python.org/pypi/uv)

[![Actions status](https://github.com/astral-sh/uv/actions/workflows/ci.yml/badge.svg)](https://github.com/astral-sh/uv/actions)

[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.gg/astral-sh)

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



  

    

    

    

  





  Installing Trio's dependencies with a warm cache.



## Highlights

- 🚀 A single tool to replace `pip`, `pip-tools`, `pipx`, `poetry`, `pyenv`, `twine`, `virtualenv`,

  and more.

- ⚡️ [10-100x faster](https://github.com/astral-sh/uv/blob/main/BENCHMARKS.md) than `pip`.

- 🐍 [Installs and manages](#python-management) Python versions.

- 🛠️ [Runs and installs](#tool-management) Python applications.

- ❇️ [Runs single-file scripts](#script-support), with support for

  [inline dependency metadata](https://docs.astral.sh/uv/guides/scripts#declaring-script-dependencies).

- 🗂️ Provides [comprehensive project management](#project-management), with a

  [universal lockfile](https://docs.astral.sh/uv/concepts/projects#project-lockfile).

- 🔩 Includes a [pip-compatible interface](#a-pip-compatible-interface) for a performance boost with

  a familiar CLI.

- 🏢 Supports Cargo-style [workspaces](https://docs.astral.sh/uv/concepts/workspaces) for scalable

  projects.

- 💾 Disk-space efficient, with a [global cache](https://docs.astral.sh/uv/concepts/cache) for

  dependency deduplication.

- ⏬ Installable without Rust or Python via `curl` or `pip`.

- 🖥️ Supports macOS, Linux, and Windows.

uv is backed by [Astral](https://astral.sh), the creators of

[Ruff](https://github.com/astral-sh/ruff).

## Installation

Install uv with our standalone installers:

```bash

# On macOS and Linux.

curl -LsSf https://astral.sh/uv/install.sh | sh

```

```bash

# On Windows.

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

```

Or, from [PyPI](https://pypi.org/project/uv/):

```bash

# With pip.

pip install uv

```

```bash

# Or pipx.

pipx install uv

```

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

```bash

uv self update

```

See the [installation documentation](https://docs.astral.sh/uv/getting-started/installation/) for

details and alternative installation methods.

## Documentation

uv's documentation is available at [docs.astral.sh/uv](https://docs.astral.sh/uv).

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

## Features

### Project management

uv manages project dependencies and environments, with support for lockfiles, workspaces, and more,

similar to `rye` or `poetry`:

```console

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

$ uv run ruff check

All checks passed!

```

See the [project documentation](https://docs.astral.sh/uv/guides/projects/) to get started.

uv also supports building and publishing projects, even if they're not managed with uv. See the

[publish guide](https://docs.astral.sh/uv/guides/publish/) to learn more.

### Tool management

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`):

```console

$ 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`:

```console

$ uv tool install ruff

Resolved 1 package in 6ms

Installed 1 package in 2ms

 + ruff==0.5.7

Installed 1 executable: ruff

$ ruff --version

ruff 0.5.7

```

See the [tools documentation](https://docs.astral.sh/uv/guides/tools/) to get started.

### Python management

uv installs Python and allows quickly switching between versions.

Install multiple Python versions:

```console

$ 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:

```console

$ 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 [email protected] -- 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:

```console

$ uv python pin [email protected]

Pinned `.python-version` to `[email protected]`

```

See the [Python installation documentation](https://docs.astral.sh/uv/guides/install-python/) to get

started.

### Script support

uv manages dependencies and environments for single-file scripts.

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

```console

$ 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:

```console

$ uv run example.py

Reading inline script metadata from: example.py

Installed 5 packages in 12ms

```

See the [scripts documentation](https://docs.astral.sh/uv/guides/scripts/) to get started.

### A pip-compatible 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:

```console

$ uv pip compile docs/requirements.in \

   --universal \

   --output-file docs/requirements.txt

Resolved 43 packages in 12ms

```

Create a virtual environment:

```console

$ uv venv

Using Python 3.12.3

Creating virtual environment at: .venv

Activate with: source .venv/bin/activate

```

Install the locked requirements:

```console

$ 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](https://docs.astral.sh/uv/pip/index/) to get started.

## Platform support

See uv's [platform support](https://docs.astral.sh/uv/reference/platforms/) document.

## Versioning policy

See uv's [versioning policy](https://docs.astral.sh/uv/reference/versioning/) 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](https://github.com/astral-sh/uv/blob/main/CONTRIBUTING.md) to get started.

## Acknowledgements

uv's dependency resolver uses [PubGrub](https://github.com/pubgrub-rs/pubgrub) under the hood. We're

grateful to the PubGrub maintainers, especially [Jacob Finkelman](https://github.com/Eh2406), for

their support.

uv's Git implementation is based on [Cargo](https://github.com/rust-lang/cargo).

Some of uv's optimizations are inspired by the great work we've seen in [pnpm](https://pnpm.io/),

[Orogene](https://github.com/orogene/orogene), and [Bun](https://github.com/oven-sh/bun). We've also

learned a lot from Nathaniel J. Smith's [Posy](https://github.com/njsmith/posy) and adapted its

[trampoline](https://github.com/njsmith/posy/tree/main/src/trampolines/windows-trampolines/posy-trampoline)

for Windows support.

## License

uv is licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or

  )

- MIT license ([LICENSE-MIT](LICENSE-MIT) or )

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.