Skip to content

Commit da70fa4

Browse files
committed
Use uv
1 parent d45c1ee commit da70fa4

File tree

5 files changed

+30
-12
lines changed

5 files changed

+30
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI:
120120

121121
```shell
122122
# With uv.
123-
uv add --dev ruff # to add ruff to your project
124-
uv tool install ruff # to install ruff globally
123+
uv tool install ruff # Install Ruff globally.
124+
uv add --dev ruff # Or add Ruff to your project.
125125

126126
# With pip.
127127
pip install ruff

docs/faq.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -220,15 +220,18 @@ Ruff is installable under any Python version from 3.7 onwards.
220220

221221
## Do I need to install Rust to use Ruff?
222222

223-
Nope! Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI:
223+
Nope! Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI. We recommend installing Ruff with [uv](https://docs.astral.sh/uv/):
224224

225225
```console
226-
# With uv.
227-
$ uv add --dev ruff # to add ruff to your project
228-
$ uv tool install ruff # to install ruff globally
226+
$ # With uv.
227+
$ uv tool install ruff # Install Ruff globally.
228+
$ uv add --dev ruff # Or add Ruff to your project.
229229

230-
# With pip
230+
$ # With pip.
231231
$ pip install ruff
232+
233+
$ # With pipx.
234+
$ pipx install ruff
232235
```
233236

234237
Ruff ships with wheels for all major platforms, which enables `pip` to install Ruff without relying

docs/installation.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# Installing Ruff
22

3-
Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI:
3+
Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI. We recommend installing Ruff with [uv](https://docs.astral.sh/uv/):
44

55
```console
6+
$ # With uv.
7+
$ uv tool install ruff
8+
9+
$ # With pip.
610
$ pip install ruff
11+
12+
$ # With pipx.
13+
$ pipx install ruff
714
```
815

916
Once installed, you can run Ruff from the command line:
@@ -13,7 +20,7 @@ $ ruff check # Lint all files in the current directory.
1320
$ ruff format # Format all files in the current directory.
1421
```
1522

16-
Starting with version `0.5.0`, Ruff can be installed with our standalone installers:
23+
Starting with version `0.5.0`, Ruff can also be installed with our standalone installers:
1724

1825
```console
1926
$ # On macOS and Linux.

docs/tutorial.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,18 @@ your project. For a more detailed overview, see [_Configuring Ruff_](configurati
55

66
## Getting Started
77

8-
To start, we'll install Ruff through PyPI (or with your [preferred package manager](installation.md)):
8+
To start, we'll install Ruff from PyPI. You can install Ruff with [uv](https://docs.astral.sh/uv/), or
9+
your [preferred package manager](installation.md):
910

1011
```console
12+
$ # With uv.
13+
$ uv tool install ruff
14+
15+
$ # With pip.
1116
$ pip install ruff
17+
18+
$ # With pipx.
19+
$ pipx install ruff
1220
```
1321

1422
Let's then assume that our project structure looks like:

python/ruff-ecosystem/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Compare lint and format results for two different ruff versions (e.g. main and a
44

55
## Installation
66

7-
From the Ruff project root, install with `pip`:
7+
From the Ruff project root, install with [uv](https://docs.astral.sh/uv/):
88

99
```shell
10-
pip install -e ./python/ruff-ecosystem
10+
uv tool install -e ./python/ruff-ecosystem
1111
```
1212

1313
## Usage

0 commit comments

Comments
 (0)