From 6af526ea82641e527edc23c19743727f849824b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Thu, 12 Sep 2024 12:46:23 +0200 Subject: [PATCH] docs: Update uv information --- docs/guide/contributors.md | 2 +- docs/guide/contributors/setup.md | 15 +++++++++++++-- docs/installation.md | 17 ++++++++++++++--- 3 files changed, 28 insertions(+), 6 deletions(-) diff --git a/docs/guide/contributors.md b/docs/guide/contributors.md index c59ea37e..d5a4d2c4 100644 --- a/docs/guide/contributors.md +++ b/docs/guide/contributors.md @@ -14,7 +14,7 @@ If you are unsure about what to contribute to, you can check out [our issue trac ## TL;DR -- Install [Python](https://www.python.org/), [uv](https://github.com/astral-sh/uv) and [direnv](https://direnv.net/) +- Install [Python](https://www.python.org/), [uv](https://docs.astral.sh/uv/) and [direnv](https://direnv.net/) - Fork, clone, and enter repository - Run `direnv allow` and `make setup` - Checkout a new branch diff --git a/docs/guide/contributors/setup.md b/docs/guide/contributors/setup.md index 83bac266..60337f0d 100644 --- a/docs/guide/contributors/setup.md +++ b/docs/guide/contributors/setup.md @@ -4,7 +4,18 @@ To work on the project, whether to update the code or the documentation, you wil ## Requirements -The only requirement is that you have [Python](https://www.python.org/) and [uv](https://github.com/astral-sh/uv) installed and available on your command line path. +The only requirement is that you have [Python](https://www.python.org/) and [uv](https://docs.astral.sh/uv/) installed and available on your command line path. + +=== ":simple-astral: official installer" + ```bash + curl -LsSf https://astral.sh/uv/install.sh | sh + ``` + +
+ + See [Installation methods](https://docs.astral.sh/uv/getting-started/installation/). + +
=== ":simple-python: pip" ```bash @@ -89,7 +100,7 @@ If you installed [direnv](https://direnv.net/): If you didn't install [direnv](https://direnv.net/), just run `./scripts/make setup`. -The setup command will install all the Python dependencies required to work on the project. This command will create a virtual environment in the `.venv` folder, as well as one virtual environment per supported Python version in the `.venvs/3.x` folders. If you cloned the repository on the same file-system as [uv](https://github.com/astral-sh/uv)'s cache, everything will be hard linked from the cache, so don't worry about wasting disk space. +The setup command will install all the Python dependencies required to work on the project. This command will create a virtual environment in the `.venv` folder, as well as one virtual environment per supported Python version in the `.venvs/3.x` folders. If you cloned the repository on the same file-system as [uv](https://docs.astral.sh/uv/)'s cache, everything will be hard linked from the cache, so don't worry about wasting disk space. ## IDE setup diff --git a/docs/installation.md b/docs/installation.md index 266a3bd8..cc52c17a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -50,14 +50,14 @@ TIP: **[Griffe Insiders](insiders/index.md), a version with [*more features*](in -=== ":simple-ruff: uv" +=== ":simple-astral: uv" ```bash - uv pip install griffe + uv add griffe ```
- [uv](https://github.com/astral-sh/uv) is an ultra fast dependency resolver and package installer, written in Rust. + [uv](https://docs.astral.sh/uv/) is an extremely fast Python package and project manager, written in Rust.
@@ -95,3 +95,14 @@ TIP: **[Griffe Insiders](insiders/index.md), a version with [*more features*](in [Rye](https://rye.astral.sh/) is an all-in-one solution for Python project management, written in Rust. + +=== ":simple-astral: uv" + ```bash + uv tool install griffe + ``` + +
+ + [uv](https://docs.astral.sh/uv/) is an extremely fast Python package and project manager, written in Rust. + +