diff options
Diffstat (limited to 'doc/index.txt')
| -rw-r--r-- | doc/index.txt | 123 |
1 files changed, 0 insertions, 123 deletions
diff --git a/doc/index.txt b/doc/index.txt deleted file mode 100644 index e1bc20e..0000000 --- a/doc/index.txt +++ /dev/null @@ -1,123 +0,0 @@ -Welcome to the tox automation project -=============================================== - -vision: standardize testing in Python ---------------------------------------------- - -``tox`` aims to automate and standardize testing in Python. It is part -of a larger vision of easing the packaging, testing and release process -of Python software. - -What is Tox? --------------------- - -Tox is a generic virtualenv_ management and test command line tool you can use for: - -* checking your package installs correctly with different Python versions and - interpreters - -* running your tests in each of the environments, configuring your test tool of choice - -* acting as a frontend to Continuous Integration servers, greatly - reducing boilerplate and merging CI and shell-based testing. - - -Basic example ------------------ - -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] - deps=pytest # install pytest in the venvs - commands=py.test # or 'nosetests' or ... - -You can also try generating a ``tox.ini`` file automatically, by running -``tox-quickstart`` and then answering a few simple questions. - -To sdist-package, install and test your project against Python2.6 and Python2.7, just type:: - - tox - -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 :doc:`examples` to get some more ideas. - -Current features -------------------- - -* **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 in a uniform manner - -* :doc:`(new in 2.0) plugin system <plugins>` to modify tox execution with simple hooks. - -* uses pip_ and setuptools_ by default. Support for configuring the installer command - through :confval:`install_command=ARGV`. - -* **cross-Python compatible**: CPython-2.6, 2.7, 3.2 and higher, - Jython and pypy_. - -* **cross-platform**: Windows and Unix style environments - -* **integrates with continuous integration servers** like Jenkins_ - (formerly known as Hudson) and helps you to avoid boilerplatish - and platform-specific build-step hacks. - -* **full interoperability with devpi**: is integrated with and - is used for testing in the devpi_ system, a versatile pypi - index server and release managing tool. - -* **driven by a simple ini-style config file** - -* **documented** :doc:`examples <examples>` and :doc:`configuration <config>` - -* **concise reporting** about tool invocations and configuration errors - -* **professionally** :doc:`supported <support>` - -* supports :ref:`using different / multiple PyPI index servers <multiindex>` - - -.. _pypy: http://pypy.org - -.. _`tox.ini`: :doc:configfile - -.. toctree:: - :hidden: - - install - examples - config - config-v2 - support - changelog - links - plugins - example/result - announce/release-0.5 - announce/release-1.0 - announce/release-1.1 - announce/release-1.2 - announce/release-1.3 - announce/release-1.4 - announce/release-1.4.3 - announce/release-1.8 - announce/release-1.9 - announce/release-2.0 - - -.. include:: links.txt |