summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Meyer <carl@oddbird.net>2013-08-14 15:24:23 -0600
committerCarl Meyer <carl@oddbird.net>2013-08-14 15:24:23 -0600
commit57d104e109a9b9c3a3daf147a769e63d92e6bd2b (patch)
treeceb9a288b24e56e7deffd69a94ab292ae908cb6f
parent174908b35143583a7ef6117cbc3d25a3c008d665 (diff)
downloadtox-57d104e109a9b9c3a3daf147a769e63d92e6bd2b.tar.gz
Add doc examples of using easy_install and pip install --find-links.
-rw-r--r--doc/example/basic.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/example/basic.txt b/doc/example/basic.txt
index 031c4f9..a8209f7 100644
--- a/doc/example/basic.txt
+++ b/doc/example/basic.txt
@@ -109,6 +109,35 @@ like this::
tox -i DEV=http://pypi.python.org/simple # changes :DEV: package URLs
tox -i http://pypi.python.org/simple # changes default
+further customizing installation
+---------------------------------
+
+.. versionadded:: 1.6
+
+By default tox uses `pip`_ to install packages (both the sdist of your
+package-under-test and any dependencies you specify in ``tox.ini``) into each
+test virtualenv, with a command-line like ``pip install --pre
+SomePackage==1.0``.
+
+You can fully customize tox's install-command in your ``tox.ini`` with the
+``install_command`` option. For instance, to use ``easy_install`` instead of
+`pip`_::
+
+ [testenv]
+ install_command = easy_install {packages}
+
+Or to use pip's ``--find-links`` and ``--no-index`` options to specify an
+alternative source for your dependencies::
+
+ [testenv]
+ install_command = pip install --pre --find-links http://packages.example.com --no-index {opts} {packages}
+
+(Including ``{opts}`` is only necessary if you want your install command to
+also respect tox's options for setting the download cache and package index
+server).
+
+.. _pip: http://pip-installer.org
+
forcing re-creation of virtual environments
-----------------------------------------------