@@ -2,10 +2,10 @@ Installation
2
2
============
3
3
4
4
As tool
5
- --------
5
+ -------
6
6
7
7
:pypi: `tox ` is a CLI tool that needs a Python interpreter (version 3.9 or higher) to run. We recommend either
8
- :pypi: `pipx ` or :pypi: `uv ` to install tox into an isolated environment. This has the added benefit that later you'll
8
+ :pypi: `pipx ` or :pypi: `uv ` to install tox into an isolated environment. This has the added benefit that later you'll
9
9
be able to upgrade tox without affecting other parts of the system. We provide method for ``pip `` too here but we
10
10
discourage that path if you can:
11
11
@@ -17,7 +17,6 @@ discourage that path if you can:
17
17
uv tool install tox
18
18
tox --help
19
19
20
-
21
20
.. tab :: pipx
22
21
23
22
.. code-block :: bash
@@ -40,6 +39,7 @@ discourage that path if you can:
40
39
41
40
wheel
42
41
~~~~~
42
+
43
43
Installing tox via a wheel (default with pip) requires an installer that can understand the ``python-requires `` tag (see
44
44
:pep: `503 `), with pip this is version ``9.0.0 `` (released in November 2016). Furthermore, in case you're not installing
45
45
it via PyPI you need to use a mirror that correctly forwards the ``python-requires `` tag (notably the OpenStack mirrors
@@ -49,19 +49,22 @@ don't do this, or older :gh_repo:`devpi/devpi` versions - added with version ``4
49
49
50
50
sdist
51
51
~~~~~
52
+
52
53
When installing via a source distribution you need an installer that handles the :pep: `517 ` specification. In case of
53
54
``pip `` this is version ``18.0.0 `` or later (released in July 2018). If you cannot upgrade your pip to support this you
54
55
need to ensure that the build requirements from :gh: `pyproject.toml <tox-dev/tox/blob/main/pyproject.toml> ` are
55
56
satisfied before triggering the installation.
56
57
57
58
via ``setup.py ``
58
59
----------------
60
+
59
61
We don't recommend and officially support this method. You should prefer using an installer that supports :pep: `517 `
60
62
interface, such as pip ``19.0.0 `` or later. That being said you might be able to still install a package via this method
61
63
if you satisfy build dependencies before calling the installation command (as described under :ref: `sdist `).
62
64
63
65
latest unreleased
64
66
-----------------
67
+
65
68
Installing an unreleased version is discouraged and should be only done for testing purposes. If you do so you'll need
66
69
a pip version of at least ``18.0.0 `` and use the following command:
67
70
0 commit comments