@@ -27,8 +27,8 @@ Development Environment
27
27
pip is a command line application written in Python. For developing pip,
28
28
you should `install Python `_ on your computer.
29
29
30
- For developing pip, you need to install :pypi: `tox `. Often, you can run
31
- ``python -m pip install tox `` to install and use it.
30
+ For developing pip, you need to install :pypi: `nox `. Often, you can run
31
+ ``python -m pip install nox `` to install and use it.
32
32
33
33
34
34
Running pip From Source Tree
@@ -60,7 +60,7 @@ Running Tests
60
60
=============
61
61
62
62
pip's tests are written using the :pypi: `pytest ` test framework and
63
- :mod: `unittest.mock `. :pypi: `tox ` is used to automate the setup and execution
63
+ :mod: `unittest.mock `. :pypi: `nox ` is used to automate the setup and execution
64
64
of pip's tests.
65
65
66
66
It is preferable to run the tests in parallel for better experience during development,
@@ -70,29 +70,29 @@ To run tests:
70
70
71
71
.. code-block :: console
72
72
73
- $ tox -e py310 -- -n auto
73
+ $ nox -s test-3.10 -- -n auto
74
74
75
75
To run tests without parallelization, run:
76
76
77
77
.. code-block :: console
78
78
79
- $ tox -e py310
79
+ $ nox -s test-3.10
80
80
81
81
The example above runs tests against Python 3.10. You can also use other
82
- versions like ``py39 `` and ``pypy3 ``.
82
+ versions like ``3.9 `` and ``pypy3 ``.
83
83
84
- ``tox `` has been configured to forward any additional arguments it is given to
84
+ ``nox `` has been configured to forward any additional arguments it is given to
85
85
``pytest ``. This enables the use of pytest's `rich CLI `_. As an example, you
86
86
can select tests using the various ways that pytest provides:
87
87
88
88
.. code-block :: console
89
89
90
90
$ # Using file name
91
- $ tox -e py310 -- tests/functional/test_install.py
91
+ $ nox -s test-3.10 -- tests/functional/test_install.py
92
92
$ # Using markers
93
- $ tox -e py310 -- -m unit
93
+ $ nox -s test-3.10 -- -m unit
94
94
$ # Using keywords
95
- $ tox -e py310 -- -k "install and not wheel"
95
+ $ nox -s test-3.10 -- -k "install and not wheel"
96
96
97
97
Running pip's entire test suite requires supported version control tools
98
98
(subversion, bazaar, git, and mercurial) to be installed. If you are missing
@@ -101,8 +101,8 @@ explicitly tell pytest to skip those tests:
101
101
102
102
.. code-block :: console
103
103
104
- $ tox -e py310 -- -k "not svn"
105
- $ tox -e py310 -- -k "not (svn or git)"
104
+ $ nox -s test-3.10 -- -k "not svn"
105
+ $ nox -s test-3.10 -- -k "not (svn or git)"
106
106
107
107
108
108
Running Linters
@@ -116,7 +116,7 @@ To use linters locally, run:
116
116
117
117
.. code-block :: console
118
118
119
- $ tox -e lint
119
+ $ nox -s lint
120
120
121
121
.. note ::
122
122
@@ -155,7 +155,7 @@ To build it locally, run:
155
155
156
156
.. code-block :: console
157
157
158
- $ tox -e docs
158
+ $ nox -s docs
159
159
160
160
The built documentation can be found in the ``docs/build `` folder.
161
161
0 commit comments