Skip to content

Commit 0dad78b

Browse files
authored
docs: clarify how to use tox (#1445)
1 parent 6a02efd commit 0dad78b

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,16 @@ It's people like *you* who make this project such a great tool for everyone.
4949

5050
First, **fork** the repository on GitHub and **clone** it using one of the alternatives that you can copy-paste by pressing the big green button labeled `<> Code`.
5151

52-
You can (and should) run our test suite using [*tox*](https://tox.wiki/).
52+
You can (and should) run our test suite using [*tox*](https://tox.wiki/) with the [*tox-uv*](https://github.com/tox-dev/tox-uv) plugin.
53+
The easiest way is to [install *uv*] which is needed in any case and then run `uv tool install --with tox-uv tox` to have it globally available or `uvx --with tox-uv tox` to use a temporary environment.
54+
55+
---
56+
5357
However, you'll probably want a more traditional environment as well.
5458

5559
We recommend using the Python version from the `.python-version-default` file in the project's root directory.
5660

57-
We use a fully-locked development environment using [*uv*](https://docs.astral.sh/uv/) so the easiest way to get started is to [install *uv*](https://docs.astral.sh/uv/getting-started/installation/) and you can run `uv run pytest` to run the tests immediately.
61+
We use a fully-locked development environment using [*uv*](https://docs.astral.sh/uv/) so the easiest way to get started is to [install *uv*] and you can run `uv run pytest` to run the tests immediately.
5862

5963
I you'd like a traditional virtual environment, you can run `uv sync` and it will create a virtual environment named `.venv` with the correct Python version and install all the dependencies in the root directory.
6064

@@ -264,3 +268,4 @@ By participating in this project you agree to abide by its terms.
264268
Please report any harm to Hynek Schlawack in any way you find appropriate.
265269

266270
[semantic newlines]: https://rhodesmill.org/brandon/2012/one-sentence-per-line/
271+
[install *uv*]: https://docs.astral.sh/uv/getting-started/installation/

0 commit comments

Comments
 (0)