Debian Codegraph @

docs/plugin/index.rst

raw
1 #########
2 Plugins
3 #########
4
5 Many plugins are available for tox. These include, but are not limited to, the extensions found on the ``tox-dev`` org
6 on :gh:`GitHub <tox-dev>`.
7
8 *****************
9 Popular plugins
10 *****************
11
12 - :pypi:`tox-uv` - Use :pypi:`uv` for faster package installation.
13 - :pypi:`tox-gh-actions` - Integrate tox with GitHub Actions for efficient CI workflows.
14 - :pypi:`tox-gh` - Enhanced GitHub integration for running tox across multiple environments.
15 - :pypi:`tox-extra` - Add sanity checks before/after tests (dirty repo detection, system dependencies).
16 - :pypi:`tox-recreate` - Automatically recreate environments when dependency files change.
17 - :pypi:`tox-multipython` - Interpreter discovery for multipython.
18
19 Plugins are automatically discovered from the Python environment that tox itself is installed in. This means that if tox
20 is installed in an isolated environment (e.g. when installed using :pypi:`pipx` or :pypi:`uv`), the plugin(s) must be
21 installed in the same environment. To ensure a plugin is always available, include it in :ref:`requires`, which causes
22 tox to :ref:`auto-provision <auto-provisioning>` a new isolated environment with both tox and the plugin(s) installed.
23 For example:
24
25 .. tab:: TOML
26
27 .. code-block:: toml
28
29 requires = ["tox>=4", "tox-uv>=1"]
30
31 .. tab:: INI
32
33 .. code-block:: ini
34
35 [tox]
36 requires =
37 tox>=4
38 tox-uv>=1
39
40 *******************
41 Disabling plugins
42 *******************
43
44 Plugins can be disabled via the ``TOX_DISABLED_EXTERNAL_PLUGINS`` environment variable. Set it to a comma-separated list
45 of plugin names:
46
47 .. code-block:: bash
48
49 env TOX_DISABLED_EXTERNAL_PLUGINS=tox-uv,tox-extra tox --version
50
51 .. toctree::
52 :hidden:
53
54 getting_started
55 howto
56 api