Skip to content

Commit 94e5a2f

Browse files
VishnuR23claude
andauthored
DOC: correct the .python-version claim in the contributor install guide (#2407)
Co-authored-by: VishnuR23 <19866703+VishnuR23@users.noreply.github.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 78739f0 commit 94e5a2f

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

doc/getting_started/install_local_dev.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ Set up a PyRIT development environment on your local machine.
3333
wget -qO- https://astral.sh/uv/install.sh | sh
3434
```
3535

36-
2. **Python 3.12**: uv will automatically download and use the correct Python version based on `.python-version`
36+
2. **Python 3.10-3.14**: PyRIT supports these versions, and CI tests all of them. The repository does
37+
not pin an interpreter, so `uv` selects a compatible one for you (downloading it if needed).
3738

3839
3. **Git**. Git is required to clone the repo locally. It is available to download [here](https://git-scm.com/downloads).
3940
```bash
@@ -46,19 +47,22 @@ Set up a PyRIT development environment on your local machine.
4647
4748
1. Navigate to the directory where you cloned the PyRIT repo.
4849
49-
2. The repository includes a `.python-version` file that pins Python 3.12. Run:
50+
2. From the root of your clone, run:
5051
5152
```bash
5253
uv sync
5354
```
5455
5556
This command will:
5657
- Create a `.venv` directory with a virtual environment
57-
- Install Python 3.12 if not already available
58+
- Download a supported Python version if none is already available
5859
- Install PyRIT in editable mode; `uv sync` by default installs in editable mode so no extra flag is necessary
5960
- Install all dependencies including dev tools (pytest, ruff, etc.) via the `dev` dependency group
6061
- Create a `uv.lock` file for reproducible builds
6162
63+
To pin your checkout to a single version, run `uv python pin 3.12`. That writes a
64+
`.python-version` file, which is local to your working copy and not tracked by the repository.
65+
6266
6367
3. Verify Installation
6468

0 commit comments

Comments
 (0)