1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
Basic usage
=============================================
a simple tox.ini / default environments
-----------------------------------------------
Put basic information about your project and the test environments you
want your project to run in into a ``tox.ini`` file that should
reside next to your ``setup.py`` file::
# content of: tox.ini , put in same dir as setup.py
[tox]
envlist = py26,py27
[testenv]
commands=py.test # or 'nosetests' or ...
To sdist-package, install and test your project, you can
now type at the command prompt::
tox
This will sdist-package your current project, create two virtualenv_
Environments, install the sdist-package into the environments and run
the specified command in each of them. With::
tox -e py26
you can run restrict the test run to the python2.6 environment.
Available "default" test environments names are::
py24
py25
py26
py27
py30
py31
py32
py33
jython
pypy
However, you can also create your own test environment names,
see some of the examples in :doc:`examples <../examples>`.
whitelisting a non-virtualenv commands
-----------------------------------------------
.. versionadded:: 1.5
Sometimes you may want to use tools not contained in your
virtualenv such as ``make``, ``bash`` or others. To avoid
warnings you can use the ``whitelist_externals`` testenv
configuration::
# content of tox.ini
[testenv]
whitelist_externals = make
/bin/bash
.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _multiindex:
using a different default PyPI url
-----------------------------------------------
.. versionadded:: 0.9
To install dependencies and packages from a different
default PyPI server you can type interactively::
tox -i http://pypi.testrun.org
This causes tox to install dependencies and the sdist install step
to use the specificied url as the index server.
You can cause the same effect by this ``tox.ini`` content::
[tox]
indexserver =
default = http://pypi.testrun.org
installing dependencies from multiple PyPI servers
---------------------------------------------------
.. versionadded:: 0.9
You can instrument tox to install dependencies from
different PyPI servers, example::
[tox]
indexserver =
DEV = http://mypypiserver.org
[testenv]
deps =
docutils # comes from standard PyPI
:DEV:mypackage # will be installed from custom "DEV" pypi url
This configuration will install ``docutils`` from the default
Python PYPI server and will install the ``mypackage`` from
our ``DEV`` indexserver, and the respective ``http://mypypiserver.org``
url. You can override config file settings from the command line
like this::
tox -i DEV=http://pypi.python.org/simple # changes :DEV: package URLs
tox -i http://pypi.python.org/simple # changes default
forcing re-creation of virtual environments
-----------------------------------------------
.. versionadded:: 0.9
To force tox to recreate a (particular) virtual environment::
tox --recreate -e py27
would trigger a complete reinstallation of the existing py27 environment
(or create it afresh if it doesn't exist).
setting environment variables
-------------------------------------------
.. versionadded:: 1.0
If you need to set an environment variable like ``PYTHONPATH`` you
can use the ``setenv`` directive::
[testenv]
setenv =
PYTHONPATH = {toxinidir}/subdir
When your test commands execute they will execute with
a PYTHONPATH setting that will lead Python to also import
from the ``subdir`` below the directory where your ``tox.ini``
file resides.
Integration with setuptools/distribute test commands
----------------------------------------------------
Distribute/Setuptools support test requirements
and you can extend its test command to trigger
a test run when ``python setup.py test`` is issued::
from setuptools.command.test import test as TestCommand
import sys
class Tox(TestCommand):
def finalize_options(self):
TestCommand.finalize_options(self)
self.test_args = []
self.test_suite = True
def run_tests(self):
#import here, cause outside the eggs aren't loaded
import tox
errno = tox.cmdline(self.test_args)
sys.exit(errno)
setup(
#...,
tests_require=['tox'],
cmdclass = {'test': Tox},
)
Now if you run::
python setup.py test
this will install tox and then run tox.
|
