Setup recipes

dockeroo:setup.cmmi

class dockeroo.setup.cmmi.SetupCmmiRecipe(buildout, name, options)[source]

A recipe to configure, make and make install:

Example:

>>> with buildout_test('''
... [buildout]
... parts = part
... find-links =
...     https://pypi.python.org/simple/future/
...     https://pypi.python.org/simple/setuptools/
...     https://pypi.python.org/simple/shellescape/
...     https://pypi.python.org/simple/tzlocal/
...
... [part]
... recipe = dockeroo:setup.cmmi
... url = %(server)sdata/package-0.0.0.tar.gz
... ''' % dict(server=server_url)) as b:
...     print_(b.run(), end='')
Installing part.
dockeroo: Downloading <URL>
dockeroo: Configuring with: "./configure --prefix=<PATH>"
dockeroo: configure
dockeroo: Building with: "make"
dockeroo: building package
dockeroo: Installing with: "make install"
dockeroo: building package

dockeroo:setup.download

class dockeroo.setup.download.SetupDownloadRecipe(buildout, name, options)[source]

A recipe to download a remote package or to copy a local package.

Example:

>>> with buildout_test(
... '''
... [buildout]
... parts = part
... find-links =
...     https://pypi.python.org/simple/future/
...     https://pypi.python.org/simple/setuptools/
...     https://pypi.python.org/simple/shellescape/
...     https://pypi.python.org/simple/tzlocal/
...
... [part]
... recipe = dockeroo:setup.download
... url = %(server)sdata/package-0.0.0.tar.gz
... patches =
...     patches/configure.patch
...     patches/Makefile.dist.patch
... ''' % dict(server=server_url)) as b:
...    print_(b.run(), end='')
Installing part.
dockeroo: Downloading <URL>
dockeroo: Applying patch: "patches/configure.patch"
dockeroo: patching file configure
dockeroo: Applying patch: "patches/Makefile.dist.patch"
dockeroo: patching file Makefile.dist

git clone and update:

>>> with buildout_test(
... '''
... [buildout]
... parts = part
... download-cache = ${buildout:directory}/downloads
... find-links =
...     https://pypi.python.org/simple/future/
...     https://pypi.python.org/simple/setuptools/
...     https://pypi.python.org/simple/shellescape/
...     https://pypi.python.org/simple/tzlocal/
...
... [part]
... recipe = dockeroo:setup.download
... url = git+https://github.com/buildout/buildout.git
... verbose = true
... repository-subpath = doc
... ''') as b:
...    mkdir(sample_buildout, 'downloads')
...    print_(b.run(), end='')
...    print_(b.run(), end='')
Installing part.
dockeroo: Downloading <URL>
dockeroo: Running command: git clone -q --bare "<URL>" "<PATH>"
dockeroo: Running command: git read-tree "master"
dockeroo: Running command: git checkout-index -q -a -f --prefix="<PATH>"
Updating part.
dockeroo: Downloading <URL>
dockeroo: Running command: git fetch -q origin
dockeroo: Running command: git checkout-index -q -a -f --prefix="<PATH>"

dockeroo:setup.egg

class dockeroo.setup.egg.SetupEggRecipe(buildout, name, options)[source]

A recipe to build an egg package.

Example:

>>> with buildout_test('''
... [buildout]
... index = %(server)sdata/index.html
... find-links =
...     %(server)sdata/dummy/index.html
...     https://pypi.python.org/simple/future/
...     https://pypi.python.org/simple/setuptools/
...     https://pypi.python.org/simple/shellescape/
...     https://pypi.python.org/simple/tzlocal/
... parts = part
...
... [part]
... recipe = dockeroo:setup.egg
... egg = dummy
... ''' % dict(server=server_url)) as b:
...     print_(b.run(), end='')
Installing part.
dockeroo: Getting distribution for 'dummy'.
dockeroo: Downloading <URL>
dockeroo: Building: dummy-0.1-py2.7
dockeroo: Got dummy-0.1-py2.7.

dockeroo:setup.python-script

class dockeroo.setup.python_script.SetupPythonScriptRecipe(buildout, name, options)[source]

A recipe to run an installation script.

Example:

>>> with buildout_test('''
... [buildout]
... index = http://pypi.python.org/simple/
... parts = part
...
... [part]
... recipe = dockeroo:setup.python-script
... script =
... ''') as b:
...     print_(b.run(), end='')
Installing part.

dockeroo:setup.shell-script

class dockeroo.setup.shell_script.SetupShellScriptRecipe(buildout, name, options)[source]

A recipe to run an installation script.

Example:

>>> with buildout_test('''
... [buildout]
... index = http://pypi.python.org/simple/
... parts = part
...
... [part]
... recipe = dockeroo:setup.shell-script
... script = echo "HELLO."
... ''') as b:
...     print_(b.run(), end='')
Installing part.
HELLO.

dockeroo:setup.template

class dockeroo.setup.template.SetupTemplateRecipe(buildout, name, options)[source]

A recipe to run an installation script.

Example:

>>> import os
>>> with buildout_test('''
... [buildout]
... index = http://pypi.python.org/simple/
... parts = part
...
... [part]
... recipe = dockeroo:setup.template
... test-string = HELLO
... content = ${:test-string}
... output-path = ${buildout:directory}/test.txt
... ''') as b:
...     print_(b.run(), end='')
...     print_(open(os.path.join(sample_buildout, 'test.txt'), 'rb').read())
Installing part.
HELLO