| 1 |
:orphan: |
| 2 |
|
| 3 |
##### |
| 4 |
tox |
| 5 |
##### |
| 6 |
|
| 7 |
************************************************ |
| 8 |
virtualenv-based automation of test activities |
| 9 |
************************************************ |
| 10 |
|
| 11 |
:Manual section: 1 |
| 12 |
:Manual group: User Commands |
| 13 |
|
| 14 |
SYNOPSIS |
| 15 |
======== |
| 16 |
|
| 17 |
**tox** [*options*] [**run** | **run-parallel** | **depends** | **man** | **list** | **devenv** | **schema** | |
| 18 |
**config** | **quickstart** | **exec** | **legacy**] [*command-options*] |
| 19 |
|
| 20 |
DESCRIPTION |
| 21 |
=========== |
| 22 |
|
| 23 |
tox aims to automate and standardize testing in Python. It is part of a larger vision of easing the packaging, testing |
| 24 |
and release process of Python software. |
| 25 |
|
| 26 |
tox creates virtual environments for multiple Python versions, installs project dependencies, and runs tests in each |
| 27 |
environment. It supports parallel execution, custom test commands, and extensive configuration. |
| 28 |
|
| 29 |
COMMANDS |
| 30 |
======== |
| 31 |
|
| 32 |
**run** (*or* **r**) |
| 33 |
run environments |
| 34 |
|
| 35 |
**run-parallel** (*or* **p**) |
| 36 |
run environments in parallel |
| 37 |
|
| 38 |
**depends** (*or* **de**) |
| 39 |
visualize tox environment dependencies |
| 40 |
|
| 41 |
**man** |
| 42 |
Set up tox man page for current shell |
| 43 |
|
| 44 |
**list** (*or* **l**) |
| 45 |
list environments |
| 46 |
|
| 47 |
**devenv** (*or* **d**) |
| 48 |
sets up a development environment at ENVDIR based on the tox configuration specified |
| 49 |
|
| 50 |
**schema** |
| 51 |
Generate schema for tox configuration |
| 52 |
|
| 53 |
**config** (*or* **c**) |
| 54 |
show tox configuration |
| 55 |
|
| 56 |
**quickstart** (*or* **q**) |
| 57 |
Command line script to quickly create a tox config file for a Python project |
| 58 |
|
| 59 |
**exec** (*or* **e**) |
| 60 |
execute an arbitrary command within a tox environment |
| 61 |
|
| 62 |
**legacy** (*or* **le**) |
| 63 |
legacy entry-point command |
| 64 |
|
| 65 |
For command-specific help, use: **tox** *command* **--help** |
| 66 |
|
| 67 |
OPTIONS |
| 68 |
======= |
| 69 |
|
| 70 |
**-h**, **--help** |
| 71 |
show this help message and exit |
| 72 |
|
| 73 |
**--colored** |
| 74 |
should output be enriched with colors, default is yes unless TERM=dumb or NO_COLOR is defined. |
| 75 |
|
| 76 |
**--stderr-color** |
| 77 |
color for stderr output, use RESET for terminal defaults. |
| 78 |
|
| 79 |
**-v**, **--verbose** |
| 80 |
increase verbosity |
| 81 |
|
| 82 |
**-q**, **--quiet** |
| 83 |
decrease verbosity |
| 84 |
|
| 85 |
**--exit-and-dump-after** *seconds* |
| 86 |
dump tox threads after n seconds and exit the app - useful to debug when tox hangs, 0 means disabled |
| 87 |
|
| 88 |
**-c**, **--conf** *file* |
| 89 |
configuration file/folder for tox (if not specified will discover one) |
| 90 |
|
| 91 |
**--workdir** *dir* |
| 92 |
tox working directory (if not specified will be the folder of the config file) |
| 93 |
|
| 94 |
**--root** *dir* |
| 95 |
project root directory (if not specified will be the folder of the config file) |
| 96 |
|
| 97 |
**--runner** |
| 98 |
the tox run engine to use when not explicitly stated in tox env configuration |
| 99 |
|
| 100 |
**--version** |
| 101 |
show program's and plugins version number and exit |
| 102 |
|
| 103 |
**--no-provision** *REQ_JSON* |
| 104 |
do not perform provision, but fail and if a path was provided write provision metadata as JSON to it |
| 105 |
|
| 106 |
**--no-recreate-provision** |
| 107 |
if recreate is set do not recreate provision tox environment |
| 108 |
|
| 109 |
**-r**, **--recreate** |
| 110 |
recreate the tox environments |
| 111 |
|
| 112 |
**-x**, **--override** |
| 113 |
configuration override(s), e.g., -x testenv:pypy3.ignore_errors=True |
| 114 |
|
| 115 |
FILES |
| 116 |
===== |
| 117 |
|
| 118 |
**tox.toml** |
| 119 |
Primary configuration file in TOML format (recommended). |
| 120 |
|
| 121 |
**tox.ini** |
| 122 |
Configuration file in INI format. |
| 123 |
|
| 124 |
**pyproject.toml** |
| 125 |
Alternative configuration location under the ``[tool.tox]`` section. |
| 126 |
|
| 127 |
**setup.cfg** |
| 128 |
Legacy configuration location (deprecated). |
| 129 |
|
| 130 |
The configuration files are searched in the order listed above. The first file found is used. |
| 131 |
|
| 132 |
ENVIRONMENT VARIABLES |
| 133 |
===================== |
| 134 |
|
| 135 |
``TOX_*`` |
| 136 |
Any tox configuration setting can be overridden via environment variables with the ``TOX_`` prefix. |
| 137 |
|
| 138 |
**NO_COLOR** |
| 139 |
When set to any non-empty value, disables colored output. |
| 140 |
|
| 141 |
**FORCE_COLOR** |
| 142 |
When set to any non-empty value, forces colored output even when stdout is not a terminal. |
| 143 |
|
| 144 |
**TOX_PARALLEL_NO_SPINNER** |
| 145 |
When set, disables the progress spinner during parallel execution. |
| 146 |
|
| 147 |
SEE ALSO |
| 148 |
======== |
| 149 |
|
| 150 |
Full documentation: https://tox.wiki/ |
| 151 |
|
| 152 |
**pip**\(1), **pytest**\(1), **virtualenv**\(1) |
| 153 |
|
| 154 |
AUTHOR |
| 155 |
====== |
| 156 |
|
| 157 |
tox development team |
| 158 |
|
| 159 |
https://github.com/tox-dev/tox |