3.0.0rc1 (2018-01-27)

Bugfixes

fix #672 reporting to json file when skip-missing-interpreters option is used
- by @r2dan (#672)

avoid Requested Python version (X.Y) not installed stderr output when a
Python environment is looked up using the py Python launcher on Windows
and the environment is not found installed on the system - by
@jurko-gospodnetic (#692)

Fixed an issue where invocation of Tox from the Python package, where
invocation errors (failed actions) occur results in a change in the
sys.stdout stream encoding in Python 3.x. New behaviour is that sys.stdout is
reset back to its original encoding after invocation errors - by @tonybaloney
(#723)

The reading of command output sometimes failed with IOError: [Errno 0]
Error on Windows, this was fixed by using a simpler method to update the
read buffers. - by @fschulze (#727)

Features

Add a -q option to progressively silence tox’s output. For each time you
specify -q to tox, the output provided by tox reduces. This option allows
you to see only your command output without the default verbosity of what tox
is doing. This also counter-acts usage of -v. For example, running tox
-v-q ... will provide you with the default verbosity. tox -vv-q is
equivalent to tox -v. By @sigmavirus24 (#256)

Headings like installed: <packages> will not be printed if there is no
output to display after the :, unless verbosity is set. By @cryvate (#601)

Allow spaces in command line options to pip in deps. Where previously only
deps=-rreq.txt and deps=--requirement=req.txt worked, now also
deps=-r req.txt and deps=--requirement req.txt work - by @cryvate
(#668)

drop Python 2.6 and 3.3 support: setuptools dropped supporting
these, and as we depend on it we’ll follow up with doing the same (use tox
<= 2.9.1 if you still need this support) - by @gaborbernat (#679)

Add tox_runenvreport as a possible plugin, allowing the overriding of the
default behaviour to execute a command to get the installed packages within a
virtual environment - by @tonybaloney (#725)

Forward PROCESSOR_ARCHITECTURE by default on Windows to fix
platform.machine(). (#740)

touched up interpreters.py code and added some missing tests for it - by
@jurko-gospodnetic (#708)

The PYTHONDONTWRITEBYTECODE environment variable is no longer unset - by
@stephenfin. (#744)

2.9.1 (2017-09-29)

Misc

integrated new release process and fixed changelog rendering for pypi.org -
by @obestwalter.

2.9.0 (2017-09-29)

Features

tox --version now shows information about all registered plugins - by
@obestwalter
(#544)

Bugfixes

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 @ferdonline
(#571)

Misc

add a badge to show build status of documentation on readthedocs.io -
by @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.2 (2017-10-09)

2.8.1 (2017-09-04)

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

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

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

2.7.0 (2017-04-02)

pull request 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 (@asottile).

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.

2.5.0 (2016-11-16)

slightly backward incompatible: fix #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 #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.

2.4.1 (2016-10-12)

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 #352: prevent a configuration where envdir==toxinidir and
refine docs to warn people about changing “envdir”. Thanks Oliver Bestwalter and holger krekel.

fix #375, fix #330: warn against tox-setup.py integration as
“setup.py test” should really just test with the current interpreter. Thanks Ronny Pfannschmidt.

close #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 #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 #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.1 (2015-12-14)

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 #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.

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 guranteed.

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 #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 #246: fix regression in config parsing by reordering
such that {envbindir} can be used again in tox.ini. Thanks Olli Walsh.

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

fix #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.

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 #227: use “-m virtualenv” instead of “-mvirtualenv” to make
it work with pyrun. Thanks Marc-Andre Lemburg.

1.9.0 (2015-02-24)

fix #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.

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

1.7.2 (2014-07-15)

fix #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 #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.

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 #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 #140.

fix #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.

1.6.1 (2013-09-04)

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

fix #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 test runs on environments without a home directory
(in this case we use toxinidir as the homedir)

fix #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 #102: change to {toxinidir} when installing dependencies.
this allows to use relative path like in “-rrequirements.txt”.

1.6.0 (2013-08-15)

fix #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 #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 https://pypi.python.org/pypi.

1.4.3 (2013-02-28)

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)

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).

1.1 (2011-07-08)

fix #2 - warn if a test command does not come from the test
environment

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 virtualenv.py (1.6.1) script to avoid a number of issues,
particularly failing to install python3 environments from a python2
virtualenv installation.

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

0.7

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.

0.6

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.