Skip to content

Commit 0cdb5e9

Browse files
authored
Mention uv for the initial install in CONTRIBUTING.md (#13595)
1 parent 01ed309 commit 0cdb5e9

File tree

1 file changed

+55
-25
lines changed

1 file changed

+55
-25
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -50,37 +50,67 @@ please refer to this
5050

5151
Note that some tests require extra setup steps to install the required dependencies.
5252

53-
### Linux/Mac OS/WSL
53+
<table>
54+
<tr>
55+
<td>Linux / macOS / WSL</td>
56+
<td>
57+
58+
On Linux and macOS, you will be able to run the full test suite on Python
59+
3.9-3.12.
60+
To install the necessary requirements, run the following commands from a
61+
terminal window:
62+
63+
```bash
64+
$ python3 -m venv .venv
65+
$ source .venv/bin/activate
66+
(.venv)$ pip install -U pip
67+
(.venv)$ pip install -r requirements-tests.txt
68+
```
69+
70+
</td>
71+
</tr>
72+
<tr><!-- disables zebra striping --></tr>
73+
<tr>
74+
<td>Windows</td>
75+
<td>
76+
77+
Run the following commands from a Windows terminal to install all requirements:
78+
79+
```powershell
80+
> python -m venv .venv
81+
> .venv\Scripts\activate
82+
(.venv) > pip install -U pip
83+
(.venv) > pip install -r requirements-tests.txt
84+
```
85+
86+
To be able to run pytype tests, you'll also need to install it manually
87+
as it's currently excluded from the requirements file:
5488

55-
On Linux and Mac OS, you will be able to run the full test suite on Python
56-
3.9-3.12.
57-
To install the necessary requirements, run the following commands from a
58-
terminal window:
89+
```powershell
90+
(.venv) > pip install -U pytype
91+
```
5992

60-
```bash
61-
$ python3 -m venv .venv
62-
$ source .venv/bin/activate
63-
(.venv)$ pip install -U pip
64-
(.venv)$ pip install -r requirements-tests.txt
65-
```
93+
</td>
94+
</tr>
95+
<tr><!-- disables zebra striping --></tr>
96+
<tr>
97+
<td>Using uv</td>
98+
<td>
6699

67-
### Windows
100+
If you already have [uv](https://docs.astral.sh/uv/getting-started/installation/) installed, you can simply replace the commands above with:
68101

69-
Run the following commands from a Windows terminal to install all requirements:
102+
```shell
103+
uv venv
104+
uv pip install -r requirements-tests.txt
105+
```
70106

71-
```powershell
72-
> python -m venv .venv
73-
> .venv\Scripts\activate
74-
(.venv) > pip install -U pip
75-
(.venv) > pip install -r "requirements-tests.txt"
76-
```
107+
```shell
108+
uv pip install -U pytype
109+
```
77110

78-
To be able to run pytype tests, you'll also need to install it manually
79-
as it's currently excluded from the requirements file:
80-
81-
```powershell
82-
(.venv) > pip install -U pytype
83-
```
111+
</td>
112+
</tr>
113+
</table>
84114

85115
## Code formatting
86116

0 commit comments

Comments
 (0)