envdir 0.4.1

Command line

Quoting the envdir documentation:

envdir runs another program with environment modified according to files in a specified directory.

Interface:

envdir d child

d is a single argument. child consists of one or more arguments.

envdir sets various environment variables as specified by files in the directory named d. It then runs child.

If d contains a file named s whose first line is t, envdir removes an environment variable named s if one exists, and then adds an environment variable named s with value t. The name s must not contain =. Spaces and tabs at the end of t are removed. Nulls in t are changed to newlines in the environment variable.

If the file s is completely empty (0 bytes long), envdir removes an environment variable named s if one exists, without adding a new variable.

envdir exits 111 if it has trouble reading d, if it runs out of memory for environment variables, or if it cannot run child. Otherwise its exit code is the same as that of child.

Alternatively you can also use the python -m envdir form to call envdir.

Python

To use envdir in a Python file (e.g. Django’s manage.py) you can use:

import envdir
envdir.read()

envdir will try to find an envdir directory next to the file you modified.

It’s also possible to explicitly pass the path to the envdir:

import os
import envdir

envdir.read('/home/jezdez/mysite/envs/prod')

Shell

envdir also includes an optional CLI tool called envshell which launches a subshell using the given directory. It basically allows you to make a set of environment variable stick to your current shell session if you happen to use envdir a lot outside of simple script use.

For example:

$ envshell ~/mysite/envs/prod/
Launching envshell for /home/jezdez/mysite/envs/prod. Type 'exit' or 'Ctrl+D' to return.
$ python manage.py runserver
..

To leave the subshell, simply use the exit command or press Ctrl+D.

0.4.1 (08/21/2013)

• Fixed envdir.read() to actually work with already existing environment variables. Extended docs to test Python use.

0.4 (08/09/2013)

• Added envshell command which launches a subshell using the environment as defined in the given envdir. Example:

  $ envshell ~/mysite/envs/prod/
  Launching envshell for /home/jezdez/mysite/envs/prod. Type 'exit' or 'Ctrl+D' to return.
  $ python manage.py runserver
  ..

0.3 (07/30/2013)

• Catch KeyboardInterrupt exceptions to not show a traceback from envdir but the repsonse from the called command.

• Allow multiline environment variables. Thanks to Horst Gutmann for the suggestion. This is a departure from daemontools’ standard which only allows the first line of the environment variable file.

0.2.1 (07/11/2013)

• Fixed python -m envdir

• Extended README to better describe the purpose

0.2 (07/10/2013)

• Added ability to use envdir from Python.

0.1 (07/10/2013)

• Initial release.