mirror of
https://github.com/astral-sh/uv.git
synced 2025-07-07 21:35:00 +00:00
e61a221fef
## Summary We want to have consistency between the Ruff and uv documentation for the upcoming release. We don't love the Ruff docs, but we'd rather have consistency and then work towards improving them both, rather than have two very-different documentation sites that both have weaknesses. The setup here is simpler than in Ruff as: (1) we don't yet generate any docs from Rust and (2) we don't try to reuse the README in the uv documentation (which adds a lot of complexity in Ruff). So the change here is mostly a 1-to-1 port to MkDocs. ## Test Plan 
73 lines
3.2 KiB
Markdown
73 lines
3.2 KiB
Markdown
[](https://github.com/astral-sh/uv)
|
|
[](https://pypi.python.org/pypi/uv)
|
|
[](https://pypi.python.org/pypi/uv)
|
|
[](https://pypi.python.org/pypi/uv)
|
|
[](https://github.com/astral-sh/uv/actions)
|
|
[](https://discord.gg/astral-sh)
|
|
|
|
An extremely fast Python package installer and resolver, written in Rust. Designed as a drop-in
|
|
replacement for common `pip` and `pip-tools` workflows.
|
|
|
|
<p align="center">
|
|
<img alt="Shows a bar chart with benchmark results." src="{URL_LIGHT}#only-light">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img alt="Shows a bar chart with benchmark results." src="{URL_DARK}#only-dark">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<i>Installing the Trio dependencies with a warm cache.</i>
|
|
</p>
|
|
|
|
## Highlights
|
|
|
|
- ⚖️ Drop-in replacement for common `pip`, `pip-tools`, and `virtualenv` commands.
|
|
- ⚡️ [10-100x faster](https://github.com/astral-sh/uv/blob/main/BENCHMARKS.md) than `pip`
|
|
and `pip-tools` (`pip-compile` and `pip-sync`).
|
|
- 💾 Disk-space efficient, with a global cache for dependency deduplication.
|
|
- 🐍 Installable via `curl`, `pip`, `pipx`, etc. uv is a static binary that can be installed
|
|
without Rust or Python.
|
|
- 🧪 Tested at-scale against the top 10,000 PyPI packages.
|
|
- 🖥️ Support for macOS, Linux, and Windows.
|
|
- 🧰 Advanced features such as dependency version overrides, multi-platform resolutions, reproducible resolutions,
|
|
alternative resolution strategies, and more.
|
|
- ⁉️ Best-in-class error messages with a conflict-tracking resolver.
|
|
- 🤝 Support for a wide range of advanced `pip` features, including editable installs, Git
|
|
dependencies, direct URL dependencies, local dependencies, constraints, source distributions,
|
|
HTML and JSON indexes, and more.
|
|
|
|
uv is backed by [Astral](https://astral.sh), the creators of [Ruff](https://github.com/astral-sh/ruff).
|
|
|
|
## Getting started
|
|
|
|
Install uv with our official standalone installer:
|
|
|
|
```bash
|
|
# On macOS and Linux.
|
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
|
|
# On Windows.
|
|
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
|
|
```
|
|
|
|
Or, see our [installation guide](./installation.md) for more options.
|
|
|
|
Then, check out our documentation [creating an environment](pip/environments.md).
|
|
|
|
## Features
|
|
|
|
uv supports features familiar from `pip` and `pip-tools`:
|
|
|
|
- [Managing Python environments](pip/environments.md)
|
|
- [Installing packages](pip/packages.md)
|
|
- [Inspecting packages](pip/inspection.md)
|
|
- [Locking environments](pip/compile.md)
|
|
|
|
uv also supports many advanced features:
|
|
|
|
- [Multi-platform resolution](./resolution.md#multi-platform-resolution)
|
|
- [Dependency overrides](./resolution.md#dependency-overrides)
|
|
- [Reproducible resolutions](./resolution.md#time-restricted-reproducible-resolutions)
|
|
- [Resolution strategies for multiple indexes](./resolution.md#resolution-strategy)
|
|
- [Dependency caching](./cache.md#dependency-caching)
|