@@ -2,10 +2,10 @@ Installation
22============
33
44As tool
5- --------
5+ -------
66
77: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
99be able to upgrade tox without affecting other parts of the system. We provide method for ``pip `` too here but we
1010discourage that path if you can:
1111
@@ -17,7 +17,6 @@ discourage that path if you can:
1717 uv tool install tox
1818 tox --help
1919
20-
2120 .. tab :: pipx
2221
2322 .. code-block :: bash
@@ -40,6 +39,7 @@ discourage that path if you can:
4039
4140wheel
4241~~~~~
42+
4343Installing tox via a wheel (default with pip) requires an installer that can understand the ``python-requires `` tag (see
4444:pep: `503 `), with pip this is version ``9.0.0 `` (released in November 2016). Furthermore, in case you're not installing
4545it 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
4949
5050sdist
5151~~~~~
52+
5253When installing via a source distribution you need an installer that handles the :pep: `517 ` specification. In case of
5354``pip `` this is version ``18.0.0 `` or later (released in July 2018). If you cannot upgrade your pip to support this you
5455need to ensure that the build requirements from :gh: `pyproject.toml <tox-dev/tox/blob/main/pyproject.toml> ` are
5556satisfied before triggering the installation.
5657
5758via ``setup.py ``
5859----------------
60+
5961We don't recommend and officially support this method. You should prefer using an installer that supports :pep: `517 `
6062interface, such as pip ``19.0.0 `` or later. That being said you might be able to still install a package via this method
6163if you satisfy build dependencies before calling the installation command (as described under :ref: `sdist `).
6264
6365latest unreleased
6466-----------------
67+
6568Installing an unreleased version is discouraged and should be only done for testing purposes. If you do so you'll need
6669a pip version of at least ``18.0.0 `` and use the following command:
6770
0 commit comments