Plugins¶
Many plugins are available for tox. These include, but are not limited to, the extensions found on the tox-dev org
on GitHub.
Plugins are automatically discovered from the Python environment that tox itself is installed in. This means that if tox is installed in an isolated environment (e.g. when installed using pipx or uv), the plugin(s) must be installed in the same environment. To ensure a plugin is always available, include it in requires, which causes tox to auto-provision a new isolated environment with both tox and the plugin(s) installed. For example:
requires = ["tox>=4", "tox-uv>=1"]
[tox]
requires =
tox>=4
tox-uv>=1
Disabling plugins¶
Plugins can be disabled via the TOX_DISABLED_EXTERNAL_PLUGINS environment variable. Set it to a comma-separated list
of plugin names:
env TOX_DISABLED_EXTERNAL_PLUGINS=tox-uv,tox-extra tox --version
- Getting Started with Plugins
- Plugin How-to Guides
- API Reference
- tox objects
- register
- config
- environments
ToxEnvToxEnv.journalToxEnv.confToxEnv.coreToxEnv.optionsToxEnv.log_handlerToxEnv.cacheToxEnv.id()ToxEnv.executorToxEnv.installerToxEnv.register_config()ToxEnv.env_dirToxEnv.env_tmp_dirToxEnv.env_log_dirToxEnv.nameToxEnv.setup()ToxEnv.teardown()ToxEnv.runs_on_platformToxEnv.environment_variablesToxEnv.execute()ToxEnv.interrupt()ToxEnv.execute_async()ToxEnv.display_context()ToxEnv.close_and_read_out_err()
RunToxEnvPackageToxEnvPackage
- journal
- report
- execute
- installer
- session
- tox objects