tox is a a young project and still considered beta. Bug reports, feedback, contributions welcome: see support and contact channels.
tox aims to automate state-of-the-art packaging, testing and deployment of Python software right from your console or CI server, invoking your tools of choice.
Tox as is a generic virtualenv management and test command line tool you can use for:
First, install tox with pip install tox or easy_install tox. Then put basic information about your project and the test environments you want your project to run in into a tox.ini file residing right 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 against Python2.6 and Python2.7, just type:
and watch things happening (you must have python2.6 and python2.7 installed in your environment otherwise you will see errors). When you run tox a second time you’ll note that it runs much faster because it keeps track of virtualenv details and will not recreate or re-install dependencies. You also might want to checkout tox configuration and usage examples to get some more ideas.
automation of tedious Python related test activities
test your Python package against many interpreter and dependency configs
- automatic customizable (re)creation of virtualenv test environments
- installs your setup.py based project into each virtual environment
- test-tool agnostic: runs py.test, nose or unittests a uniform manner
cross-Python compatible: Python2.4 up to Python2.7, Jython and experimental Python3 support as well as for pypy
cross-platform: Windows and Unix style environments
integrates with continous integration servers like Hudson and helps you to avoid boilerplatish and platform-specific build-step hacks.
unified automatic artifact management between tox runs both in a local developer shell as well as in a CI/Hudson context.
driven by a simple ini-style config file
concise reporting about tool invocations and configuration errors