Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

ZC Buildout recipe for setting up elasticsearch.

Project description

A brief documentation

This recipe takes a number of options:

The URL to download the jar.


We will define a buildout template used by the recipe:

>>> buildout_cfg = """
... [buildout]
... parts = elasticsearch
... [elasticsearch]
... recipe = koansys.recipe.elasticsearch
... url =
... """

We’ll start by creating a buildout:

>>> import os.path
>>> write('buildout.cfg', buildout_cfg)

Running the buildout gives us:

>>> output = system(buildout)
>>> 'koansys.recipe.elasticsearch: downloading elasticsearch distribution...' in output

Check whether the binaries are copied:

>>> set(os.listdir('bin')).issuperset(['elasticsearch'])

A start script with the format ‘’ should be generated.

>>> '' in os.listdir('bin')

It is possible to change the name of this start script with the ‘script_name’ option. Furthermore all options of mongod (version v1.6.0) are supported via buildout options. A more comprehensive recipe could be for example:

>>> buildout_cfg = """
... [buildout]
... parts =
... [elasticsearch]
... recipe = koansys.recipe.elasticsearch
... url =
... script_name =
... quiet=true
... fork=true
... logpath=${buildout:parts-directory}/elasticsearch/log
... dbpath=${buildout:parts-directory}/elasticsearch/data
... """

1.0.2 2013-01-17

  • PyPI release

1.0.0 2010-11-30

  • Initial release

Project details

Release history Release notifications

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date (14.0 kB) Copy SHA256 hash SHA256 Source None Jan 17, 2013

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