Skip to main content

simple buildout recipe for django projects

Project description

This buildout recipe can be used to create the necessary commands to replace in a buildout environment. Optionally it can also generate scripts for wsgi and fcgi.

simple example:

parts = django
eggs =

recipe = djangoprojectrecipe
settings = myproject.settings
eggs = ${buildout:eggs}
extra-paths = src
project = myproject

Supported options

The recipe supports the following options.

This option sets the name for your project package.
You can set the name of the settings file which is to be used with this option. This is useful if you want to have a different production setup from your development setup. It defaults to project.settings.
All paths specified here will be used to extend the default Python path for the bin/* scripts. It is recommended to define these directly in the [buildout] section and juste reference them. See the examples.
The name of the script created in the bin folder. This script is the equivalent of the Django normally creates. By default it uses the name of the section (the part between the [ ]).
An extra script is generated in the bin folder when this is set to true. This can be used with mod_wsgi to deploy the project. The name of the script is control-script.wsgi.
Like wsgi this creates an extra script within the bin folder. This script can be used with an FCGI deployment.
In case the WSGI server you’re using does not allow printing to stdout, you can set this variable to a filesystem path - all stdout/stderr data is redirected to the log instead of printed. The same logfile will be used for fcgi. You can use the base directory for relative paths: logfile = ${buildout:directory}/log/django.log
The main entry point for all management commands. By default, this is djangoprojectrecipe.manage.main. Use this setting if you have to do some custom setup on management commands.

FCGI specific settings

Options for FCGI can be set within a settings file ( The options is FCGI_OPTIONS. It should be set to a dictionary. The part below is an example:

    'method': 'threaded',

Another example

The next example shows you how to use some more of the options. Here we seperate out eggs and extra-paths onto the buildout configuration and use it both in a part to get a general python interpreter and a django instance with the same paths:

parts =
eggs =
extra-paths =

django = 1.2.4

recipe = zc.recipe.egg
interpreter = python
eggs = ${buildout:eggs}
extra-paths = ${buildout:extra-paths}
scripts =

recipe = djangoprojectrecipe
settings = myproject.settings_live
wsgi = true
eggs = ${buildout:eggs}
extra-paths = ${buildout:extra-paths}

Using django trunk

djangoprojectrecipe does not handle installing django at all. The easiest case is when installing released versions from pypi (just add django to eggs). If you want to use django trunk or some special branch, infrae.subversion may be of service:

develop =
parts =
eggs =


recipe = infrae.subversion
urls =

recipe = djangoprojectrecipe
settings = myproject.settings_dev
eggs = ${buildout:eggs}
extra-paths = ${buildout:extra-paths}

Don’t forget to add svn to parts and parts/svn/django/ to develop. Also you should remove the specific version setting from [versions] for django, because otherwise buildout will continue to use the packaged version.

See for more examples.

Example configuration for mod_wsgi

If you want to deploy a project using mod_wsgi you could use this example as a starting point:

<Directory /path/to/buildout>
       Order deny,allow
       Allow from all
       ServerName      my.rocking.server
       CustomLog       /var/log/apache2/my.rocking.server/access.log combined
       ErrorLog        /var/log/apache2/my.rocking.server/error.log
       WSGIScriptAlias / /path/to/buildout/bin/django.wsgi


1.1.2 (2011-12-02)

  • added support custom start scripts

1.1.1 (2011-05-18)

  • added support for buildout relative-paths

1.1.0 (2011-03-17)

  • removed a lot of unneeded functionality that can be solved by other recipes


  • djangoprojectrecipe was forked from djangorecipe

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for djangoprojectrecipe, version 1.1.2
Filename, size File type Python version Upload date Hashes
Filename, size djangoprojectrecipe-1.1.2.tar.gz (7.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page