tox automation project

Command line driven CI frontend and development task automation tool

At its core tox povides a convenient way to run arbitrary commands in isolated environments to serve as a single entry point for build, test and release activities.

tox is highly configurable and pluggable.

A simple example

tox is mainly used as a command line tool and needs a tox.ini or a tool.tox section in pyproject.toml containing the configuration.

To test a simple project that has some tests, here is an example with the tox.ini in the root of the project:

[tox]
envlist = py27,py37

[testenv]
deps = pytest
commands = pytest

$ tox

[lots of output from what tox does]
[lots of output from commands that were run]

__________________ summary _________________
  py27: commands succeeded
  py37: commands succeeded
  congratulations :)

tox created two testenvs - one based on Python2.7 and one based on Python3.7, it installed pytest in them and ran the tests. The report at the end summarizes which testenvs have failed and which have succeeded.

Note: To learn more about what you can do with tox, have a look at existing projects using tox.

How it works

tox creates virtual environments for all configured so called testenvs, it then installs the project and other necessary dependencies and runs the configured set of commands. See system overview for more details.

tox can be used for ...

creating development environments
running static code analysis and test tools
automating package builds
running tests against the package build by tox
checking that packages install correctly with different Python versions/interpreters
unifying Continuous Integration and command line based testing
building and deploying project documentation
releasing a package to PyPI or any other platform
limit: your imagination

Documentation

Documentation for tox can be found at Read The Docs.

Communication and questions

If you have questions or suggestions you can first check if they have already been answered or discussed on our issue tracker on Stack Overflow (tagged with tox).

If you want to discuss topics or propose changes that might not (yet) fit into an issue, you can get in touch via mail through tox-dev@python.org.

We also have a Gitter community.

Contributing

Contributions are welcome. See contributing and our Contributor Covenant Code of Conduct.

Currently the code and the issues are hosted on Github.

The project is licensed under MIT.

Release files for tox 3.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tox 3.7.0
File	Size	Uploaded
tox-3.7.0.tar.gz	267.9 kB	Jan 11, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for tox 3.7.0
File	Interpreter	ABI	Platform	Reset
tox-3.7.0-py2.py3-none-any.whl 60.2 kB Jan 11, 2019	Python 2, Python 3	none	any	Details

Total release size: 328.0 kB

Release files / tox-3.7.0.tar.gz

Download URL	tox-3.7.0.tar.gz
Size	267.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`25ef928babe88c71e3ed3af0c464d1160b01fca2dd1870a5bb26c2dea61a17fc`
BLAKE2b-256 checksum How to use checksums	`d74282308785b76b374456218b4f1f9f69075d081cb5b4f287766d21a30565dc`
Upload date	Jan 11, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0`

Release files / tox-3.7.0-py2.py3-none-any.whl

Download URL	tox-3.7.0-py2.py3-none-any.whl
Size	60.2 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`04f8f1aa05de8e76d7a266ccd14e0d665d429977cd42123bc38efa9b59964e9e`
BLAKE2b-256 checksum How to use checksums	`4abd50cd91221508db5bb66e211ac327d0da4a5db6d0db5ad35d6fbf1e4af5dc`
Upload date	Jan 11, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0`