.. Everything below here is generated by `towncrier <https://pypi.python.org/pypi/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.

- ``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 <https://github.com/tox-dev/tox/issues/571>`_).

- add `towncrier <https://github.com/hawkowl/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 <https://github.com/tox-dev/tox/issues/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`).

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

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.

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

- 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 tox-setup.py integration as "setup.py test" should really just test with the current interpreter. Thanks Ronny Pfannschmidt.

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

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

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

- 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:`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.

- (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:`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.

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

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

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

- 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 setup.py 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 setup.py 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

- remove the virtualenv.py 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 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.- rework and enhance docs for display on readthedocs.org

1.0===

- move repository and toxbootstrap links to https://bitbucket.org/hpk42/tox- 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- toxbootstrap.py (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 symlinks- show path of the underlying virtualenv invocation and bootstrap virtualenv.py into a working subdir- added a CONTRIBUTORS file

0.9===

- fix pip-installation mixups by always unsetting PIP_RESPECT_VIRTUALENV (thanks Armin Ronacher)- :issue:`1`: Add a toxbootstrap.py script for tox, thanks to Sridhar Ratnakumar- 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)

0.8===

- work around a virtualenv limitation which crashes if PYTHONDONTWRITEBYTECODE is set.- 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

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

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