Skip to main content

virtualenv-based automation of test activities

Project description

.. image::
.. image::
.. image::
.. image::
.. image::

tox automation project

**vision: standardize testing in Python**

tox aims to automate and standardize testing in Python. It is part of a larger vision of easing the packaging, testing and release process of Python software.

What is tox?

tox is a generic virtualenv management and test command line tool you can use for:

* checking your package installs correctly with different Python versions and

* running your tests in each of the environments, configuring your test tool of choice

* acting as a frontend to Continuous Integration servers, greatly
reducing boilerplate and merging CI and shell-based testing.

For more information and the repository please see:

- home and docs:

- repository:

Code coverage of latest master build

.. image::


The most important changes for each release are kept in this changelog.

If you want to know more details: since version 2.8 releases are organized as Github projects.
To see all closed issues and merged pull requests, contained in a release, visit the projects
on Github:

- 2.9.x:
- 2.8.x:

Everything below here is generated by `towncrier <>`_.
It is generated once as part of the release process rendering fragments from the `changelog`
folder. If necessary, the generated text can be edited afterwards to e.g. merge rc changes
into the final release notes.

.. towncrier release notes start

2.9.0 (2017-09-29)


- ``tox --version`` now shows information about all registered plugins - by
:user:`obestwalter` (`#544 <>`_).


- ``skip_install`` overrides ``usedevelop`` (``usedevelop`` is an option to
choose the installation type if the package is installed and `skip_install`
determines if it should be installed at all) - by :user:`ferdonline` (`#571


- :pull:`635` inherit from correct exception - by :user:`obestwalter`
(`#635 <>`_).
- spelling and escape sequence fixes - by :user:`scoop`
(`#637 <>`_ and
`#638 <>`_).
- add a badge to show build status of documentation on -
by :user:`obestwalter`.

Improved Documentation

- add `towncrier <>`_ to allow adding
changelog entries with the pull requests without generating merge conflicts;
with this release notes are now grouped into four distinct collections:
`Features`, `Bugfixes`, `Improved Documentation` and `Deprecations and
Removals`. (`#614 <>`_)

2.8.1 (2017-09-04)

- :pull:`599`: fix problems with implementation of :issue:`515`.
Substitutions from other sections were not made anymore if they were not in `envlist`.
Thanks to Clark Boylan (:user:`cboylan`) for helping to get this fixed (:pull:`597`).

2.8.0 (2017-09-01)

- :issue:`276`: Remove easy_install from docs (TL;DR: use pip). Thanks Martin Andrysík (:user:`sifuraz`).

- :issue:`301`: Expand nested substitutions in ``tox.ini``. Thanks :user:`vlaci`. Thanks to Eli Collins
(:user:`eli-collins`) for creating a reproducer.

- :issue:`315`: add ``--help`` and ``--version`` to helptox-quickstart. Thanks :user:`vlaci`.

- :issue:`326`: Fix ``OSError`` 'Not a directory' when creating env on Jython 2.7.0. Thanks Nick Douma (:user:`LordGaav`).

- :issue:`429`: Forward ``MSYSTEM`` by default on Windows. Thanks Marius Gedminas (:user:`mgedmin`) for reporting this.

- :issue:`449`: add multi platform example to the docs. Thanks Aleks Bunin (:user:`sashkab`) and :user:`rndr`.

- :issue:`474`: Start using setuptools_scm for tag based versioning.

- :issue:`484`: Renamed `py.test` to `pytest` throughout the project. Thanks Slam (:user:`3lnc`).

- :issue:`504`: With `-a`: do not show additional environments header if there are none. Thanks :user:`rndr`.

- :issue:`515`: Don't require environment variables in test environments where they are not used.
Thanks André Caron (:user:`AndreLouisCaron`).
- :issue:`517`: Forward ``NUMBER_OF_PROCESSORS`` by default on Windows to fix ``multiprocessor.cpu_count()``.
Thanks André Caron (:user:`AndreLouisCaron`).

- :issue:`518`: Forward `USERPROFILE` by default on Windows. Thanks André Caron (:user:`AndreLouisCaron`).

- :pull:`528`: Fix some of the warnings displayed by pytest 3.1.0. Thanks Bruno Oliveira (:user:`nicoddemus`).

- :pull:`547`: Add regression test for :issue:`137`. Thanks Martin Andrysík (:user:`sifuraz`).

- :pull:`553`: Add an XFAIL test to reproduce upstream bug :issue:`203`. Thanks
Bartolomé Sánchez Salado (:user:`bartsanchez`).

- :pull:`556`: Report more meaningful errors on why virtualenv creation failed. Thanks :user:`vlaci`.
Also thanks to Igor Sadchenko (:user:`igor-sadchenko`) for pointing out a problem with that PR
before it hit the masses ☺

- :pull:`575`: Add announcement doc to end all announcement docs
(using only ``CHANGELOG`` and Github issues since 2.5 already).

- :pull:`580`: Do not ignore Sphinx warnings anymore. Thanks Bernát Gábor (:user:`gaborbernat`).

- :pull:`585`: Expand documentation to explain pass through of flags from deps to pip
(e.g. ``-rrequirements.txt``, ``-cconstraints.txt``). Thanks Alexander Loechel (:user:`loechel`).

- :pull:`588`: Run pytest wit xfail_strict and adapt affected tests.

2.7.0 (2017-04-02)

- :pull:`450`: Stop after the first installdeps and first testenv create hooks
succeed. This changes the default behaviour of `tox_testenv_create`
and `tox_testenv_install_deps` to not execute other registered hooks when
the first hook returns a result that is not `None`.
Thanks Anthony Sottile (:user:`asottile`).

- :issue:`271` and :issue:`464`: Improve environment information for users.

New command line parameter: `-a` show **all** defined environments -
not just the ones defined in (or generated from) envlist.

New verbosity settings for `-l` and `-a`: show user defined descriptions
of the environments. This also works for generated environments from factors
by concatenating factor descriptions into a complete description.

Note that for backwards compatibility with scripts using the output of `-l`
it's output remains unchanged.

Thanks Bernát Gábor (:user:`gaborbernat`).

- :issue:`464`: Fix incorrect egg-info location for modified package_dir in
Thanks Selim Belhaouane (:user:`selimb`).

- :issue:`431`: Add 'LANGUAGE' to default passed environment variables.
Thanks Paweł Adamczak (:user:`pawelad`).

- :issue:`455`: Add a Vagrantfile with a customized Arch Linux box for local testing.
Thanks Oliver Bestwalter (:user:`obestwalter`).

- :issue:`454`: Revert :pull:`407`, empty commands is not treated as an error.
Thanks Anthony Sottile (:user:`asottile`).

- :issue:`446`: (infrastructure) Travis CI tests for tox now also run on OS X now.
Thanks Jason R. Coombs (:user:`jaraco`).

2.6.0 (2017-02-04)

- add "alwayscopy" config option to instruct virtualenv to always copy
files instead of symlinking. Thanks Igor Duarte Cardoso (:user:`igordcard`).

- pass setenv variables to during a usedevelop install.
Thanks Eli Collins (:user:`eli-collins`).

- replace all references to with readthedocs ones.
Thanks Oliver Bestwalter (:user:`obestwalter`).

- fix :issue:`323` by avoiding virtualenv14 is not used on py32
(although we don't officially support py32).
Thanks Jason R. Coombs (:user:`jaraco`).

- add Python 3.6 to envlist and CI.
Thanks Andrii Soldatenko (:user:`andriisoldatenko`).

- fix glob resolution from TOX_TESTENV_PASSENV env variable
Thanks Allan Feldman (:user:`a-feld`).

2.5.0 (2016-11-16)

- slightly backward incompatible: fix :issue:`310`: the {posargs} substitution
now properly preserves the tox command line positional arguments. Positional
arguments with spaces are now properly handled.
NOTE: if your tox invocation previously used extra quoting for positional arguments to
work around :issue:`310`, you need to remove the quoting. Example:
tox -- "'some string'" # has to now be written simply as
tox -- "some string"
thanks holger krekel. You can set ``minversion = 2.5.0`` in the ``[tox]``
section of ``tox.ini`` to make sure people using your tox.ini use the correct version.

- fix :issue:`359`: add COMSPEC to default passenv on windows. Thanks

- add support for py36 and py37 and add py36-dev and py37(nightly) to
travis builds of tox. Thanks John Vandenberg.

- fix :issue:`348`: add py2 and py3 as default environments pointing to
"python2" and "python3" basepython executables. Also fix :issue:`347` by
updating the list of default envs in the tox basic example.
Thanks Tobias McNulty.

- make "-h" and "--help-ini" options work even if there is no tox.ini,
thanks holger krekel.

- add {:} substitution, which is replaced with os-specific path
separator, thanks Lukasz Rogalski.

- fix :issue:`305`: ``downloadcache`` test env config is now ignored as pip-8
does caching by default. Thanks holger krekel.

- output from install command in verbose (-vv) mode is now printed to console instead of
being redirected to file, thanks Lukasz Rogalski

- fix :issue:`399`. Make sure {envtmpdir} is created if it doesn't exist at the
start of a testenvironment run. Thanks Manuel Jacob.

- fix :issue:`316`: Lack of commands key in ini file is now treated as an error.
Reported virtualenv status is 'nothing to do' instead of 'commands
succeeded', with relevant error message displayed. Thanks Lukasz Rogalski.

2.4.1 (2016-10-12)

- fix :issue:`380`: properly perform substitution again. Thanks Ian

2.4.0 (2016-10-12)

- remove PYTHONPATH from environment during the install phase because a
tox-run should not have hidden dependencies and the test commands will also
not see a PYTHONPATH. If this causes unforeseen problems it may be
reverted in a bugfix release. Thanks Jason R. Coombs.

- fix :issue:`352`: prevent a configuration where envdir==toxinidir and
refine docs to warn people about changing "envdir". Thanks Oliver Bestwalter and holger krekel.

- fix :issue:`375`, fix :issue:`330`: warn against integration as
" test" should really just test with the current interpreter. Thanks Ronny Pfannschmidt.

- fix :issue:`302`: allow cross-testenv substitution where we substitute
with ``{x,y}`` generative syntax. Thanks Andrew Pashkin.

- fix :issue:`212`: allow escaping curly brace chars "\{" and "\}" if you need the
chars "{" and "}" to appear in your commands or other ini values.
Thanks John Vandenberg.

- addresses :issue:`66`: add --workdir option to override where tox stores its ".tox" directory
and all of the virtualenv environment. Thanks Danring.

- introduce per-venv list_dependencies_command which defaults
to "pip freeze" to obtain the list of installed packages.
Thanks Ted Shaw, Holger Krekel.

- close :issue:`66`: add documentation to jenkins page on how to avoid
"too long shebang" lines when calling pip from tox. Note that we
can not use "python -m pip install X" by default because the latter
adds the CWD and pip will think X is installed if it is there.
"pip install X" does not do that.

- new list_dependencies_command to influence how tox determines
which dependencies are installed in a testenv.

- (experimental) New feature: When a search for a config file fails, tox tries loading
setup.cfg with a section prefix of "tox".

- fix :issue:`275`: Introduce hooks ``tox_runtest_pre``` and
``tox_runtest_post`` which run before and after the tests of a venv,
respectively. Thanks to Matthew Schinckel and itxaka serrano.

- fix :issue:`317`: evaluate minversion before tox config is parsed completely.
Thanks Sachi King for the PR.

- added the "extras" environment option to specify the extras to use when doing the
sdist or develop install. Contributed by Alex Grönholm.

- use pytest-catchlog instead of pytest-capturelog (latter is not
maintained, uses deprecated pytest API)

2.3.2 (2016-02-11)

- fix :issue:`314`: fix command invocation with .py scripts on windows.

- fix :issue:`279`: allow cross-section substitution when the value contains
posargs. Thanks Sachi King for the PR.

2.3.1 (2015-12-14)

- fix :issue:`294`: re-allow cross-section substitution for setenv.

2.3.0 (2015-12-09)

- DEPRECATE use of "indexservers" in tox.ini. It complicates
the internal code and it is recommended to rather use the
devpi system for managing indexes for pip.

- fix :issue:`285`: make setenv processing fully lazy to fix regressions
of tox-2.2.X and so that we can now have testenv attributes like
"basepython" depend on environment variables that are set in
a setenv section. Thanks Nelfin for some tests and initial
work on a PR.

- allow "#" in commands. This is slightly incompatible with commands
sections that used a comment after a "\" line continuation.
Thanks David Stanek for the PR.

- fix :issue:`289`: fix build_sphinx target, thanks Barry Warsaw.

- fix :issue:`252`: allow environment names with special characters.
Thanks Julien Castets for initial PR and patience.

- introduce experimental tox_testenv_create(venv, action) and
tox_testenv_install_deps(venv, action) hooks to allow
plugins to do additional work on creation or installing
deps. These hooks are experimental mainly because of
the involved "venv" and session objects whose current public
API is not fully guaranteed.

- internal: push some optional object creation into tests because
tox core doesn't need it.

2.2.1 (2015-12-09)

- fix bug where {envdir} substitution could not be used in setenv
if that env value is then used in {basepython}. Thanks Florian Bruhin.

2.2.0 (2015-11-11)

- fix :issue:`265` and add LD_LIBRARY_PATH to passenv on linux by default
because otherwise the python interpreter might not start up in
certain configurations (redhat software collections). Thanks David Riddle.

- fix :issue:`246`: fix regression in config parsing by reordering
such that {envbindir} can be used again in tox.ini. Thanks Olli Walsh.

- fix :issue:`99`: the {env:...} substitution now properly uses environment
settings from the ``setenv`` section. Thanks Itxaka Serrano.

- fix :issue:`281`: make --force-dep work when urls are present in
dependency configs. Thanks Glyph Lefkowitz for reporting.

- fix :issue:`174`: add new ``ignore_outcome`` testenv attribute which
can be set to True in which case it will produce a warning instead
of an error on a failed testenv command outcome.
Thanks Rebecka Gulliksson for the PR.

- fix :issue:`280`: properly skip missing interpreter if
{envsitepackagesdir} is present in commands. Thanks BB:ceridwenv

2.1.1 (2015-06-23)

- fix platform skipping for detox

- report skipped platforms as skips in the summary

2.1.0 (2015-06-19)

- fix :issue:`258`, fix :issue:`248`, fix :issue:`253`: for non-test commands
(installation, venv creation) we pass in the full invocation environment.

- remove experimental --set-home option which was hardly used and
hackily implemented (if people want home-directory isolation we should
figure out a better way to do it, possibly through a plugin)

- fix :issue:`259`: passenv is now a line-list which allows to intersperse
comments. Thanks stefano-m.

- allow envlist to be a multi-line list, to intersperse comments
and have long envlist settings split more naturally. Thanks Andre Caron.

- introduce a TOX_TESTENV_PASSENV setting which is honored
when constructing the set of environment variables for test environments.
Thanks Marc Abramowitz for pushing in this direction.

2.0.2 (2015-06-03)

- fix :issue:`247`: tox now passes the LANG variable from the tox invocation
environment to the test environment by default.

- add SYSTEMDRIVE into default passenv on windows to allow pip6 to work.
Thanks Michael Krause.

2.0.1 (2015-05-13)

- fix wheel packaging to properly require argparse on py26.

2.0.0 (2015-05-12)

- (new) introduce environment variable isolation:
tox now only passes the PATH and PIP_INDEX_URL variable from the tox
invocation environment to the test environment and on Windows
also ``SYSTEMROOT``, ``PATHEXT``, ``TEMP`` and ``TMP`` whereas
on unix additionally ``TMPDIR`` is passed. If you need to pass
through further environment variables you can use the new ``passenv`` setting,
a space-separated list of environment variable names. Each name
can make use of fnmatch-style glob patterns. All environment
variables which exist in the tox-invocation environment will be copied
to the test environment.

- a new ``--help-ini`` option shows all possible testenv settings and
their defaults.

- (new) introduce a way to specify on which platform a testenvironment is to
execute: the new per-venv "platform" setting allows to specify
a regular expression which is matched against sys.platform.
If platform is set and doesn't match the platform spec in the test
environment the test environment is ignored, no setup or tests are attempted.

- (new) add per-venv "ignore_errors" setting, which defaults to False.
If ``True``, a non-zero exit code from one command will be ignored and
further commands will be executed (which was the default behavior in tox <
2.0). If ``False`` (the default), then a non-zero exit code from one command
will abort execution of commands for that environment.

- show and store in json the version dependency information for each venv

- remove the long-deprecated "distribute" option as it has no effect these days.

- fix :issue:`233`: avoid hanging with tox-setuptools integration example. Thanks simonb.

- fix :issue:`120`: allow substitution for the commands section. Thanks
Volodymyr Vitvitski.

- fix :issue:`235`: fix AttributeError with --installpkg. Thanks
Volodymyr Vitvitski.

- tox has now somewhat pep8 clean code, thanks to Volodymyr Vitvitski.

- fix :issue:`240`: allow to specify empty argument list without it being
rewritten to ".". Thanks Daniel Hahler.

- introduce experimental (not much documented yet) plugin system
based on pytest's externalized "pluggy" system.
See tox/ for the current hooks.

- introduce parser.add_testenv_attribute() to register an ini-variable
for testenv sections. Can be used from plugins through the
tox_add_option hook.

- rename internal files -- tox offers no external API except for the
experimental plugin hooks, use tox internals at your own risk.

- DEPRECATE distshare in documentation

1.9.2 (2015-03-23)

- backout ability that --force-dep substitutes name/versions in
requirement files due to various issues.
This fixes :issue:`228`, fixes :issue:`230`, fixes :issue:`231`
which popped up with 1.9.1.

1.9.1 (2015-03-23)

- use a file instead of a pipe for command output in "--result-json".
Fixes some termination issues with python2.6.

- allow --force-dep to override dependencies in "-r" requirements
files. Thanks Sontek for the PR.

- fix :issue:`227`: use "-m virtualenv" instead of "-mvirtualenv" to make
it work with pyrun. Thanks Marc-Andre Lemburg.

1.9.0 (2015-02-24)

- fix :issue:`193`: Remove ``--pre`` from the default ``install_command``; by
default tox will now only install final releases from PyPI for unpinned
dependencies. Use ``pip_pre = true`` in a testenv or the ``--pre``
command-line option to restore the previous behavior.

- fix :issue:`199`: fill resultlog structure ahead of virtualenv creation

- refine determination if we run from Jenkins, thanks Borge Lanes.

- echo output to stdout when ``--report-json`` is used

- fix :issue:`11`: add a ``skip_install`` per-testenv setting which
prevents the installation of a package. Thanks Julian Krause.

- fix :issue:`124`: ignore command exit codes; when a command has a "-" prefix,
tox will ignore the exit code of that command

- fix :issue:`198`: fix broken envlist settings, e.g. {py26,py27}{-lint,}

- fix :issue:`191`: lessen factor-use checks

1.8.1 (2014-10-24)

- fix :issue:`190`: allow setenv to be empty.

- allow escaping curly braces with "\". Thanks Marc Abramowitz for the PR.

- allow "." names in environment names such that "py27-django1.7" is a
valid environment name. Thanks Alex Gaynor and Alex Schepanovski.

- report subprocess exit code when execution fails. Thanks Marius

1.8.0 (2014-09-24)

- new multi-dimensional configuration support. Many thanks to
Alexander Schepanovski for the complete PR with docs.
And to Mike Bayer and others for testing and feedback.

- fix :issue:`148`: remove "__PYVENV_LAUNCHER__" from os.environ when starting
subprocesses. Thanks Steven Myint.

- fix :issue:`152`: set VIRTUAL_ENV when running test commands,
thanks Florian Ludwig.

- better report if we can't get version_info from an interpreter
executable. Thanks Floris Bruynooghe.

1.7.2 (2014-07-15)

- fix :issue:`150`: parse {posargs} more like we used to do it pre 1.7.0.
The 1.7.0 behaviour broke a lot of OpenStack projects.
See PR85 and the issue discussions for (far) more details, hopefully
resulting in a more refined behaviour in the 1.8 series.
And thanks to Clark Boylan for the PR.

- fix :issue:`59`: add a config variable ``skip-missing-interpreters`` as well as
command line option ``--skip-missing-interpreters`` which won't fail the
build if Python interpreters listed in tox.ini are missing. Thanks
Alexandre Conrad for PR104.

- fix :issue:`164`: better traceback info in case of failing test commands.
Thanks Marc Abramowitz for PR92.

- support optional env variable substitution, thanks Morgan Fainberg
for PR86.

- limit python hashseed to 1024 on Windows to prevent possible
memory errors. Thanks March Schlaich for the PR90.

1.7.1 (2014-03-28)

- fix :issue:`162`: don't list python 2.5 as compatibility/supported

- fix :issue:`158` and fix :issue:`155`: windows/virtualenv properly works now:
call virtualenv through "python -m virtualenv" with the same
interpreter which invoked tox. Thanks Chris Withers, Ionel Maries Cristian.

1.7.0 (2014-01-29)

- don't lookup "pip-script" anymore but rather just "pip" on windows
as this is a pip implementation detail and changed with pip-1.5.
It might mean that tox-1.7 is not able to install a different pip
version into a virtualenv anymore.

- drop Python2.5 compatibility because it became too hard due
to the setuptools-2.0 dropping support. tox now has no
support for creating python2.5 based environments anymore
and all internal special-handling has been removed.

- merged PR81: new option --force-dep which allows to
override tox.ini specified dependencies in setuptools-style.
For example "--force-dep 'django<1.6'" will make sure
that any environment using "django" as a dependency will
get the latest 1.5 release. Thanks Bruno Oliveria for
the complete PR.

- merged PR125: tox now sets "PYTHONHASHSEED" to a random value
and offers a "--hashseed" option to repeat a test run with a specific seed.
You can also use --hashsheed=noset to instruct tox to leave the value
alone. Thanks Chris Jerdonek for all the work behind this.

- fix :issue:`132`: removing zip_safe setting (so it defaults to false)
to allow installation of tox
via easy_install/eggs. Thanks Jenisys.

- fix :issue:`126`: depend on virtualenv>=1.11.2 so that we can rely
(hopefully) on a pip version which supports --pre. (tox by default
uses to --pre). also merged in PR84 so that we now call "virtualenv"
directly instead of looking up interpreters. Thanks Ionel Maries Cristian.
This also fixes :issue:`140`.

- fix :issue:`130`: you can now set install_command=easy_install {opts} {packages}
and expect it to work for repeated tox runs (previously it only worked
when always recreating). Thanks jenisys for precise reporting.

- fix :issue:`129`: tox now uses Popen(..., universal_newlines=True) to force
creation of unicode stdout/stderr streams. fixes a problem on specific
platform configs when creating virtualenvs with Python3.3. Thanks
Jorgen Schäfer or investigation and solution sketch.

- fix :issue:`128`: enable full substitution in install_command,
thanks for the PR to Ronald Evers

- rework and simplify "commands" parsing and in particular posargs
substitutions to avoid various win32/posix related quoting issues.

- make sure that the --installpkg option trumps any usedevelop settings
in tox.ini or

- introduce --no-network to tox's own test suite to skip tests
requiring networks

- introduce --sitepackages to force sitepackages=True in all

- fix :issue:`105` -- don't depend on an existing HOME directory from tox tests.

1.6.1 (2013-09-04)

- fix :issue:`119`: {envsitepackagesdir} is now correctly computed and has
a better test to prevent regression.

- fix :issue:`116`: make 1.6 introduced behaviour of changing to a
per-env HOME directory during install activities dependent
on "--set-home" for now. Should re-establish the old behaviour
when no option is given.

- fix :issue:`118`: correctly have two tests use realpath(). Thanks Barry

- fix test runs on environments without a home directory
(in this case we use toxinidir as the homedir)

- fix :issue:`117`: python2.5 fix: don't use ``--insecure`` option because
its very existence depends on presence of "ssl". If you
want to support python2.5/pip1.3.1 based test environments you need
to install ssl and/or use PIP_INSECURE=1 through ``setenv``. section.

- fix :issue:`102`: change to {toxinidir} when installing dependencies.
this allows to use relative path like in "-rrequirements.txt".

1.6.0 (2013-08-15)

- fix :issue:`35`: add new EXPERIMENTAL "install_command" testenv-option to
configure the installation command with options for dep/pkg install.
Thanks Carl Meyer for the PR and docs.

- fix :issue:`91`: python2.5 support by vendoring the virtualenv-1.9.1
script and forcing pip<1.4. Also the default [py25] environment
modifies the default installer_command (new config option)
to use pip without the "--pre" option which was introduced
with pip-1.4 and is now required if you want to install non-stable
releases. (tox defaults to install with "--pre" everywhere).

- during installation of dependencies HOME is now set to a pseudo
location ({envtmpdir}/pseudo-home). If an index url was specified
a .pydistutils.cfg file will be written with an index_url setting
so that packages defining ``setup_requires`` dependencies will not
silently use your HOME-directory settings or

- fix :issue:`1`: empty setup files are properly detected, thanks Anthon van
der Neuth

- remove for now because it is broken.

- fix :issue:`109` and fix :issue:`111`: multiple "-e" options are now combined
(previously the last one would win). Thanks Anthon van der Neut.

- add --result-json option to write out detailed per-venv information
into a json report file to be used by upstream tools.

- add new config options ``usedevelop`` and ``skipsdist`` as well as a
command line option ``--develop`` to install the package-under-test in develop mode.
thanks Monty Tailor for the PR.

- always unset PYTHONDONTWRITEBYTE because newer setuptools doesn't like it

- if a HOMEDIR cannot be determined, use the toxinidir.

- refactor interpreter information detection to live in new
tox/ file, tests in tests/

1.5.0 (2013-06-22)

- fix :issue:`104`: use setuptools by default, instead of distribute,
now that setuptools has distribute merged.

- make sure test commands are searched first in the virtualenv

- re-fix :issue:`2` - add whitelist_externals to be used in ``[testenv*]``
sections, allowing to avoid warnings for commands such as ``make``,
used from the commands value.

- fix :issue:`97` - allow substitutions to reference from other sections
(thanks Krisztian Fekete)

- fix :issue:`92` - fix {envsitepackagesdir} to actually work again

- show (test) command that is being executed, thanks
Lukasz Balcerzak

- re-license tox to MIT license

- depend on virtualenv-1.9.1

- rename README.txt to README.rst to make bitbucket happier

1.4.3 (2013-02-28)

- use instead of pip.exe on win32 to avoid the lock exe
file on execution issue (thanks Philip Thiem)

- introduce -l|--listenv option to list configured environments
(thanks Lukasz Balcerzak)

- fix downloadcache determination to work according to docs: Only
make pip use a download cache if PIP_DOWNLOAD_CACHE or a
downloadcache=PATH testenv setting is present. (The ENV setting
takes precedence)

- fix :issue:`84` - pypy on windows creates a bin not a scripts venv directory
(thanks Lukasz Balcerzak)

- experimentally introduce --installpkg=PATH option to install a package
rather than create/install an sdist package. This will still require
and use tox.ini and tests from the current working dir (and not from the
remote package).

- substitute {envsitepackagesdir} with the package installation
directory (closes :issue:`72`) (thanks g2p)

- issue :issue:`70` remove PYTHONDONTWRITEBYTECODE workaround now that
virtualenv behaves properly (thanks g2p)

- merged tox-quickstart command, contributed by Marc Abramowitz, which
generates a default tox.ini after asking a few questions

- fix :issue:`48` - win32 detection of pypy and other interpreters that are on PATH
(thanks Gustavo Picon)

- fix grouping of index servers, it is now done by name instead of
indexserver url, allowing to use it to separate dependencies
into groups even if using the same default indexserver.

- look for "tox.ini" files in parent dirs of current dir (closes :issue:`34`)

- the "py" environment now by default uses the current interpreter
(sys.executable) make tox' own test execute tests with it
(closes :issue:`46`)

- change tests to not rely on os.path.expanduser (closes :issue:`60`),
also make mock session return args[1:] for more precise checking (closes :issue:`61`)
thanks to Barry Warsaw for both.

1.4.2 (2012-07-20)

- fix some tests which fail if /tmp is a symlink to some other place
- "python test" now runs tox tests via tox :)
also added an example on how to do it for your project.

1.4.1 (2012-07-03)

- fix :issue:`41` better quoting on windows - you can now use "<" and ">" in
deps specifications, thanks Chris Withers for reporting

1.4 (2012-06-13)

- fix :issue:`26` - no warnings on absolute or relative specified paths for commands
- fix :issue:`33` - commentchars are ignored in key-value settings allowing
for specifying commands like: python -c "import sys ; print sys"
which would formerly raise irritating errors because the ";"
was considered a comment
- tweak and improve reporting
- refactor reporting and virtualenv manipulation
to be more accessible from 3rd party tools
- support value substitution from other sections
with the {[section]key} syntax
- fix :issue:`29` - correctly point to pytest explanation
for importing modules fully qualified
- fix :issue:`32` - use --system-site-packages and don't pass --no-site-packages
- add python3.3 to the default env list, so early adopters can test
- drop python2.4 support (you can still have your tests run on
- fix the links/checkout howtos in the docs
python-2.4, just tox itself requires 2.5 or higher.

1.3 2011-12-21

- fix: allow to specify wildcard filesystem paths when
specifying dependencies such that tox searches for
the highest version

- fix issue :issue:`21`: clear PIP_REQUIRES_VIRTUALENV which avoids
pip installing to the wrong environment, thanks to bb's streeter

- make the install step honour a testenv's setenv setting
(thanks Ralf Schmitt)

1.2 2011-11-10

- remove the that was distributed with tox and depend
on >=virtualenv-1.6.4 (possible now since the latter fixes a few bugs
that the inlining tried to work around)
- fix :issue:`10`: work around UnicodeDecodeError when invoking pip (thanks
Marc Abramowitz)
- fix a problem with parsing {posargs} in tox commands (spotted by goodwill)
- fix the warning check for commands to be installed in testenvironment
(thanks Michael Foord for reporting)

1.1 (2011-07-08)

- fix :issue:`5` - don't require argparse for python versions that have it
- fix :issue:`6` - recreate virtualenv if installing dependencies failed
- fix :issue:`3` - fix example on frontpage
- fix :issue:`2` - warn if a test command does not come from the test
- fixed/enhanced: except for initial install always call "-U
--no-deps" for installing the sdist package to ensure that a package
gets upgraded even if its version number did not change. (reported on
TIP mailing list and IRC)
- inline (1.6.1) script to avoid a number of issues,
particularly failing to install python3 environments from a python2
virtualenv installation.
- rework and enhance docs for display on


- move repository and toxbootstrap links to
- fix :issue:`7`: introduce a "minversion" directive such that tox
bails out if it does not have the correct version.
- fix :issue:`24`: introduce a way to set environment variables for
for test commands (thanks Chris Rose)
- fix :issue:`22`: require virtualenv-1.6.1, obsoleting virtualenv5 (thanks Jannis Leidel)
and making things work with pypy-1.5 and python3 more seamlessly
- (used by jenkins build slaves) now follows the latest release of virtualenv
- fix :issue:`20`: document format of URLs for specifying dependencies
- fix :issue:`19`: substitute Hudson for Jenkins everywhere following the renaming
of the project. NOTE: if you used the special [tox:hudson]
section it will now need to be named [tox:jenkins].
- fix issue 23 / apply some ReST fixes
- change the positional argument specifier to use {posargs:} syntax and
fix issues :issue:`15` and :issue:`10` by refining the argument parsing method (Chris Rose)
- remove use of inipkg lazy importing logic -
the namespace/imports are anyway very small with tox.
- fix a fspath related assertion to work with debian installs which uses
- show path of the underlying virtualenv invocation and bootstrap into a working subdir
- added a CONTRIBUTORS file


- fix pip-installation mixups by always unsetting PIP_RESPECT_VIRTUALENV
(thanks Armin Ronacher)
- :issue:`1`: Add a script for tox, thanks to Sridhar
- added support for working with different and multiple PyPI indexservers.
- new option: -r|--recreate to force recreation of virtualenv
- depend on py>=1.4.0 which does not contain or install the py.test
anymore which is now a separate distribution "pytest".
- show logfile content if there is an error (makes CI output
more readable)


- work around a virtualenv limitation which crashes if
- run pip/easy installs from the environment log directory, avoids
naming clashes between env names and dependencies (thanks ronny)
- require a more recent version of py lib
- refactor and refine config detection to work from a single file
and to detect the case where a python installation overwrote
an old one and resulted in a new executable. This invalidates
the existing virtualenvironment now.
- change all internal source to strip trailing whitespaces


- use virtualenv5 (my own fork of virtualenv3) for now to create python3
environments, fixes a couple of issues and makes tox more likely to
work with Python3 (on non-windows environments)

- add ``sitepackages`` option for testenv sections so that environments
can be created with access to globals (default is not to have access,
i.e. create environments with ``--no-site-packages``.

- addressing :issue:`4`: always prepend venv-path to PATH variable when calling subprocesses

- fix :issue:`2`: exit with proper non-zero return code if there were
errors or test failures.

- added unittest2 examples contributed by Michael Foord

- only allow 'True' or 'False' for boolean config values
(lowercase / uppercase is irrelevant)

- recreate virtualenv on changed configurations


- fix OSX related bugs that could cause the caller's environment to get
screwed (sorry). tox was using the same file as virtualenv for tracking
the Python executable dependency and there also was confusion wrt links.
this should be fixed now.

- fix long description, thanks Michael Foord


- initial release

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tox-2.9.0.tar.gz (1.8 MB view hashes)

Uploaded Source

Built Distribution

tox-2.9.0-py2.py3-none-any.whl (71.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page