skip to navigation
skip to content

Not Logged In

collective.recipe.environment 0.2.0

zc.buildout recipe to set environment variables during the execution of a buildout.

Overview

This recipe allows to set and get environment variables during the execution of a buildout.

The recipe mirrors the current environment variables into its section, so that e.g. ${environment:USER} will give the current user.

To set an environment variable you just set it in the section.

The environment variables are set and get during the initialization of the Recipe instance, i.e. after buildout.cfg is read but before any recipe is installed or updated.

Example usage: Use an environment variable

We'll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = environment print
...
... [some-section]
... some-option = ${environment:SOME_VARIABLE}
...
... [environment]
... recipe = collective.recipe.environment
...
... [print]
... recipe = mr.scripty
... install =
...     ... print self.buildout['some-section']['some-option']
...     ... return []
... """)

The mr.scripty recipe is used to print out the value of the ${some-section:some-option} option.

Now we set the environment variable:

>>> import os
>>> os.environ['SOME_VARIABLE'] = 'some_value'

Running the buildout gives us:

>>> print 'start', system(buildout)
start...
some_value
<BLANKLINE>

Example usage: Set an environment variable

We'll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = environment print
...
... [some-section]
... some-option = value2
...
... [environment]
... recipe = collective.recipe.environment
... var1 = value1
... var2 = ${some-section:some-option}
...
... [print]
... recipe = mr.scripty
... install =
...     ... import os
...     ... for var in ('var1', 'var2'):
...     ...     print '%s = %s' % (var, os.environ[var])
...     ... return []
... """)

The mr.scripty recipe is used to print out the values of the environment variables.

Running the buildout gives us:

>>> print 'start', system(buildout)
start...
var1 = value1
var2 = value2
<BLANKLINE>

Similar recipes

The functionality to mirror the environment variables into the recipe's section is largely copied from gocept.recipe.env.

Contributors

Rafael Oliveira, Author

Changelog

0.2.0 (2012-08-21)

  • Now it's possible to read environment variables.

0.1b1 (2011-08-18)

  • First release.
 
File Type Py Version Uploaded on Size
collective.recipe.environment-0.2.0.tar.gz (md5) Source 2012-08-21 4KB
  • Downloads (All Versions):
  • 9 downloads in the last day
  • 246 downloads in the last week
  • 723 downloads in the last month