Skip to content

Commit

Permalink
docs: Update uv information
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Sep 12, 2024
1 parent 831ac51 commit 6af526e
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/guide/contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 13 additions & 2 deletions docs/guide/contributors/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<div class="result" markdown>

See [Installation methods](https://docs.astral.sh/uv/getting-started/installation/).

</div>

=== ":simple-python: pip"
```bash
Expand Down Expand Up @@ -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

Expand Down
17 changes: 14 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ TIP: **[Griffe Insiders](insiders/index.md), a version with [*more features*](in

</div>

=== ":simple-ruff: uv"
=== ":simple-astral: uv"
```bash
uv pip install griffe
uv add griffe
```

<div class="result" markdown>

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

</div>

Expand Down Expand Up @@ -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.

</div>

=== ":simple-astral: uv"
```bash
uv tool install griffe
```

<div class="result" markdown>

[uv](https://docs.astral.sh/uv/) is an extremely fast Python package and project manager, written in Rust.

</div>

0 comments on commit 6af526e

Please sign in to comment.