Skip to content

Commit b768e9c

Browse files
committed
docs: Replace tox in instructions
Remove mentions of tox in the README and MAINTAINERS file. Update with poethepoet and uv alternatives. Signed-off-by: Pieter De Gendt <[email protected]>
1 parent 8b40457 commit b768e9c

File tree

2 files changed

+29
-22
lines changed

2 files changed

+29
-22
lines changed

MAINTAINERS.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Pre-release test plan
1111

1212
git checkout vX.Y-branch
1313

14-
1. Make tox happy on the following first-party non-Linux platforms:
14+
1. Make testing happy on the following first-party non-Linux platforms:
1515

1616
- Windows 10
1717
- the latest macOS
1818

1919
Do this by hand and check for any anomalous warnings in the output.
2020
Do not just trust CI.
2121

22-
2. Make tox happy on other popular Linux distributions:
22+
2. Make testing happy on other popular Linux distributions:
2323

2424
- Arch
2525
- the latest Ubuntu development release
@@ -32,9 +32,6 @@ Pre-release test plan
3232
Automated infrastructure for doing this using docker is in the
3333
test-distros.yml workflow action on Github.
3434

35-
Make sure to check the tox.log files mentioned in the output for any
36-
anomalous warnings.
37-
3835
3. Build alpha N (N=1 to start, then N=2 if you need more commits, etc.) and
3936
upload to pypi. See "Building and uploading the release wheels" below for
4037
a procedure.

README.rst

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,10 @@ You can create a wheel package and distribute it to others.
118118

119119
To build the west wheel file::
120120

121+
# Using uv
122+
uv build
123+
124+
# Without uv
121125
pip3 install --upgrade build
122126
python -m build
123127

@@ -134,33 +138,39 @@ version from PyPI, etc.
134138
Running the Tests
135139
~~~~~~~~~~~~~~~~~
136140

137-
First, install tox::
141+
First, install the dependencies::
138142

139-
# macOS, Windows
140-
pip3 install tox
143+
# Using uv
144+
uv sync --frozen
141145

142-
# Linux
143-
pip3 install --user tox
146+
# Using pip (requires v25.1 or newer)
147+
# Recommended in an active virtual environment
148+
pip3 install --group dev
144149

145150
Then, run the test suite locally from the top level directory::
146151

147-
tox
152+
# Using uv
153+
uv run poe all
154+
155+
# Using poe
156+
# Recommended in an active virtual environment
157+
poe all
158+
159+
# Manually
160+
pytest
148161

149-
You can use ``--`` to tell tox to pass arguments to ``pytest``. This is
150-
especially useful to focus on specific tests and save time. Examples::
162+
The ``all`` target from ``poe`` runs multiple tasks sequentially. Run ``poe -h``
163+
to get the list of configured tasks.
164+
You can pass arguments to the task running ``poe``. This is especially useful
165+
on specific tests and save time. Examples::
151166

152167
# Run a subset of tests
153-
tox -- tests/test_project.py
168+
poe test tests/test_project.py
154169

155-
# Debug the ``test_update_narrow()`` code with ``pdb`` (but _not_ the
170+
# Run the ``test_update_narrow()`` code with ``pdb`` (but _not_ the
156171
# west code which is running in subprocesses)
157-
tox -- --verbose --exitfirst --trace -k test_update_narrow
172+
poe test --exitfirst --trace -k test_update_narrow
158173

159174
# Run all tests with "import" in their name and let them log to the
160175
# current terminal
161-
tox -- -v -k import --capture=no
162-
163-
The tests cannot be run with ``pytest`` directly, they require the tox
164-
environment.
165-
166-
See the tox configuration file, tox.ini, for more details.
176+
poe test -k import --capture=no

0 commit comments

Comments
 (0)