Changelog history

Versions follow Semantic Versioning (<major>.<minor>.<patch>). Backward incompatible (breaking) changes will only be introduced in major versions with advance notice in the Deprecations section of releases.

Changes in master, but not released yet are under the draft section.

towncrier, version 22.8.0

v3.28.0 (2022-12-14)

Features

  • Support provision of tox 4 with the min_version option - by @hroncok #2661

v3.27.1 (2022-11-13)

Bugfixes

  • Replaced deprecated license_file key with license_files in setup.cfg – by @mgorny. #2521

  • Add env cleanup to envreport - fix PYTHONPATH leak into “envreport” – by @f3flight. #2528

v3.27.0 (2022-10-25)

Bugfixes

  • Dropped --build-option in isolated builds, an alternative fix for the SetuptoolsDeprecationWarning about using --global-option – by @adamchainz #2497

  • Remove read-only files in ensure_empty_dir. #2498

  • Multiple tox instances no longer clobber the .tox directory when provision_tox_env is used. - by @masenf #2515

Documentation

  • Clarify that install_command only takes one command - by @jugmac00 #2433

  • Documented problems with plugin and provision env - by @ziima. #2469

v3.26.0 (2022-09-07)

Bugfixes

  • Fix fallback to python environment when isolated_build = true is set – by @Unrud #2474

  • Fixed SetuptoolsDeprecationWarning about using --global-option – by @adamchainz #2478

Features

  • Use tomllib on Python 3.11 or later and tomli instead of toml library on lower versions - by @hroncok. #2463

v3.25.1 (2022-06-29)

Bugfixes

  • sitepackages = true will add user’s site-package to the python path on Windows as expected – by @niander #2402

  • Avoid importing pipes on Python 3.3+ to avoid DeprecationWarning on Python 3.11 – by @adamchainz #2417

  • Fix isolated_build when the build process produces stderr at exit. #2449

Documentation

  • Explain advantages of PIP_CONSTRAINT environment variable over --constraint argument. #2423

v3.25.0 (2022-04-11)

Bugfixes

  • Fixed failing isolated_build because setuptools warning was captured in build_requires. – by @zariiii9003 #2332

  • Avoid potential 30s delay caused by socket.getfqdn(). – by @ssbarnea #2375

Features

  • Ignore missing commands if they are prefixed by - – by @cdown. #2315

  • Add default environment variables (such as http_proxy) regardless of their case to passenv on UNIX – by @poggenhans. #2372

  • On Windows PROGRAMFILES, PROGRAMFILES(X86), and PROGRAMDATA environment variables are now passed through, unmasking system values necessary to locate resources such as a C compiler. #2382

Documentation

v3.24.5 (2021-12-29)

Bugfixes

  • Fixed an issue where usedevelop would cause an invocation error if setup.py does not exist. – by @VincentVanlaer #2197

v3.24.4 (2021-09-16)

Bugfixes

  • Fixed handling of -e ALL in parallel mode by ignoring the ALL in subprocesses – by @guahki. #2167

  • Prevent tox from using a truncated interpreter when using TOX_LIMITED_SHEBANG – by @jdknight. #2208

Documentation

  • Enabled the use of the favicon in the Sphinx docs first introduced in p764 but not integrated fully – @webknjaz #2177

v3.24.3 (2021-08-21)

Bugfixes

  • --parallel reports now show ASCII OK/FAIL/SKIP lines when full Unicode output is not available - by @brettcs #1421

Miscellaneous

  • Started enforcing valid references in Sphinx docs – @webknjaz #2168

v3.24.2 (2021-08-18)

Bugfixes

  • include LC_ALL to implicit list of passenv variables - by @ssbarnea #2162

v3.24.1 (2021-07-31)

Bugfixes

  • get_requires_for_build_sdist hook (PEP 517) is assumed to return an empty list if left unimplemented by the backend build system - by @oczkoisse #2130

Documentation

  • The documentation of install_command now also mentions that you can provide arbitrary commands - by @jugmac00 #2081

v3.24.0 (2021-07-14)

Bugfixes

  • --devenv no longer modifies the directory in which the .tox environment is provisioned - by @isaac-ped #2065

  • Fix show config when the package names are not in canonical form - by @gaborbernat. #2103

Documentation

Miscellaneous

  • tox no longer shows deprecation warnings for distutils.sysconfig on Python 3.10 - by @9999years #2100

v3.23.1 (2021-05-05)

Bugfixes

  • Distinguish between normal Windows Python and MSYS2 Python when looking for virtualenv executable path. Adds os.sep to InterpreterInfo - by @jschwartzentruber #1982

  • Fix a tox-conda isolation build bug - by @AntoineD. #2056

Documentation

  • Update examples in the documentation to use setenv in the [testenv] sections, not wrongly in the [tox] main section. - by @AndreyNautilus #1999

Miscellaneous

v3.23.0 (2021-03-03)

Features

  • tox can now be invoked with a new --no-provision flag that prevents provision, if requires or minversion are not satisfied, tox will fail; if a path is specified as an argument to the flag (e.g. as tox --no-provision missing.json) and provision is prevented, provision metadata are written as JSON to that path - by @hroncok #1921

  • Unicode support in pyproject.toml - by @domdfcoding #1940

v3.22.0 (2021-02-16)

Features

v3.21.4 (2021-02-02)

Bugfixes

  • Adapt tests not to assume the easy_install command exists, as it was removed from setuptools 52.0.0+ - by @hroncok #1893

v3.21.3 (2021-01-28)

Bugfixes

  • Fix a killed tox (via SIGTERM) leaving the commands subprocesses running by handling it as if it were a KeyboardInterrupt - by @dajose #1772

v3.21.2 (2021-01-19)

Bugfixes

  • Newer coverage tools update the COV_CORE_CONTEXT environment variable, add it to the list of environment variables that can change in our pytest plugin - by @gaborbernat. #1854

v3.21.1 (2021-01-13)

Bugfixes

  • Fix regression that broke using install_command in config replacements - by @jayvdb #1777

  • Fix regression parsing posargs default containing colon. - by @jayvdb #1785

Features

Miscellaneous

  • Enable building tox with setuptools_scm 4 and 5 by @hroncok #1799

v3.21.0 (2021-01-08)

Bugfixes

  • Fix the false congratulations message that appears when a KeyboardInterrupt occurs during package installation. - by @gnikonorov #1453

  • Fix platform support for install_command. - by @jayvdb #1464

  • Fixed regression in v3.20.0 that caused escaped curly braces in setenv to break usage of the variable elsewhere in tox.ini. - by @jayvdb #1690

  • Prevent {} and require {: is only followed by }. - by @jayvdb #1711

  • Raise MissingSubstitution on access of broken ini setting. - by @jayvdb #1716

Features

  • Allow { and } in default of {env:key:default}. - by @jayvdb #1502

  • Allow {posargs} in setenv. - by @jayvdb #1695

  • Allow {/} to refer to os.sep. - by @jayvdb #1700

  • Make parsing [testenv] sections in setup.cfg official. - by @mauvilsa #1727

  • Relax importlib requirement to allow 3.0.0 or any newer version - by @pkolbus #1763

Documentation

  • Document more info about using platform setting. - by @prakhargurunani #1144

  • Replace indexserver in documentation with environment variables - by @ziima. #1357

  • Document that the passenv environment setting is case insensitive. - by @gnikonorov #1534

v3.20.1 (2020-10-09)

Bugfixes

v3.20.0 (2020-09-01)

Bugfixes

  • Allow hyphens and empty factors in generative section name. - by @tyagdit #1636

  • Support for PEP517 in-tree build backend-path key in get-build-requires. - by @nizox #1654

  • Allow escaping curly braces in setenv. - by @mkenigs #1656

Features

  • Support for comments within setenv and environment files via the files| prefix. - by @gaborbernat #1667

v3.19.0 (2020-08-06)

Bugfixes

  • skip setup.cfg if it has no tox:tox namespace - by @hroncok #1045

Features

Documentation

  • Fixed grammar in top-level documentation - by @tfurf #1631

v3.18.1 (2020-07-28)

Bugfixes

  • Fix TypeError when using isolated_build with backends that are not submodules (e.g. maturin) #1629

v3.18.0 (2020-07-23)

Deprecations (removal in next major release)

  • Add allowlist_externals alias to whitelist_externals (whitelist_externals is now deprecated). - by @dajose #1491

v3.17.1 (2020-07-15)

Bugfixes

  • Fix tests when the HOSTNAME environment variable is set, but empty string - by @hroncok #1616

v3.17.0 (2020-07-14)

Features

  • The long arguments --verbose and --quiet (rather than only their short forms, -v and -q) are now accepted. #1612

  • The ResultLog now prefers HOSTNAME environment variable value (if set) over the full qualified domain name of localhost. This makes it possible to disable an undesired DNS lookup, which happened on all tox invocations, including trivial ones - by @hroncok #1615

Documentation

  • Update packaging information for Flit. #1613

v3.16.1 (2020-06-29)

Bugfixes

  • Fixed the support for using {temp_dir} in tox.ini - by @webknjaz #1609

v3.16.0 (2020-06-26)

Features

  • Allow skipping the package and installation step when passing the --skip-pkg-install. This should be used in pair with the --notest, so you can separate environment setup and test run:

    tox -e py --notest
tox -e py --skip-pkg-install

    by @gaborbernat. #1605

Miscellaneous

  • Improve config parsing performance by precompiling commonly used regular expressions - by @brettlangdon #1603

v3.15.2 (2020-06-06)

Bugfixes

  • Add an option to allow a process to suicide before sending the SIGTERM. - by @jhesketh #1497

  • PyPy 7.3.1 on Windows uses the Script folder instead of bin. - by @gaborbernat #1597

Miscellaneous

  • Allow to run the tests with pip 19.3.1 once again while preserving the ability to use pip 20.1 - by @hroncok #1594

v3.15.1 (2020-05-20)

Bugfixes

  • tox --showconfig no longer tries to interpolate ‘%’ signs. #1585

v3.15.0 (2020-05-02)

Bugfixes

  • Respect attempts to change PATH via setenv - by @aklajnert. #1423

  • Fix parsing of architecture in python interpreter name. - by @bruchar1 #1542

  • Prevent exception when command is empty. - by @bruchar1 #1544

  • Fix irrelevant Error message for invalid argument when running outside a directory with tox support files by @nkpro2000sr. #1547

Features

Documentation

  • Improve documentation about config by adding tox environment description at start - by @stephenfin. #1573

v3.14.6 (2020-03-25)

Bugfixes

  • Exclude virtualenv dependency versions with known regressions (20.0.[0-7]) - by @webknjaz. #1537

  • Fix tox -h and tox --hi shows an error when run outside a directory with tox support files by @nkpro2000sr. #1539

  • Fix ValueError on tox -l for a tox.ini file that does not contain an envlist definition. - by @jquast. #1343

v3.14.5 (2020-02-16)

Features

  • Add --discover (fallback to TOX_DISCOVER environment variable via path separator) to inject python executables to try as first step of a discovery - note the executable still needs to match the environment by @gaborbernat. #1526

v3.14.4 (2020-02-13)

Bugfixes

  • Bump minimal six version needed to avoid using one incompatible with newer virtualenv. - by @ssbarnea #1519

  • Avoid pypy test failure due to undefined printout var. - by @ssbarnea #1521

Features

  • Add interrupt_timeout and terminate_timeout that configure delay between SIGINT, SIGTERM and SIGKILL when tox is interrupted. - by @sileht #1493

  • Add HTTP_PROXY, HTTPS_PROXY and NO_PROXY to default passenv. - by @pfmoore #1498

v3.14.3 (2019-12-27)

Bugfixes

  • Relax importlib requirement to allow either version 0 or 1 - by @chyzzqo2 #1476

Miscellaneous

  • Clarify legacy setup.py error message: python projects should commit to a strong consistency of message regarding packaging. We no-longer tell people to add a setup.py to their already configured pep-517 project, otherwise it could imply that pyproject.toml isn’t as well supported and recommended as it truly is - by @graingert #1478

v3.14.2 (2019-12-02)

Bugfixes

  • Fix fallback to global configuration when running in Jenkins. - by @daneah #1428

  • Fix colouring on windows: colorama is a dep. - by @1138-4EB #1471

Miscellaneous

  • improve performance with internal lookup of Python version information - by @blueyed #1462

  • Use latest version of importlib_metadata package - by @kammala #1472

  • Mark poetry related tests as xfail since its dependency pyrsistent won’t install in ci due to missing wheels/build deps. - by @RonnyPfannschmidt #1474

v3.14.1 (2019-11-13)

Bugfixes

  • fix reporting of exiting due to (real) signals - by @blueyed #1401

  • Bump minimal virtualenv to 16.0.0 to improve own transitive deps handling in some ancient envs. — by @webknjaz #1429

  • Adds CURL_CA_BUNDLE, REQUESTS_CA_BUNDLE, SSL_CERT_FILE to the default passenv values. - by @ssbarnea #1437

  • Fix nested tox execution in the parallel mode by separating the environment variable that let’s tox know it is invoked in the parallel mode (_TOX_PARALLEL_ENV) from the variable that informs the tests that tox is running in parallel mode (TOX_PARALLEL_ENV). — by @hroncok #1444

  • Fix provisioning from a pyvenv interpreter. — by @kentzo #1452

Deprecations (removal in next major release)

v3.14.0 (2019-09-03)

Bugfixes

  • Fix PythonSpec detection of python3.10 - by @asottile #1374

  • Fix regression failing to detect future and past py## factors - by @asottile #1377

  • Fix current_tox_py for pypy / pypy3 - by @asottile #1378

  • Honor environment markers in requires list - by @asottile #1380

  • improve recreate check by allowing directories containing .tox-config1 (the marker file created by tox) - by @asottile #1383

  • Recognize correctly interpreters that have suffixes (like python3.7-dbg). #1415

Features

  • Add support for minor versions with multiple digits tox -e py310 works for python3.10 - by @asottile #1374

  • Remove dependence on md5 hashing algorithm - by @asottile #1384

Documentation

  • clarify behaviour if recreate is set to false - by @PJCampi #1399

Miscellaneous

  • Fix relative URLs to files in the repo in .github/PULL_REQUEST_TEMPLATE.md — by @webknjaz #1363

  • Replace importlib_metadata backport with importlib.metadata from the standard library on Python 3.8+ - by @hroncok #1367

  • Render the change fragment help on the docs/changelog/ directory view on GitHub — by @webknjaz #1370

v3.13.2 (2019-07-01)

Bugfixes

v3.13.1 (2019-06-25)

Bugfixes

v3.13.0 (2019-06-24)

Bugfixes

  • tox used Windows shell rules on non-Windows platforms when transforming positional arguments to a string - by @barneygale. #1336

Features

  • Replace pkg_resources with importlib_metadata for speed - by @asottile. #1324

  • Add the --devenv ENVDIR option for creating development environments from [testenv] configurations - by @asottile. #1326

  • Refuse to delete envdir if it doesn’t look like a virtualenv - by @asottile. #1340

v3.12.1 (2019-05-23)

Bugfixes

  • Ensure TOX_WORK_DIR is a native string in os.environ - by @asottile. #1313

  • Fix import and usage of winreg for python2.7 on windows - by @asottile. #1315

  • Fix Windows selects incorrect spec on first discovery - by @gaborbernat #1317

v3.12.0 (2019-05-23)

Bugfixes

  • When using --parallel with --result-json the test results are now included the same way as with serial runs - by @fschulze #1295

  • Turns out the output of the py -0p is not stable yet and varies depending on various edge cases. Instead now we read the interpreter values directly from registry via PEP-514 - by @gaborbernat. #1306

Features

  • Adding TOX_PARALLEL_NO_SPINNER environment variable to disable the spinner in parallel mode for the purposes of clean output when using CI tools - by @zeroshift #1184

v3.11.1 (2019-05-16)

Bugfixes

  • When creating virtual environments we no longer ask the python to tell its path, but rather use the discovered path. #1301

v3.11.0 (2019-05-15)

Features

  • --showconfig overhaul:

    • now fully generated via the config parser, so anyone can load it by using the built-in python config parser

    • the tox section contains all configuration data from config

    • the tox section contains a host_python key detailing the path of the host python

    • the tox:version section contains the versions of all packages tox depends on with their version

    • passing -l now allows only listing default target envs

    • allows showing config for a given set of tox environments only via the -e cli flag or the TOXENV environment variable, in this case the tox and tox:version section is only shown if at least one verbosity flag is passed

    this should help inspecting the options. #1298

v3.10.0 (2019-05-13)

Bugfixes

  • fix for tox -l command: do not allow setting the TOXENV or the -e flag to override the listed default environment variables, they still show up under extra if non defined target - by @gaborbernat #720

  • tox ignores unknown CLI arguments when provisioning is on and outside of the provisioned environment (allowing provisioning arguments to be forwarded freely) - by @gaborbernat #1270

Features

  • Virtual environments created now no longer upgrade pip/wheel/setuptools to the latest version. Instead the start packages after virtualenv creation now is whatever virtualenv has bundled in. This allows faster virtualenv creation and builds that are easier to reproduce. #448

  • Improve python discovery and add architecture support:

    • UNIX:

      • First, check if the tox host Python matches.

      • Second, check if the the canonical name (e.g. python3.7, python3) matches or the base python is an absolute path, use that.

      • Third, check if the the canonical name without version matches (e.g. python, pypy) matches.

    • Windows:

      • First, check if the tox host Python matches.

      • Second, use the py.exe to list registered interpreters and any of those match.

      • Third, check if the the canonical name (e.g. python3.7, python3) matches or the base python is an absolute path, use that.

      • Fourth, check if the the canonical name without version matches (e.g. python, pypy) matches.

      • Finally, check for known locations (c:\python{major}{minor}\python.exe).

    tox environment configuration generation is now done in parallel (to alleviate the slowdown due to extra checks). #1290

v3.9.0 (2019-04-17)

Bugfixes

  • Fix congratulations when using ^C during virtualenv creation - by @asottile #1257

Features

v3.8.6 (2019-04-03)

Bugfixes

v3.8.5 (2019-04-03)

Bugfixes

v3.8.4 (2019-04-01)

Bugfixes

  • Fix sdist creation on python2.x when there is non-ascii output. #1234

  • fix typos in isolated.py that made it impossible to install package with requirements in pyproject.toml - by @unmade #1236

v3.8.3 (2019-03-29)

Bugfixes

  • don’t crash when version information is not available for a proposed base python - by @gaborbernat #1227

  • Do not print exception traceback when the provisioned tox fails - by @gaborbernat #1228

v3.8.2 (2019-03-29)

Bugfixes

  • using -v and -e connected (as -ve) fails - by @gaborbernat #1218

  • Changes to the plugin tester module (cmd no longer sets PYTHONPATH), and action.popen no longer returns the command identifier information from within the logs. No public facing changes. #1222

  • Spinner fails in CI on UnicodeEncodeError - by @gaborbernat #1223

v3.8.1 (2019-03-28)

Bugfixes

  • The -eALL command line argument now expands the envlist key and includes all its environment. #1155

  • Isolated build environment dependency overrides were not taken in consideration (and such it inherited the deps from the testenv section) - by @gaborbernat #1207

  • --result-json puts the command into setup section instead of test (pre and post commands are now also correctly put into the commands section) - by @gaborbernat #1210

  • Set setup.cfg encoding to UTF-8 as it contains Unicode characters. #1212

  • Fix tox CI, better error reporting when locating via the py fails - by @gaborbernat #1215

v3.8.0 (2019-03-27)

Bugfixes

  • In a posix shell, setting the PATH environment variable to an empty value is equivalent to not setting it at all; therefore we no longer if the user sets PYTHONPATH an empty string on python 3.4 or later - by @gaborbernat. #1092

  • Fixed bug of children process calls logs clashing (log already exists) - by @gaborbernat #1137

  • Interpreter discovery and virtualenv creation process calls that failed will now print out on the screen their output (via the logfile we automatically save) - by @gaborbernat #1150

  • Using py2 and py3 with a specific basepython will no longer raise a warning unless the major version conflicts - by @demosdemon. #1153

  • Fix missing error for tox -e unknown when tox.ini declares envlist. - by @medmunds #1160

  • Resolve symlinks with toxworkdir - by @blueyed. #1169

  • Interrupting a tox call (e.g. via CTRL+C) now will ensure that spawn child processes (test calls, interpreter discovery, parallel sub-instances, provisioned hosts) are correctly stopped before exiting (via the pattern of INTERRUPT - 300 ms, TERMINATE - 200 ms, KILL signals) - by @gaborbernat #1172

  • Fix a ResourceWarning: unclosed file in Action - by @BoboTiG. #1179

  • Fix deadlock when using --parallel and having environments with lots of output - by @asottile. #1183

  • Removed code that sometimes caused a difference in results between --parallel and -p when using posargs - by @timdaman #1192

Features

  • tox now auto-provisions itself if needed (see tox auto-provisioning). Plugins or minimum version of tox no longer need to be manually satisfied by the user, increasing their ease of use. - by @gaborbernat #998

  • tox will inject the TOX_PARALLEL_ENV environment variable, set to the current running tox environment name, only when running in parallel mode. - by @gaborbernat #1139

  • Parallel children now save their output to a disk logfile - by @gaborbernat #1143

  • Parallel children now are added to --result-json - by @gaborbernat #1159

  • Display pattern and sys.platform with platform mismatch - by @blueyed. #1176

  • Setting the environment variable TOX_REPORTER_TIMESTAMP to 1 will enable showing for each output line its delta since the tox startup. This can be especially handy when debugging parallel runs.- by @gaborbernat #1203

Documentation

v3.7.0 (2019-01-11)

Features

Deprecations (removal in next major release)

  • Whitelisting of externals will be mandatory in tox 4: issue a deprecation warning as part of the already existing warning - by @obestwalter #1129

Documentation

  • Clarify explanations in examples and avoid unsupported end line comments - by @obestwalter #1110

  • Set to PULL_REQUEST_TEMPLATE.md use relative instead of absolute URLs - by @evandrocoan Fixed PULL_REQUEST_TEMPLATE.md path for changelog/examples.rst to docs/changelog/examples.rst - by @evandrocoan #1120

v3.6.1 (2018-12-24)

Features

  • if the packaging phase successfully builds a package set it as environment variable under TOX_PACKAGE (useful to make assertions on the built package itself, instead of just how it ends up after installation) - by @gaborbernat (#1081)

v3.6.0 (2018-12-13)

Bugfixes

  • On windows, check sys.executable before others for interpreter version lookup. This matches what happens on non-windows. (#1087)

  • Don’t rewrite {posargs} substitution for absolute paths. (#1095)

  • Correctly fail tox --notest when setup fails. (#1097)

Documentation

Miscellaneous

  • Include the license file in the wheel distribution - by @jdufresne. (#1083)

v3.5.3 (2018-10-28)

Bugfixes

  • Fix bug with incorrectly defactorized dependencies - by @bartsanchez (#706)

  • do the same transformation to egg_info folders that pkg_resources does; this makes it possible for hyphenated names to use the develop-inst-noop optimization (cf. 910), which previously only worked with non-hyphenated egg names - by @hashbrowncipher (#1051)

  • previously, if a project’s setup.py --name emitted extra information to stderr, tox would capture it and consider it part of the project’s name; now, emissions to stderr are printed to the console - by @hashbrowncipher (#1052)

  • change the way we acquire interpreter information to make it compatible with jython interpreter, note to create jython envs one needs virtualenv > 16.0 which will be released later @gaborbernat (#1073)

Documentation

  • document substitutions with additional content starting with a space cannot be alone on a line inside the ini file - by @gaborbernat (#437)

  • change the spelling of a single word from contrains to the proper word, constraints - by @metasyn (#1061)

  • Mention the minimum version required for commands_pre/commands_post support. (#1071)

v3.5.2 (2018-10-09)

Bugfixes

  • session packages are now put inside a numbered directory (instead of prefix numbering it, because pip fails when wheels are not named according to PEP-491, and prefix numbering messes with this) - by @gaborbernat (#1042)

Features

v3.5.1 (2018-10-08)

Bugfixes

  • fix regression with 3.5.0: specifying --installpkg raises AttributeError: 'str' object has no attribute 'basename' (#1042)

v3.5.0 (2018-10-08)

Bugfixes

  • intermittent failures with --parallel--safe-build, instead of mangling with the file paths now uses a lock to make the package build operation thread safe and is now on by default (--parallel--safe-build is now deprecated) - by @gaborbernat (#1026)

Features

  • Added temp_dir folder configuration (defaults to {toxworkdir}/.tmp) that contains tox temporary files. Package builds now create a hard link (if possible, otherwise copy - notably in case of Windows Python 2.7) to the built file, and feed that file downstream (e.g. for pip to install it). The hard link is removed at the end of the run (what it points though is kept inside distdir). This ensures that a tox session operates on the same package it built, even if a parallel tox run builds another version. Note distdir will contain only the last built package in such cases. - by @gaborbernat (#1026)

Documentation

v3.4.0 (2018-09-20)

Bugfixes

  • add --exists-action w to default pip flags to handle better VCS dependencies (pip documentation on this) - by @gaborbernat (#503)

  • instead of assuming the Python version from the base python name ask the interpreter to reveal the version for the ignore_basepython_conflict flag - by @gaborbernat (#908)

  • PEP-517 packaging fails with sdist already exists, fixed via ensuring the dist folder is empty before invoking the backend and pypa/setuptools 1481 - by @gaborbernat (#1003)

Features

  • add commands_pre and commands_post that run before and after running the commands (setup runs always, commands only if setup succeeds, teardown always - all run until the first failing command) - by @gaborbernat (#167)

  • pyproject.toml config support initially by just inline the tox.ini under tool.tox.legacy_tox_ini key; config source priority order is pyproject.toml, tox.ini and then setup.cfg - by @gaborbernat (#814)

  • use the os environment variable TOX_SKIP_ENV to filter out tox environment names from the run list (set by envlist) - by @gaborbernat (#824)

  • always set PIP_USER=0 (do not install into the user site package, but inside the virtual environment created) and PIP_NO_DEPS=0 (installing without dependencies can cause broken package installations) inside tox - by @gaborbernat (#838)

  • tox will inject some environment variables that to indicate a command is running within tox: TOX_WORK_DIR env var is set to the tox work directory, TOX_ENV_NAME is set to the current running tox environment name, TOX_ENV_DIR is set to the current tox environments working dir - by @gaborbernat (#847)

  • While running tox invokes various commands (such as building the package, pip installing dependencies and so on), these were printed in case they failed as Python arrays. Changed the representation to a shell command, allowing the users to quickly replicate/debug the failure on their own - by @gaborbernat (#851)

  • skip missing interpreters value from the config file can now be overridden via the --skip-missing-interpreters cli flag - by @gaborbernat (#903)

  • keep additional environments config order when listing them - by @gaborbernat (#921)

  • allow injecting config value inside the ini file dependent of the fact that we’re connected to an interactive shell or not via exposing a {tty} substitution - by @gaborbernat (#947)

  • do not build sdist if skip install is specified for the envs to be run - by @gaborbernat (#974)

  • when verbosity level increases above two start passing through verbosity flags to pip - by @gaborbernat (#982)

  • when discovering the interpreter to use check if the tox host Python matches and use that if so - by @gaborbernat (#994)

  • -vv will print out why a virtual environment is re-created whenever this operation is triggered - by @gaborbernat (#1004)

Documentation

  • clarify that python and pip refer to the virtual environments executable - by @gaborbernat (#305)

  • add Sphinx and mkdocs example of generating documentation via tox - by @gaborbernat (#374)

  • specify that setup.cfg tox configuration needs to be inside the tox:tox namespace - by @gaborbernat (#545)

v3.3.0 (2018-09-11)

Bugfixes

  • fix TOX_LIMITED_SHEBANG when running under python3 - by @asottile (#931)

Features

Miscellaneous

  • Updated the VSTS build YAML to use the latest jobs and pools syntax - by @davidstaheli (#955)

v3.2.1 (2018-08-10)

Bugfixes

  • --parallel--safe-build no longer cleans up its folders (distdir, distshare, log). - by @gaborbernat (#849)

v3.2.0 (2018-08-10)

Features

  • Switch pip invocations to use the module -m pip instead of direct invocation. This could help avoid some of the shebang limitations. - by @gaborbernat (#935)

  • Ability to specify package requirements for the tox run via the tox.ini (tox section under key requires - PEP-508 style): can be used to specify both plugin requirements or build dependencies. - by @gaborbernat (#783)

  • Allow one to run multiple tox instances in parallel by providing the --parallel--safe-build flag. - by @gaborbernat (#849)

v3.1.3 (2018-08-03)

Bugfixes

  • A caching issue that caused the develop-inst-nodeps action, which reinstalls the package under test, to always run has been resolved. The develop-inst-noop action, which, as the name suggests, is a no-op, will now run unless there are changes to setup.py or setup.cfg files that have not been reflected - by @stephenfin (#909)

Features

  • Python version testenvs are now automatically detected instead of comparing against a hard-coded list of supported versions. This enables py38 and eventually py39 / py40 / etc. to work without requiring an upgrade to tox. As such, the following public constants are now deprecated (and scheduled for removal in tox 4.0: CPYTHON_VERSION_TUPLES, PYPY_VERSION_TUPLES, OTHER_PYTHON_INTERPRETERS, and DEFAULT_FACTORS - by @asottile (#914)

Documentation

  • Add a system overview section on the index page that explains briefly how tox works - by @gaborbernat. (#867)

v3.1.2 (2018-07-12)

Bugfixes

  • Revert “Fix bug with incorrectly defactorized dependencies (#772)” due to a regression ((#799)) - by @obestwalter

v3.1.1 (2018-07-09)

Bugfixes

  • PyPI documentation for 3.1.0 is broken. Added test to check for this, and fix it by @gaborbernat. (#879)

v3.1.0 (2018-07-08)

Bugfixes

  • Add ignore_basepython_conflict, which determines whether conflicting basepython settings for environments containing default factors, such as py27 or django18-py35, should be ignored or result in warnings. This was a common source of misconfiguration and is rarely, if ever, desirable from a user perspective - by @stephenfin (#477)

  • Fix bug with incorrectly defactorized dependencies (deps passed to pip were not de-factorized) - by @bartsanchez (#706)

Features

  • Add support for multiple PyPy versions using default factors. This allows you to use, for example, pypy27 knowing that the correct interpreter will be used by default - by @stephenfin (#19)

  • Add support to explicitly invoke interpreter directives for environments with long path lengths. In the event that tox cannot invoke scripts with a system-limited shebang (e.x. a Linux host running a Jenkins Pipeline), a user can set the environment variable TOX_LIMITED_SHEBANG to workaround the system’s limitation (e.x. export TOX_LIMITED_SHEBANG=1) - by @jdknight (#794)

  • introduce a constants module to be used internally and as experimental API - by @obestwalter (#798)

  • Make py2 and py3 aliases also resolve via py on windows by @asottile. This enables the following things: tox -e py2 and tox -e py3 work on windows (they already work on posix); and setting basepython=python2 or basepython=python3 now works on windows. (#856)

  • Replace the internal version parsing logic from the not well tested PEP-386 parser for the more general PEP-440. packaging >= 17.1 is now an install dependency by @gaborbernat. (#860)

Documentation

  • extend the plugin documentation and make lot of small fixes and improvements - by @obestwalter (#797)

  • tidy up tests - remove unused fixtures, update old cinstructs, etc. - by @obestwalter (#799)

  • Various improvements to documentation: open browser once documentation generation is done, show Github/Travis info on documentation page, remove duplicate header for changelog, generate unreleased news as DRAFT on top of changelog, make the changelog page more compact and readable (width up to 1280px) by @gaborbernat (#859)

Miscellaneous

v3.0.0 (2018-04-02)

Bugfixes

  • Write directly to stdout buffer if possible to prevent str vs bytes issues - by @asottile (#426)

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

  • (only affected rc releases) fix up tox.cmdline to be callable without args - by @gaborbernat. (#773)

  • (only affected rc releases) Revert breaking change of tox.cmdline not callable with no args - by @gaborbernat. (#773)

  • (only affected rc releases) fix #755 by reverting the cmdline import to the old location and changing the entry point instead - by @fschulze (#755)

Features

  • tox displays exit code together with InvocationError - by @blueyed and @ederag. (#290)

  • Hint for possible signal upon InvocationError, on posix systems - by @ederag and @asottile. (#766)

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

  • add support for negated factor conditions, e.g. !dev: production_log - by @jurko-gospodnetic (#292)

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

Documentation

  • Change favicon to the vector beach ball - by @hazalozturk (#748)

  • Change sphinx theme to alabaster and add logo/favicon - by @hazalozturk (#639)

Miscellaneous

  • Running tox without a setup.py now has a more friendly error message and gives troubleshooting suggestions - by @Volcyy. (#331)

  • Fix pycodestyle (formerly pep8) errors E741 (ambiguous variable names, in this case, ‘l’s) and remove ignore of this error in tox.ini - by @cryvate (#663)

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

v2.9.1 (2017-09-29)

Miscellaneous

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

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

Miscellaneous

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)

v2.8.2 (2017-10-09)

  • #466: stop env var leakage if popen failed with resultjson or redirect

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

v2.8.0 (2017-09-01)

  • #276: Remove easy_install from docs (TL;DR: use pip). Thanks Martin Andrysík (@sifuraz).

  • #301: Expand nested substitutions in tox.ini. Thanks @vlaci. Thanks to Eli Collins (@eli-collins) for creating a reproducer.

  • #315: add --help and --version to helptox-quickstart. Thanks @vlaci.

  • #326: Fix OSError ‘Not a directory’ when creating env on Jython 2.7.0. Thanks Nick Douma (@LordGaav).

  • #429: Forward MSYSTEM by default on Windows. Thanks Marius Gedminas (@mgedmin) for reporting this.

  • #449: add multi platform example to the docs. Thanks Aleks Bunin (@sashkab) and @rndr.

  • #474: Start using setuptools_scm for tag based versioning.

  • #484: Renamed py.test to pytest throughout the project. Thanks Slam (@3lnc).

  • #504: With -a: do not show additional environments header if there are none. Thanks @rndr.

  • #515: Don’t require environment variables in test environments where they are not used. Thanks André Caron (@AndreLouisCaron).

  • #517: Forward NUMBER_OF_PROCESSORS by default on Windows to fix multiprocessor.cpu_count(). Thanks André Caron (@AndreLouisCaron).

  • #518: Forward USERPROFILE by default on Windows. Thanks André Caron (@AndreLouisCaron).

  • pull request 528: Fix some of the warnings displayed by pytest 3.1.0. Thanks Bruno Oliveira (@nicoddemus).

  • pull request 547: Add regression test for #137. Thanks Martin Andrysík (@sifuraz).

  • pull request 553: Add an XFAIL test to reproduce upstream bug #203. Thanks Bartolomé Sánchez Salado (@bartsanchez).

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

  • pull request 580: Do not ignore Sphinx warnings anymore. Thanks Bernát Gábor (@gaborbernat).

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

  • pull request 588: Run pytest with xfail_strict and adapt affected tests.

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

  • #271 and #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 (@gaborbernat).

  • #464: Fix incorrect egg-info location for modified package_dir in setup.py. Thanks Selim Belhaouane (@selimb).

  • #431: Add ‘LANGUAGE’ to default passed environment variables. Thanks Paweł Adamczak (@pawelad).

  • #455: Add a Vagrantfile with a customized Arch Linux box for local testing. Thanks Oliver Bestwalter (@obestwalter).

  • #454: Revert pull request 407, empty commands is not treated as an error. Thanks Anthony Sottile (@asottile).

  • #446: (infrastructure) Travis CI tests for tox now also run on OS X now. Thanks Jason R. Coombs (@jaraco).

v2.6.0 (2017-02-04)

  • add “alwayscopy” config option to instruct virtualenv to always copy files instead of symlinking. Thanks Igor Duarte Cardoso (@igordcard).

  • pass setenv variables to setup.py during a usedevelop install. Thanks Eli Collins (@eli-collins).

  • replace all references to testrun.org with readthedocs ones. Thanks Oliver Bestwalter (@obestwalter).

  • fix #323 by avoiding virtualenv14 is not used on py32 (although we don’t officially support py32). Thanks Jason R. Coombs (@jaraco).

  • add Python 3.6 to envlist and CI. Thanks Andrii Soldatenko (@andriisoldatenko).

  • fix glob resolution from TOX_TESTENV_PASSENV env variable Thanks Allan Feldman (@a-feld).

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

  • fix #359: add COMSPEC to default passenv on windows. Thanks @anthrotype.

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

  • fix #348: add py2 and py3 as default environments pointing to “python2” and “python3” basepython executables. Also fix #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 #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 #399. Make sure {envtmpdir} is created if it doesn’t exist at the start of a testenvironment run. Thanks Manuel Jacob.

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

v2.4.1 (2016-10-12)

  • fix #380: properly perform substitution again. Thanks Ian Cordasco.

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

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

  • fix #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 #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 #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)

v2.3.2 (2016-02-11)

  • fix #314: fix command invocation with .py scripts on windows.

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

v2.3.1 (2015-12-14)

  • fix #294: re-allow cross-section substitution for setenv.

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

  • fix #289: fix build_sphinx target, thanks Barry Warsaw.

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

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

v2.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 #99: the {env:…} substitution now properly uses environment settings from the setenv section. Thanks Itxaka Serrano.

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

  • fix #280: properly skip missing interpreter if {envsitepackagesdir} is present in commands. Thanks BB:ceridwenv

v2.1.1 (2015-06-23)

  • fix platform skipping for detox

  • report skipped platforms as skips in the summary

v2.1.0 (2015-06-19)

  • fix #258, fix #248, fix #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 #259: passenv is now a line-list which allows interspersing 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.

v2.0.2 (2015-06-03)

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

v2.0.1 (2015-05-13)

  • fix wheel packaging to properly require argparse on py26.

v2.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 one 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 #233: avoid hanging with tox-setuptools integration example. Thanks simonb.

  • fix #120: allow substitution for the commands section. Thanks Volodymyr Vitvitski.

  • fix #235: fix AttributeError with –installpkg. Thanks Volodymyr Vitvitski.

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

  • fix #240: allow one 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/hookspecs.py 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

v1.9.2 (2015-03-23)

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

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

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

  • fix #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 #11: add a skip_install per-testenv setting which prevents the installation of a package. Thanks Julian Krause.

  • fix #124: ignore command exit codes; when a command has a “-” prefix, tox will ignore the exit code of that command

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

  • fix #191: lessen factor-use checks

v1.8.1 (2014-10-24)

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

v1.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 #148: remove “__PYVENV_LAUNCHER__” from os.environ when starting subprocesses. Thanks Steven Myint.

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

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

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

v1.7.1 (2014-03-28)

  • fix #162: don’t list python 2.5 as compatible/supported

  • fix #158 and fix #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.

v1.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 one 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 #132: removing zip_safe setting (so it defaults to false) to allow installation of tox via easy_install/eggs. Thanks Jenisys.

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

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

  • fix #105 – don’t depend on an existing HOME directory from tox tests.

v1.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 #118: correctly have two tests use realpath(). Thanks Barry Warsaw.

  • 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 one to use relative path like in “-rrequirements.txt”.

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

  • fix #1: empty setup files are properly detected, thanks Anthon van der Neuth

  • remove toxbootstrap.py for now because it is broken.

  • fix #109 and fix #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/interpreters.py file, tests in tests/test_interpreters.py.

v1.5.0 (2013-06-22)

  • fix #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 #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 #97 - allow substitutions to reference from other sections (thanks Krisztian Fekete)

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

v1.4.3 (2013-02-28)

  • use pip-script.py 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 #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 #72) (thanks g2p)

  • 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 #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 #34)

  • the “py” environment now by default uses the current interpreter (sys.executable) make tox’ own setup.py test execute tests with it (closes #46)

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

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

v1.4.1 (2012-07-03)

  • fix #41 better quoting on windows - you can now use “<” and “>” in deps specifications, thanks Chris Withers for reporting

v1.4 (2012-06-13)

  • fix #26 - no warnings on absolute or relative specified paths for commands

  • fix #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 #29 - correctly point to pytest explanation for importing modules fully qualified

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

v1.3 2011-12-21

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

  • fix 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)

v1.2 2011-11-10

  • 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 #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)

v1.1 (2011-07-08)

  • fix #5 - don’t require argparse for python versions that have it

  • fix #6 - recreate virtualenv if installing dependencies failed

  • fix #3 - fix example on frontpage

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

  • rework and enhance docs for display on readthedocs.org

v1.0

  • move repository and toxbootstrap links to https://bitbucket.org/hpk42/tox

  • fix #7: introduce a “minversion” directive such that tox bails out if it does not have the correct version.

  • fix #24: introduce a way to set environment variables for for test commands (thanks Chris Rose)

  • fix #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 agents) now follows the latest release of virtualenv

  • fix #20: document format of URLs for specifying dependencies

  • fix #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 #15 and #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

v0.9

  • fix pip-installation mixups by always unsetting PIP_RESPECT_VIRTUALENV (thanks Armin Ronacher)

  • #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)

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

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

  • addressing #4: always prepend venv-path to PATH variable when calling subprocesses

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

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

  • fix long description, thanks Michael Foord

v0.5

  • initial release