Buildout Recipes

Recipes are the plugin mechanism provided by Buildout to add new functionalities to your software building. You can read the Developing Buildout Recipes to learn more about creating Buildout recipes.

This is a list of Buildout recipes created by the community. All the recipes listed here are available from PyPI . You can see a complete list of recipes in PyPI .

If you are adding a recipe to PyPI, please use the Framework :: Buildout trove classifier, so that it will be automatically listed in the PyPI list .

The Recipes with their short description are as follows :

zc.recipe.egg

zc.recipe.egg is a buildout recipe to install Python package distributions as eggs

zc.zope3recipes

zc.zope3recipes is a buildout recipe to define Zope 3 applications

djangorecipe

djangorecipeRecipe is a buildout recipe for Django .

plone.recipe.apache

plone.recipe.apache is a buildout recipe to build and configure apache.

z3c.recipe.ldap

z3c.recipe.ldap is a buildout recipe to deploy an OpenLDAP server.

gp.recipe.pip

gp.recipe.pip is a buildout recipe to to install python packages using pip. More

fez.djangoskel

fez.djangoskel is a buildout recipes for creating Django applications as eggs.

z3c.recipe.eggbasket

z3c.recipe.eggbasket is a buildout recipe to install eggs from a tarball and create that egg.

tl.buildout_gtk

tl.buildout_gtk is a buildout recipe to install PyGTK, PyObject and PyCairo.

rod.recipe.appengine

rod.recipe.appengine is a buildout to set up a google appengine development environment.

buildout_script

buidlout_scripe is a zc.buidlout recipe which is used for generating scripts from template file. The scripts are generated from templates and the buildout-variables get replaced by actual data at run time.

cc.buildout_reports

The cc.bulidout_reports:xxx can be used to scan a project for comments flagged with a specifed pattern (XXX|TODO by default). The recipe does not scan temporary files (*~) or traverse into egg and .svn directories.

cc.gettext

The cc.gettext:msgfmt can be used to compile gettext catalogs from the .po source format to the binary .mo representation needed by Zope 3.

Collective.recipe.ant

Collective.recipe.ant executes an ant build. It assumes java, and and ant is installed on the system.

collective.recipe.backup

collective.recipe.backup provides sensible defaults for your common backup tasks. bin/repozo is a zope script to make backups of your Data.fs.

collective.recipe.bootstrap

collective.recipe.bootstrap is used to automatically update the bootstrap.py file in buildout directory.

collective.recipe.i18noverrides

collective.recipe.i18noverrides is a buildout recipe which creates an i18n directory within one or more zope 2 instances in your buildout. It copies some .po files to those directories. The translations in those .po files will override any other translations.

collective.recipe.isapiwsgi

collective.recipe.isapiwsgi is a zc.buildout recipe which creates a paste.deploy entry point for isapi-wsgi.

collective.recipe.libsvm

collective.recipe.libsvm is a recipe to compile libsvm with python in a buildout

collective.recipe.minify

collective.recipe.minify is a minify-wrapper for CSS & JavaScript resources for removing all the unnecessary white spaces and comments.

collective.recipe.modwsgi

collective.recipe.modwsgi is a collective.recipe.modwsgi’’ is a zc.buildout recipe which creates a paste.deploy entry point for mod_wsgi.

collective.recipe.mxbase

collective.recipe.mxbase is a buildout recipe to install eGenix mx.base

collective.recipe.mxodbc

collective.recipe.mxodbc is a buildout recipe to install eGenix mx.ODBC and a license.

collective.recipe.omelette

collective.recipe.omelette is a buidlout recipe which creates a unified directory structure of all namespace packages, symlinking to the actual contents, in order to ease navigation.

collective.recipe.patch

collective.recipe.patch is a buildout recipe for patching eggs.

collective.recipe.platform

collective.recipe.platform is a buildout recipe which provide buildout variables with platform specific values.

collective.recipe.plonesite

collective.recipe.plonesite is a buildout recipe to create and update a plone site. This recipe enables you to create and update a Plone site as part of a buildout run. This recipe only aims to run profiles and Quickinstall products. It is assumed that the install methods, setuphandlers, upgrade steps, and other recipes will handle the rest of the work.

collective.recipe.rsync_datafs

collective.recipe.rsync_datafs is a simple zc.buildout recipe to to synchronize data from one place to another. Typically, it is used to transfer a Zope Data.fs file from production to development.

It assumes you have a UNIX-based operating system and that the rsync binary is in your path when you run buildout.

collective.recipe.scriptgen

collective.recipe.scriptgen is a zc.buildout recipe for generating a script.

collective.recipe.seleniumrc

collective.recipe.seleniumrc is a zc.buildout recipe for installing the Selenium RC distribution. This package downloads and installs Selenium RC using zc.buildout. It is based on hexagonit.recipe.download.

collective.recipe.solrinstance

collective.recipe.solrinstance is a zc.buildout to configure a solr instance.

collective.recipe.sphinxbuilder

collective.recipe.sphinxbuilder is a zc.buildout recipe to generate and build Sphinx-based documentation in the buildout.

collective.recipe.supervisor

collective.recipe.supervisor is a buildout recipe to install supervisor.

collective.recipe.template

collective.recipe.template is a buildout recipe to generate a text file from a template.

collective.recipe.updateplone

collective.recipe.updateplone is a buildout recipe to update plone sites.

collective.recipe.vimproject

collective.recipe.vimproject is a buildout recipe to set up a VIM development environment.

collective.recipe.z2testrunner

collective.recipe.z2testrunner is a buildout recipe for generating zope2-based test runner. A zc.buildout recipe for generating test runners that run under a Zope 2 environment and is “Products”-aware.

collective.recipe.zcml

collective.recipe.zcml is a buildout recipe to create zcml slugs. ZCML slug generation to be used separately e.g for repoze based setups.

collective.recipe.zope2cluster

collective.recipe.zope2cluster is a buildout recipe to create a zope cluster.

NOTE: This recipe is no longer needed as of zc.buildout 1.4.

collective.recipe.zope2wsgi

collective.recipe.zope2wsgi is a buildout recipe to generate zope instances using repoze.zope2.

collective.transcode.recipe

collective.transcode.recipe is a buildout recipe to setup a transcode daemon.

gocept.cxoracle

gocept.cxoracle is a zc.buildout recipe for installing cx_Oracle.

gocept.download

gocept.download is a zc.buildout recipe for downloading and extracting an archive.

iw.recipe.cmd

iw.recipe.cmd is a zc.buildout recipe to execute a command line.

zc.recipe.cmmi

zc.recipe.cmmi is a zc.buildout recipe for configure/make/make install. The configure-make-make-install recipe automates installation of configure-based source distribution into buildouts.

zc.recipe.filestorage

zc.recipe.filestorage is a zc.buildout recipe for defining a file-storage.

z3c.recipe.mkdir

z3c.recipe.mkdir is a buildout recipe to create directories.

z3c.recipe.sphinxdoc

z3c.recipe.sphinxdoc is a buildout recipe which use Sphinx to build documentation for zope.org.

z3c.recipe.template

z3c.recipe.template is a buildout recipe to generate a text file from a template.

zest.recipe.mysql

zest.recipe.mysql is a buildout recipe to setup a MySQL database.

zc.sshtunnel

zc.sshtunnel is a zc.buildout recipe to manage an SSH tunnel.

zeomega.recipe.mxodbcconnect

zeomega.recipe.mxodbcconnect is a buildout recipe to install eGenix mx.ODBCConnect.Client.

zc.recipe.icu

zc.recipe.icu is a zc.buildout recipe for installing the ICU library into a buildout.

z3c.recipe.filetemplate

z3c.recipe.filetemplate is a zc.buildout recipe for creating files from file templates.

tl.buildout_apache

tl.buildout_apache is a zc.buildout recipes for setting up an Apache web server environment.

plone.recipe.zeoserver

plone.recipe.zeoserver is a zc.buildout recipe for installing a ZEO server.

plone.recipe.varnish

plone.recipe.varnish is a buildout recipe to install varnish.

plone.recipe.zope2install

plone.recipe.zope2install is a zc.buildout recipe for installing Zope 2.

plone.recipe.zope2instance

plone.recipe.zope2instance is a zc.buildout recipe for installing a Zope 2 instance.

plone.recipe.zope2zeoserver

plone.recipe.zope2zeoserver is a zc.buildout recipe for installing a Zope 2 ZEO server.

hexagonit.recipe.download

hexagonit.recipe.download is a zc.buildout recipe for downloading and extracting packages.

amplecode.recipe.template

amplecode.recipe.template is a buildout recipe for making files out of Jinja2 templates.

gocept.recipe.env

gocept.recipe.env is a buildout recipe which provides a section for Mirror environment variables.

hexagonit.recipe.cmmi

hexagonit.recipe.cmmi is a zc.buildout recipe for compiling and installing source distributions.

iw.recipe.sendmail

iw.recipe.sendmail is a zc.buildout recipe to setup zope.sendmail in a Zope2 instance.

plone.recipe.runscript

plone.recipe.runscript is a buildout recipe to run a zope script.

tl.buildout_virtual_python

tl.buildout_virtual_python is a zc.buildout recipe for creating a virtual Python installation.

gocept.ctl

gocept.ctl is a zc.buildout recipe to create a convenience-script for controlling services.

djangout

djangout is a buildout recipes for Django.

gocept.zope3instance

gocept.zope3instance is a zc.buildout recipe for defining a Zope 3 instance.

z3c.recipe.staticlxml

z3c.recipe.staticlxml is a buildout recipe to build lxml.

z3c.recipe.tag

z3c.recipe.tag is a buildout recipe to generate ctags from eggs for development.

z3c.recipe.usercrontab

z3c.recipe.usercrontab is a user Crontab install buildout recipe.