Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
224 lines (175 sloc) 6.45 KB
This buildout recipe can be used to create a setup for Django. It will
automatically download Django and install it in the buildout's
sandbox. You can use either a release version of Django or a
subversion checkout (by using `trunk` instead of a version number.
You can see an example of how to use the recipe below::
parts = satchmo django
eggs = ipython
recipe =
url =
md5sum = 659a4845c1c731be5cfe29bfcc5d14b1
recipe = djangorecipe
version = trunk
settings = development
eggs = ${buildout:eggs}
extra-paths =
project = dummyshop
Supported options
The recipe supports the following options.
This option sets the name for your project. The recipe will create a
basic structure if the project is not already there.
Use this instead of the project option when you want to use an egg
as the project. This disables the generation of the project
This option can be used to specify a specific Python version which can be a
different version from the one used to run the buildout.
The version argument can accept a few different types of
arguments. You can specify `trunk`. In this case it will do a
checkout of the Django trunk. Another option is to specify a release
number like `0.96.2`. This will download the release
tarball. Finally you can specify a full svn url (including the
revision number). An example of this would be
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
Set this to a folder somewhere on you system to speed up
installation. The recipe will use this folder as a cache for a
downloaded version of Django.
All paths specified here will be used to extend the default Python
path for the `bin/*` scripts.
Adds paths found from a site `.pth` file to the extra-paths.
Useful for things like Pinax which maintains its own external_libs dir.
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`.
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
Like `wsgi` this creates an extra script within the bin folder. This
script can be used with an FCGI deployment.
If you want a script in the bin folder to run all the tests for a
specific set of apps this is the option you would use. Set this to
the list of app labels which you want to be tested.
This is the name of the testrunner which will be created. It
defaults to `test`.
By specifying `git` option, you can pull your code from a Git repository.
Using `true` sets the repository to the GitHub mirror of Django,
`git://`. Anything else uses that
repo as your clone repository. When `git` is used, `version` is expected
to be a valid `tree-ish` within the repository to use for the clone.
All following options only have effect when the project specified by
the project option has not been created already.
You can set this to a specific url conf. It will use project.urls by
The secret to use for the ``, it generates a random
string by default.
Another example
The next example shows you how to use some more of the options::
parts = django extras
eggs =
recipe = iw.recipe.subversion
urls = django-command-extensions django-mptt
recipe = djangorecipe
version = trunk
settings = development
project = exampleproject
wsgi = true
eggs =
test =
Example using .pth files
Pinax uses a .pth file to add a bunch of libraries to its path; we can
specify it's directory to get the libraries it specified added to our
parts = PIL
recipe = zc.recipe.egg:custom
egg = PIL
find-links =
recipe = iw.recipe.subversion
urls = pinax
recipe = djangorecipe
version = 1.0.2
eggs = PIL
project = myproject
settings = settings
extra-paths = ${buildout:directory}/myproject/apps
pth-files = ${svncode:location}/pinax/libs/external_libs
wsgi = true
Above, we use stock Pinax for pth-files and extra-paths paths for
apps, and our own project for the path that will be found first in the
list. Note that we expect our project to be checked out (e.g., by
svn:external) directly under this directory in to 'myproject'.
Example with a different Python version
To use a different Python version from the one that ran buildout in the
generated script use something like::
parts = myproject
executable = /some/special/python
recipe = djangorecipe
version = 1.0.2
project = myproject
python = special-python
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