Supported options

The recipe supports the following options:

virtualenv

Virtualenv directory. The virtualenv is build in this directory (Default to parts/pip). You can also use an existing one. If a virtualenv option is found in the buildout section then this one is used except if the current section override it.

env

extra environement vars used with subprocess

indexes

Extra indexes url.

install

A list of string passed to pip directly. A sub process is run per line. This allow to use --install-option.

editables

A list of svn url. (svn+http://myrepo/svn/MyApp#egg=MyApp)

eggs

A list of distribution to install with buildout

This recipe is based on zc.recipe.egg#scripts so options used by this recipe should also works.

Example usage

We'll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = test1
...
... [test1]
... recipe = gp.recipe.pip
... install =
...     PasteScript
... interpreter = python
... scripts =
...     paster = paster
... """)

Running the buildout gives us:

>>> print 'start', system(buildout)
start...
Installing test1.
Creating new virtualenv environment ...
...
Successfully installed PasteScript
...
Generated script '/sample-buildout/bin/paster'.
Generated interpreter '/sample-buildout/bin/python'.
<BLANKLINE>

Scripts are generated:

>>> ls('bin')
-  buildout
-  paster
-  python

With the virtualenv binary as executable:

>>> print 'cat', cat('bin', 'Paster')
cat .../parts/pip/bin/python
...

Complete Example

Here is a config file used to install Deliverance:

[buildout]
parts = eggs
download-cache = download
versions = versions

[versions]
# the recipe take care of versions
lxml=2.2alpha1

[eggs]
recipe = gp.recipe.pip

# needed to build static libs for lxml
env =
    STATIC_DEPS=true

# packages to install with pip
install =
    Cython
    lxml
    http://deliverance.openplans.org/dist/Deliverance-snapshot-latest.pybundle

# packages to install with buildout
eggs =
    pyquery

# svn urls
editables =
    svn+http://...

0.4 (2008-12-20)

• allow to use extra env vars
• fix bug with editables
• allow to share virtualenvs / build_dir between buildouts
• avoid duplicated installation by buildout

0.3 (2008-12-7)

• Fixes: Always install a virtualenv. Split line arguments for install

0.2 (2008-12-7)

• Fix error when no download cache is set [Gael Pasgrimaud].