tox-dev/tox


Command line driven CI frontend and development task automation tool

https://tox.readthedocs.io

License: MIT

Language: Python

Keywords: appveyor, automation, azure-pipelines, circleci, cli, continuous-integration, gitlab, python, testing, travis, venv, virtualenv


Latest version on PyPi Supported Python versions Azure Pipelines build status Documentation status Code style: black Downloads

tox logo

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.

Example: run tests with Python 2.7 and Python 3.7

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 a 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 the collection of examples in the documentation or 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 flow

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.

Project Statistics

Sourcerank 17
Repository Size 10.1 MB
Stars 1,368
Forks 238
Watchers 35
Open issues 132
Dependencies 0
Contributors 175
Tags 87
Created
Last updated
Last pushed

Top Contributors See all

holger krekel Oliver Bestwalter Bernát Gábor Anthony Sottile Marc Abramowitz Ronny Pfannschmidt Jurko Gospodnetić Daniel Hahler Alexander Schepanovski Monty Taylor Chris Rose Carl Meyer Bruno Oliveira Lukasz Balcerzak Check your git settings! Florian Schulze Pi Delport Ionel Cristian Mărieș Sviatoslav Sydorenko Anthon van der Neut

Packages Referencing this Repo

tox
tox is a generic virtualenv management and test command line tool
Latest release 3.14.2 - Updated - 1.37K stars

Recent Tags See all

3.14.2 December 02, 2019
3.14.1 November 13, 2019
3.14.0 September 03, 2019
3.13.2 July 01, 2019
3.13.1 June 25, 2019
3.13.0 June 24, 2019
3.12.1 May 23, 2019
3.12.0 May 23, 2019
3.11.1 May 16, 2019
3.11.0 May 15, 2019
3.10.0 May 13, 2019
3.9.0 April 17, 2019
3.8.6 April 03, 2019
3.8.5 April 03, 2019
3.8.4 April 01, 2019

Interesting Forks See all

ionelmc/tox
Command line driven CI frontend and development task automation tool
Python - MIT - Updated - 1 stars
hackebrot/tox
virtualenv management and test command line tool
Python - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-12-02 18:54:53 UTC

Login to resync this repository