Skip to content

Create a virtual environment to run Tox

[Home | Download | GitLab | PyPI | ReadTheDocs]

Overview

The vetox tool creates a virtual environment, installs a suitable version of Tox within it, and then runs Tox with the specified arguments. It does not use any modules outside of the Python standard library, so it is suitable for use when testing with different Python versions.

Note that the vetox tool's main file, the src/vetox/__main__.py file in the source distribution, may be copied into another project's source tree and invoked using a Python 3.x interpreter.

Invocation

The vetox tool accepts two subcommands: run and run-parallel, as well as a -c / --conf option with the path to a tox.ini file. Any positional arguments after the run or run-parallel subcommand are passed on to Tox unmodified.

Examples

Run Tox in an ephemeral virtual environment, use the tox.ini file found in the current working directory, run all the default Tox environments in parallel:

vetox run-parallel

Same, but use Tox 3.x and pass it some environment selection options:

vetox run-parallel -t '>= 3, < 4' -- -e first,second

Use the tox.ini file in the parent directory, run the test environments sequentially, one by one:

vetox -c ../tox.ini run

Display the version of the vetox tool:

vetox version

Display the list of features supported by the vetox tool in a format compatible with the feature-check tool:

vetox features

If the src/vetox/__main__.py file was copied to another project, it may be used to run that project's test suite:

python3 tests/vetox.py run-parallel

Contact

The vetox tool was written by Peter Pentchev. It is developed in a GitLab repository. This documentation is hosted at Ringlet with a copy at ReadTheDocs.