envdir - PyPI Package Compare versions

docs/_build/.DS_Store

Sorry, the diff of this file is not supported yet

docs/_build/doctrees/api.doctree

Sorry, the diff of this file is not supported yet

docs/_build/doctrees/changelog.doctree

Sorry, the diff of this file is not supported yet

docs/_build/doctrees/environment.pickle

Sorry, the diff of this file is not supported yet

docs/_build/doctrees/index.doctree

Sorry, the diff of this file is not supported yet

docs/_build/doctrees/installation.doctree

Sorry, the diff of this file is not supported yet

docs/_build/doctrees/usage.doctree

Sorry, the diff of this file is not supported yet

+104

docs/_build/html/_modules/envdir.html

		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>envdir — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="../_static/default.css" type="text/css" />
		<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: '../',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="../_static/jquery.js"></script>
		<script type="text/javascript" src="../_static/underscore.js"></script>
		<script type="text/javascript" src="../_static/doctools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="../index.html" />
		<link rel="up" title="Module code" href="index.html" />
		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="../genindex.html" title="General Index"
		accesskey="I">index</a></li>
		<li><a href="../index.html">envdir 0.6 documentation</a> »</li>
		<li><a href="index.html" accesskey="U">Module code</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">

		<h1>Source code for envdir</h1><div class="highlight"><pre>
		<span class="kn">from</span> <span class="nn">.__main__</span> <span class="kn">import</span> <span class="n">runner</span><span class="p">,</span> <span class="n">go</span>
		<span class="kn">from</span> <span class="nn">.env</span> <span class="kn">import</span> <span class="n">Env</span> <span class="c"># noqa</span>
		<span class="kn">from</span> <span class="nn">.version</span> <span class="kn">import</span> <span class="n">__version__</span> <span class="c"># noqa</span>

		<span class="nb">open</span> <span class="o">=</span> <span class="n">runner</span><span class="o">.</span><span class="n">open</span>


		<span class="c"># for backward compatibility</span>
		<span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
		<span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>


		<span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
		<span class="n">go</span><span class="p">(</span><span class="n">runner</span><span class="o">.</span><span class="n">run</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>


		<span class="k">def</span> <span class="nf">shell</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">):</span>
		<span class="n">go</span><span class="p">(</span><span class="n">runner</span><span class="o">.</span><span class="n">shell</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>
		</pre></div>

		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">
		<div id="searchbox" style="display: none">
		<h3>Quick search</h3>
		<form class="search" action="../search.html" method="get">
		<input type="text" name="q" />
		<input type="submit" value="Go" />
		<input type="hidden" name="check_keywords" value="yes" />
		<input type="hidden" name="area" value="default" />
		</form>
		<p class="searchtip" style="font-size: 90%">
		Enter search terms or a module, class or function name.
		</p>
		</div>
		<script type="text/javascript">$('#searchbox').show(0);</script>
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="../genindex.html" title="General Index"
		>index</a></li>
		<li><a href="../index.html">envdir 0.6 documentation</a> »</li>
		<li><a href="index.html" >Module code</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

+84

docs/_build/html/_modules/index.html

		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>Overview: module code — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="../_static/default.css" type="text/css" />
		<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: '../',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="../_static/jquery.js"></script>
		<script type="text/javascript" src="../_static/underscore.js"></script>
		<script type="text/javascript" src="../_static/doctools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="../index.html" />
		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="../genindex.html" title="General Index"
		accesskey="I">index</a></li>
		<li><a href="../index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">

		<h1>All modules for which code is available</h1>
		<ul><li><a href="envdir.html">envdir</a></li>
		</ul>

		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">
		<div id="searchbox" style="display: none">
		<h3>Quick search</h3>
		<form class="search" action="../search.html" method="get">
		<input type="text" name="q" />
		<input type="submit" value="Go" />
		<input type="hidden" name="check_keywords" value="yes" />
		<input type="hidden" name="area" value="default" />
		</form>
		<p class="searchtip" style="font-size: 90%">
		Enter search terms or a module, class or function name.
		</p>
		</div>
		<script type="text/javascript">$('#searchbox').show(0);</script>
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="../genindex.html" title="General Index"
		>index</a></li>
		<li><a href="../index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

+101

docs/_build/html/_sources/api.txt

		Python API
		==========

		.. function:: envdir.open([path])

		To use an envdir in a Python file (e.g. Django's ``manage.py``) simply call
		the ``open`` function of the envdir module:

		.. code-block:: python

		import envdir
		envdir.open()

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

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

		.. code-block:: python

		import envdir

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

		Calling ``open`` will automatically apply all environment variables to the
		current instance of ``os.environ``.

		If you want to implement more advanced access to envdirs there is also an
		own dict-like :class:`~envdir.Env` object to work with. The above example
		could also be written like this:

		.. code-block:: python

		import envdir

		env = envdir.open('/home/jezdez/mysite/envs/prod')

		The returned :class:`~envdir.Env` instance has a dict-like interface but also
		features a :meth:`~envdir.Env.clear` method to reset the current instance of
		:data:`os.environ` to the value it had before the envdir was opened:

		.. code-block:: python

		import envdir

		env = envdir.open('/home/jezdez/mysite/envs/prod')

		# do something

		env.clear()

		Since calling the clear method should be done in a transparent manner
		you can also use it as a context manager:

		.. code-block:: python

		import envdir

		with envdir.open('/home/jezdez/mysite/envs/prod') as env:
		# do something

		Outside the context manager block the environ is reset back automatically.

		To access and write values you can also use the dict-like interface:

		.. code-block:: python

		import envdir

		with envdir.open() as env:
		env['DATABASE_URL'] = 'sqlite://:memory:'
		assert 'DATABASE_URL' in env
		assert env.items() == [('DATABASE_URL', 'sqlite://:memory:')]

		.. note::

		Additions to the envdir done inside the context manager block are
		persisted to disk and will be available the next time your open the
		envdir again.

		Of course you can also directly interact with :class:`~envdir.Env` instances,
		e.g.:

		.. code-block:: python

		import envdir

		with envdir.Env('/home/jezdez/mysite/envs/prod') as env:
		# do something here

		The difference between instantiating an :class:`~envdir.Env` yourself to
		using :func:`envdir.open` is that you'll lose the automatic discovery of
		the ``envdir`` directory.

		See the API docs below for a full list of methods available in the
		:class:`~envdir.Env` object.

		.. autoclass:: envdir.Env
		:members:
		:undoc-members:
		:special-members:
		:inherited-members:

+65

docs/_build/html/_sources/changelog.txt

		Changelog
		---------

		0.6 (12/02/2013)
		^^^^^^^^^^^^^^^^

		* Rewrote tests with pytest.

		* Vastly extended Python API.

		* Added Sphinx based docs: http://envdir.readthedocs.org/

		* Fixed killing child process when capturing keyboard interrupt.

		0.5 (09/22/2013)
		^^^^^^^^^^^^^^^^

		* Added check if the the provided path is a directory and throw an error if
		not. This adds compatibility to the daemontools' envdir.

		* Make sure to convert Nulls (``\0``) to newlines as done so in daemontools'
		envdir.

		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.

+12

docs/_build/html/_sources/index.txt

		.. include:: ../README.rst

		More documentation
		------------------

		.. toctree::
		:maxdepth: 3

		installation
		usage
		api
		changelog

+12

docs/_build/html/_sources/installation.txt

		Installation
		============

		.. code-block:: console

		$ pip install envdir

		or:

		.. code-block:: console

		$ easy_install envdir

+56

docs/_build/html/_sources/usage.txt

		Usage
		=====

		Command line
		------------

		From the original 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.

		Isolated 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:

		.. code-block:: console

		$ 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``.

		.. _envdir: http://cr.yp.to/daemontools/envdir.html

docs/_build/html/_static/ajax-loader.gif

Sorry, the diff of this file is not supported yet

+540

docs/_build/html/_static/basic.css

		/*
		* basic.css
		* ~~~~~~~~~
		*
		* Sphinx stylesheet -- basic theme.
		*
		* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
		* :license: BSD, see LICENSE for details.
		*
		*/

		/* -- main layout ----------------------------------------------------------- */

		div.clearer {
		clear: both;
		}

		/* -- relbar ---------------------------------------------------------------- */

		div.related {
		width: 100%;
		font-size: 90%;
		}

		div.related h3 {
		display: none;
		}

		div.related ul {
		margin: 0;
		padding: 0 0 0 10px;
		list-style: none;
		}

		div.related li {
		display: inline;
		}

		div.related li.right {
		float: right;
		margin-right: 5px;
		}

		/* -- sidebar --------------------------------------------------------------- */

		div.sphinxsidebarwrapper {
		padding: 10px 5px 0 10px;
		}

		div.sphinxsidebar {
		float: left;
		width: 230px;
		margin-left: -100%;
		font-size: 90%;
		}

		div.sphinxsidebar ul {
		list-style: none;
		}

		div.sphinxsidebar ul ul,
		div.sphinxsidebar ul.want-points {
		margin-left: 20px;
		list-style: square;
		}

		div.sphinxsidebar ul ul {
		margin-top: 0;
		margin-bottom: 0;
		}

		div.sphinxsidebar form {
		margin-top: 10px;
		}

		div.sphinxsidebar input {
		border: 1px solid #98dbcc;
		font-family: sans-serif;
		font-size: 1em;
		}

		div.sphinxsidebar #searchbox input[type="text"] {
		width: 170px;
		}

		div.sphinxsidebar #searchbox input[type="submit"] {
		width: 30px;
		}

		img {
		border: 0;
		}

		/* -- search page ----------------------------------------------------------- */

		ul.search {
		margin: 10px 0 0 20px;
		padding: 0;
		}

		ul.search li {
		padding: 5px 0 5px 20px;
		background-image: url(file.png);
		background-repeat: no-repeat;
		background-position: 0 7px;
		}

		ul.search li a {
		font-weight: bold;
		}

		ul.search li div.context {
		color: #888;
		margin: 2px 0 0 30px;
		text-align: left;
		}

		ul.keywordmatches li.goodmatch a {
		font-weight: bold;
		}

		/* -- index page ------------------------------------------------------------ */

		table.contentstable {
		width: 90%;
		}

		table.contentstable p.biglink {
		line-height: 150%;
		}

		a.biglink {
		font-size: 1.3em;
		}

		span.linkdescr {
		font-style: italic;
		padding-top: 5px;
		font-size: 90%;
		}

		/* -- general index --------------------------------------------------------- */

		table.indextable {
		width: 100%;
		}

		table.indextable td {
		text-align: left;
		vertical-align: top;
		}

		table.indextable dl, table.indextable dd {
		margin-top: 0;
		margin-bottom: 0;
		}

		table.indextable tr.pcap {
		height: 10px;
		}

		table.indextable tr.cap {
		margin-top: 10px;
		background-color: #f2f2f2;
		}

		img.toggler {
		margin-right: 3px;
		margin-top: 3px;
		cursor: pointer;
		}

		div.modindex-jumpbox {
		border-top: 1px solid #ddd;
		border-bottom: 1px solid #ddd;
		margin: 1em 0 1em 0;
		padding: 0.4em;
		}

		div.genindex-jumpbox {
		border-top: 1px solid #ddd;
		border-bottom: 1px solid #ddd;
		margin: 1em 0 1em 0;
		padding: 0.4em;
		}

		/* -- general body styles --------------------------------------------------- */

		a.headerlink {
		visibility: hidden;
		}

		h1:hover > a.headerlink,
		h2:hover > a.headerlink,
		h3:hover > a.headerlink,
		h4:hover > a.headerlink,
		h5:hover > a.headerlink,
		h6:hover > a.headerlink,
		dt:hover > a.headerlink {
		visibility: visible;
		}

		div.body p.caption {
		text-align: inherit;
		}

		div.body td {
		text-align: left;
		}

		.field-list ul {
		padding-left: 1em;
		}

		.first {
		margin-top: 0 !important;
		}

		p.rubric {
		margin-top: 30px;
		font-weight: bold;
		}

		img.align-left, .figure.align-left, object.align-left {
		clear: left;
		float: left;
		margin-right: 1em;
		}

		img.align-right, .figure.align-right, object.align-right {
		clear: right;
		float: right;
		margin-left: 1em;
		}

		img.align-center, .figure.align-center, object.align-center {
		display: block;
		margin-left: auto;
		margin-right: auto;
		}

		.align-left {
		text-align: left;
		}

		.align-center {
		text-align: center;
		}

		.align-right {
		text-align: right;
		}

		/* -- sidebars -------------------------------------------------------------- */

		div.sidebar {
		margin: 0 0 0.5em 1em;
		border: 1px solid #ddb;
		padding: 7px 7px 0 7px;
		background-color: #ffe;
		width: 40%;
		float: right;
		}

		p.sidebar-title {
		font-weight: bold;
		}

		/* -- topics ---------------------------------------------------------------- */

		div.topic {
		border: 1px solid #ccc;
		padding: 7px 7px 0 7px;
		margin: 10px 0 10px 0;
		}

		p.topic-title {
		font-size: 1.1em;
		font-weight: bold;
		margin-top: 10px;
		}

		/* -- admonitions ----------------------------------------------------------- */

		div.admonition {
		margin-top: 10px;
		margin-bottom: 10px;
		padding: 7px;
		}

		div.admonition dt {
		font-weight: bold;
		}

		div.admonition dl {
		margin-bottom: 0;
		}

		p.admonition-title {
		margin: 0px 10px 5px 0px;
		font-weight: bold;
		}

		div.body p.centered {
		text-align: center;
		margin-top: 25px;
		}

		/* -- tables ---------------------------------------------------------------- */

		table.docutils {
		border: 0;
		border-collapse: collapse;
		}

		table.docutils td, table.docutils th {
		padding: 1px 8px 1px 5px;
		border-top: 0;
		border-left: 0;
		border-right: 0;
		border-bottom: 1px solid #aaa;
		}

		table.field-list td, table.field-list th {
		border: 0 !important;
		}

		table.footnote td, table.footnote th {
		border: 0 !important;
		}

		th {
		text-align: left;
		padding-right: 5px;
		}

		table.citation {
		border-left: solid 1px gray;
		margin-left: 1px;
		}

		table.citation td {
		border-bottom: none;
		}

		/* -- other body styles ----------------------------------------------------- */

		ol.arabic {
		list-style: decimal;
		}

		ol.loweralpha {
		list-style: lower-alpha;
		}

		ol.upperalpha {
		list-style: upper-alpha;
		}

		ol.lowerroman {
		list-style: lower-roman;
		}

		ol.upperroman {
		list-style: upper-roman;
		}

		dl {
		margin-bottom: 15px;
		}

		dd p {
		margin-top: 0px;
		}

		dd ul, dd table {
		margin-bottom: 10px;
		}

		dd {
		margin-top: 3px;
		margin-bottom: 10px;
		margin-left: 30px;
		}

		dt:target, .highlighted {
		background-color: #fbe54e;
		}

		dl.glossary dt {
		font-weight: bold;
		font-size: 1.1em;
		}

		.field-list ul {
		margin: 0;
		padding-left: 1em;
		}

		.field-list p {
		margin: 0;
		}

		.refcount {
		color: #060;
		}

		.optional {
		font-size: 1.3em;
		}

		.versionmodified {
		font-style: italic;
		}

		.system-message {
		background-color: #fda;
		padding: 5px;
		border: 3px solid red;
		}

		.footnote:target {
		background-color: #ffa;
		}

		.line-block {
		display: block;
		margin-top: 1em;
		margin-bottom: 1em;
		}

		.line-block .line-block {
		margin-top: 0;
		margin-bottom: 0;
		margin-left: 1.5em;
		}

		.guilabel, .menuselection {
		font-family: sans-serif;
		}

		.accelerator {
		text-decoration: underline;
		}

		.classifier {
		font-style: oblique;
		}

		abbr, acronym {
		border-bottom: dotted 1px;
		cursor: help;
		}

		/* -- code displays --------------------------------------------------------- */

		pre {
		overflow: auto;
		overflow-y: hidden; /* fixes display issues on Chrome browsers */
		}

		td.linenos pre {
		padding: 5px 0px;
		border: 0;
		background-color: transparent;
		color: #aaa;
		}

		table.highlighttable {
		margin-left: 0.5em;
		}

		table.highlighttable td {
		padding: 0 0.5em 0 0.5em;
		}

		tt.descname {
		background-color: transparent;
		font-weight: bold;
		font-size: 1.2em;
		}

		tt.descclassname {
		background-color: transparent;
		}

		tt.xref, a tt {
		background-color: transparent;
		font-weight: bold;
		}

		h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
		background-color: transparent;
		}

		.viewcode-link {
		float: right;
		}

		.viewcode-back {
		float: right;
		font-family: sans-serif;
		}

		div.viewcode-block:target {
		margin: -1px -10px;
		padding: 0 10px;
		}

		/* -- math display ---------------------------------------------------------- */

		img.math {
		vertical-align: middle;
		}

		div.body div.math p {
		text-align: center;
		}

		span.eqno {
		float: right;
		}

		/* -- printout stylesheet --------------------------------------------------- */

		@media print {
		div.document,
		div.documentwrapper,
		div.bodywrapper {
		margin: 0 !important;
		width: 100%;
		}

		div.sphinxsidebar,
		div.related,
		div.footer,
		#top-link {
		display: none;
		}
		}

docs/_build/html/_static/comment-bright.png

Sorry, the diff of this file is not supported yet

docs/_build/html/_static/comment-close.png

Sorry, the diff of this file is not supported yet

docs/_build/html/_static/comment.png

Sorry, the diff of this file is not supported yet

+256

docs/_build/html/_static/default.css

		/*
		* default.css_t
		* ~~~~~~~~~~~~~
		*
		* Sphinx stylesheet -- default theme.
		*
		* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
		* :license: BSD, see LICENSE for details.
		*
		*/

		@import url("basic.css");

		/* -- page layout ----------------------------------------------------------- */

		body {
		font-family: sans-serif;
		font-size: 100%;
		background-color: #11303d;
		color: #000;
		margin: 0;
		padding: 0;
		}

		div.document {
		background-color: #1c4e63;
		}

		div.documentwrapper {
		float: left;
		width: 100%;
		}

		div.bodywrapper {
		margin: 0 0 0 230px;
		}

		div.body {
		background-color: #ffffff;
		color: #000000;
		padding: 0 20px 30px 20px;
		}

		div.footer {
		color: #ffffff;
		width: 100%;
		padding: 9px 0 9px 0;
		text-align: center;
		font-size: 75%;
		}

		div.footer a {
		color: #ffffff;
		text-decoration: underline;
		}

		div.related {
		background-color: #133f52;
		line-height: 30px;
		color: #ffffff;
		}

		div.related a {
		color: #ffffff;
		}

		div.sphinxsidebar {
		}

		div.sphinxsidebar h3 {
		font-family: 'Trebuchet MS', sans-serif;
		color: #ffffff;
		font-size: 1.4em;
		font-weight: normal;
		margin: 0;
		padding: 0;
		}

		div.sphinxsidebar h3 a {
		color: #ffffff;
		}

		div.sphinxsidebar h4 {
		font-family: 'Trebuchet MS', sans-serif;
		color: #ffffff;
		font-size: 1.3em;
		font-weight: normal;
		margin: 5px 0 0 0;
		padding: 0;
		}

		div.sphinxsidebar p {
		color: #ffffff;
		}

		div.sphinxsidebar p.topless {
		margin: 5px 10px 10px 10px;
		}

		div.sphinxsidebar ul {
		margin: 10px;
		padding: 0;
		color: #ffffff;
		}

		div.sphinxsidebar a {
		color: #98dbcc;
		}

		div.sphinxsidebar input {
		border: 1px solid #98dbcc;
		font-family: sans-serif;
		font-size: 1em;
		}



		/* -- hyperlink styles ------------------------------------------------------ */

		a {
		color: #355f7c;
		text-decoration: none;
		}

		a:visited {
		color: #355f7c;
		text-decoration: none;
		}

		a:hover {
		text-decoration: underline;
		}



		/* -- body styles ----------------------------------------------------------- */

		div.body h1,
		div.body h2,
		div.body h3,
		div.body h4,
		div.body h5,
		div.body h6 {
		font-family: 'Trebuchet MS', sans-serif;
		background-color: #f2f2f2;
		font-weight: normal;
		color: #20435c;
		border-bottom: 1px solid #ccc;
		margin: 20px -20px 10px -20px;
		padding: 3px 0 3px 10px;
		}

		div.body h1 { margin-top: 0; font-size: 200%; }
		div.body h2 { font-size: 160%; }
		div.body h3 { font-size: 140%; }
		div.body h4 { font-size: 120%; }
		div.body h5 { font-size: 110%; }
		div.body h6 { font-size: 100%; }

		a.headerlink {
		color: #c60f0f;
		font-size: 0.8em;
		padding: 0 4px 0 4px;
		text-decoration: none;
		}

		a.headerlink:hover {
		background-color: #c60f0f;
		color: white;
		}

		div.body p, div.body dd, div.body li {
		text-align: justify;
		line-height: 130%;
		}

		div.admonition p.admonition-title + p {
		display: inline;
		}

		div.admonition p {
		margin-bottom: 5px;
		}

		div.admonition pre {
		margin-bottom: 5px;
		}

		div.admonition ul, div.admonition ol {
		margin-bottom: 5px;
		}

		div.note {
		background-color: #eee;
		border: 1px solid #ccc;
		}

		div.seealso {
		background-color: #ffc;
		border: 1px solid #ff6;
		}

		div.topic {
		background-color: #eee;
		}

		div.warning {
		background-color: #ffe4e4;
		border: 1px solid #f66;
		}

		p.admonition-title {
		display: inline;
		}

		p.admonition-title:after {
		content: ":";
		}

		pre {
		padding: 5px;
		background-color: #eeffcc;
		color: #333333;
		line-height: 120%;
		border: 1px solid #ac9;
		border-left: none;
		border-right: none;
		}

		tt {
		background-color: #ecf0f3;
		padding: 0 1px 0 1px;
		font-size: 0.95em;
		}

		th {
		background-color: #ede;
		}

		.warning tt {
		background: #efc2c2;
		}

		.note tt {
		background: #d6d6d6;
		}

		.viewcode-back {
		font-family: sans-serif;
		}

		div.viewcode-block:target {
		background-color: #f4debf;
		border-top: 1px solid #ac9;
		border-bottom: 1px solid #ac9;
		}

+235

docs/_build/html/_static/doctools.js

		/*
		* doctools.js
		* ~~~~~~~~~~~
		*
		* Sphinx JavaScript utilities for all documentation.
		*
		* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
		* :license: BSD, see LICENSE for details.
		*
		*/

		/**
		* select a different prefix for underscore
		*/
		$u = _.noConflict();

		/**
		* make the code below compatible with browsers without
		* an installed firebug like debugger
		if (!window.console \|\| !console.firebug) {
		var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
		"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
		"profile", "profileEnd"];
		window.console = {};
		for (var i = 0; i < names.length; ++i)
		window.console[names[i]] = function() {};
		}
		*/

		/**
		* small helper function to urldecode strings
		*/
		jQuery.urldecode = function(x) {
		return decodeURIComponent(x).replace(/\+/g, ' ');
		};

		/**
		* small helper function to urlencode strings
		*/
		jQuery.urlencode = encodeURIComponent;

		/**
		* This function returns the parsed url parameters of the
		* current request. Multiple values per key are supported,
		* it will always return arrays of strings for the value parts.
		*/
		jQuery.getQueryParameters = function(s) {
		if (typeof s == 'undefined')
		s = document.location.search;
		var parts = s.substr(s.indexOf('?') + 1).split('&');
		var result = {};
		for (var i = 0; i < parts.length; i++) {
		var tmp = parts[i].split('=', 2);
		var key = jQuery.urldecode(tmp[0]);
		var value = jQuery.urldecode(tmp[1]);
		if (key in result)
		result[key].push(value);
		else
		result[key] = [value];
		}
		return result;
		};

		/**
		* highlight a given string on a jquery object by wrapping it in
		* span elements with the given class name.
		*/
		jQuery.fn.highlightText = function(text, className) {
		function highlight(node) {
		if (node.nodeType == 3) {
		var val = node.nodeValue;
		var pos = val.toLowerCase().indexOf(text);
		if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
		var span = document.createElement("span");
		span.className = className;
		span.appendChild(document.createTextNode(val.substr(pos, text.length)));
		node.parentNode.insertBefore(span, node.parentNode.insertBefore(
		document.createTextNode(val.substr(pos + text.length)),
		node.nextSibling));
		node.nodeValue = val.substr(0, pos);
		}
		}
		else if (!jQuery(node).is("button, select, textarea")) {
		jQuery.each(node.childNodes, function() {
		highlight(this);
		});
		}
		}
		return this.each(function() {
		highlight(this);
		});
		};

		/**
		* Small JavaScript module for the documentation.
		*/
		var Documentation = {

		init : function() {
		this.fixFirefoxAnchorBug();
		this.highlightSearchWords();
		this.initIndexTable();
		},

		/**
		* i18n support
		*/
		TRANSLATIONS : {},
		PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
		LOCALE : 'unknown',

		// gettext and ngettext don't access this so that the functions
		// can safely bound to a different name (_ = Documentation.gettext)
		gettext : function(string) {
		var translated = Documentation.TRANSLATIONS[string];
		if (typeof translated == 'undefined')
		return string;
		return (typeof translated == 'string') ? translated : translated[0];
		},

		ngettext : function(singular, plural, n) {
		var translated = Documentation.TRANSLATIONS[singular];
		if (typeof translated == 'undefined')
		return (n == 1) ? singular : plural;
		return translated[Documentation.PLURALEXPR(n)];
		},

		addTranslations : function(catalog) {
		for (var key in catalog.messages)
		this.TRANSLATIONS[key] = catalog.messages[key];
		this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
		this.LOCALE = catalog.locale;
		},

		/**
		* add context elements like header anchor links
		*/
		addContextElements : function() {
		$('div[id] > :header:first').each(function() {
		$('<a class="headerlink">\u00B6</a>').
		attr('href', '#' + this.id).
		attr('title', _('Permalink to this headline')).
		appendTo(this);
		});
		$('dt[id]').each(function() {
		$('<a class="headerlink">\u00B6</a>').
		attr('href', '#' + this.id).
		attr('title', _('Permalink to this definition')).
		appendTo(this);
		});
		},

		/**
		* workaround a firefox stupidity
		*/
		fixFirefoxAnchorBug : function() {
		if (document.location.hash && $.browser.mozilla)
		window.setTimeout(function() {
		document.location.href += '';
		}, 10);
		},

		/**
		* highlight the search words provided in the url in the text
		*/
		highlightSearchWords : function() {
		var params = $.getQueryParameters();
		var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
		if (terms.length) {
		var body = $('div.body');
		window.setTimeout(function() {
		$.each(terms, function() {
		body.highlightText(this.toLowerCase(), 'highlighted');
		});
		}, 10);
		$('<p class="highlight-link"><a href="javascript:Documentation.' +
		'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
		.appendTo($('#searchbox'));
		}
		},

		/**
		* init the domain index toggle buttons
		*/
		initIndexTable : function() {
		var togglers = $('img.toggler').click(function() {
		var src = $(this).attr('src');
		var idnum = $(this).attr('id').substr(7);
		$('tr.cg-' + idnum).toggle();
		if (src.substr(-9) == 'minus.png')
		$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
		else
		$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
		}).css('display', '');
		if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
		togglers.click();
		}
		},

		/**
		* helper function to hide the search marks again
		*/
		hideSearchWords : function() {
		$('#searchbox .highlight-link').fadeOut(300);
		$('span.highlighted').removeClass('highlighted');
		},

		/**
		* make the url absolute
		*/
		makeURL : function(relativeURL) {
		return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
		},

		/**
		* get the current relative url
		*/
		getCurrentURL : function() {
		var path = document.location.pathname;
		var parts = path.split(/\//);
		$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
		if (this == '..')
		parts.pop();
		});
		var url = parts.join('/');
		return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
		}
		};

		// quick alias for translations
		_ = Documentation.gettext;

		$(document).ready(function() {
		Documentation.init();
		});

docs/_build/html/_static/down-pressed.png

Sorry, the diff of this file is not supported yet

docs/_build/html/_static/down.png

Sorry, the diff of this file is not supported yet

docs/_build/html/_static/file.png

Sorry, the diff of this file is not supported yet

docs/_build/html/_static/jquery.js

Sorry, the diff of this file is too big to display

docs/_build/html/_static/minus.png

Sorry, the diff of this file is not supported yet

docs/_build/html/_static/plus.png

Sorry, the diff of this file is not supported yet

+62

docs/_build/html/_static/pygments.css

		.highlight .hll { background-color: #ffffcc }
		.highlight { background: #eeffcc; }
		.highlight .c { color: #408090; font-style: italic } /* Comment */
		.highlight .err { border: 1px solid #FF0000 } /* Error */
		.highlight .k { color: #007020; font-weight: bold } /* Keyword */
		.highlight .o { color: #666666 } /* Operator */
		.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
		.highlight .cp { color: #007020 } /* Comment.Preproc */
		.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
		.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
		.highlight .gd { color: #A00000 } /* Generic.Deleted */
		.highlight .ge { font-style: italic } /* Generic.Emph */
		.highlight .gr { color: #FF0000 } /* Generic.Error */
		.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
		.highlight .gi { color: #00A000 } /* Generic.Inserted */
		.highlight .go { color: #333333 } /* Generic.Output */
		.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
		.highlight .gs { font-weight: bold } /* Generic.Strong */
		.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
		.highlight .gt { color: #0044DD } /* Generic.Traceback */
		.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
		.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
		.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
		.highlight .kp { color: #007020 } /* Keyword.Pseudo */
		.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
		.highlight .kt { color: #902000 } /* Keyword.Type */
		.highlight .m { color: #208050 } /* Literal.Number */
		.highlight .s { color: #4070a0 } /* Literal.String */
		.highlight .na { color: #4070a0 } /* Name.Attribute */
		.highlight .nb { color: #007020 } /* Name.Builtin */
		.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
		.highlight .no { color: #60add5 } /* Name.Constant */
		.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
		.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
		.highlight .ne { color: #007020 } /* Name.Exception */
		.highlight .nf { color: #06287e } /* Name.Function */
		.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
		.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
		.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
		.highlight .nv { color: #bb60d5 } /* Name.Variable */
		.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
		.highlight .w { color: #bbbbbb } /* Text.Whitespace */
		.highlight .mf { color: #208050 } /* Literal.Number.Float */
		.highlight .mh { color: #208050 } /* Literal.Number.Hex */
		.highlight .mi { color: #208050 } /* Literal.Number.Integer */
		.highlight .mo { color: #208050 } /* Literal.Number.Oct */
		.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
		.highlight .sc { color: #4070a0 } /* Literal.String.Char */
		.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
		.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
		.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
		.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
		.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
		.highlight .sx { color: #c65d09 } /* Literal.String.Other */
		.highlight .sr { color: #235388 } /* Literal.String.Regex */
		.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
		.highlight .ss { color: #517918 } /* Literal.String.Symbol */
		.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
		.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
		.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
		.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
		.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */

+622

docs/_build/html/_static/searchtools.js

		/*
		* searchtools.js_t
		* ~~~~~~~~~~~~~~~~
		*
		* Sphinx JavaScript utilties for the full-text search.
		*
		* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
		* :license: BSD, see LICENSE for details.
		*
		*/


		/**
		* Porter Stemmer
		*/
		var Stemmer = function() {

		var step2list = {
		ational: 'ate',
		tional: 'tion',
		enci: 'ence',
		anci: 'ance',
		izer: 'ize',
		bli: 'ble',
		alli: 'al',
		entli: 'ent',
		eli: 'e',
		ousli: 'ous',
		ization: 'ize',
		ation: 'ate',
		ator: 'ate',
		alism: 'al',
		iveness: 'ive',
		fulness: 'ful',
		ousness: 'ous',
		aliti: 'al',
		iviti: 'ive',
		biliti: 'ble',
		logi: 'log'
		};

		var step3list = {
		icate: 'ic',
		ative: '',
		alize: 'al',
		iciti: 'ic',
		ical: 'ic',
		ful: '',
		ness: ''
		};

		var c = "[^aeiou]"; // consonant
		var v = "[aeiouy]"; // vowel
		var C = c + "[^aeiouy]*"; // consonant sequence
		var V = v + "[aeiou]*"; // vowel sequence

		var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
		var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
		var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
		var s_v = "^(" + C + ")?" + v; // vowel in stem

		this.stemWord = function (w) {
		var stem;
		var suffix;
		var firstch;
		var origword = w;

		if (w.length < 3)
		return w;

		var re;
		var re2;
		var re3;
		var re4;

		firstch = w.substr(0,1);
		if (firstch == "y")
		w = firstch.toUpperCase() + w.substr(1);

		// Step 1a
		re = /^(.+?)(ss\|i)es$/;
		re2 = /^(.+?)([^s])s$/;

		if (re.test(w))
		w = w.replace(re,"$1$2");
		else if (re2.test(w))
		w = w.replace(re2,"$1$2");

		// Step 1b
		re = /^(.+?)eed$/;
		re2 = /^(.+?)(ed\|ing)$/;
		if (re.test(w)) {
		var fp = re.exec(w);
		re = new RegExp(mgr0);
		if (re.test(fp[1])) {
		re = /.$/;
		w = w.replace(re,"");
		}
		}
		else if (re2.test(w)) {
		var fp = re2.exec(w);
		stem = fp[1];
		re2 = new RegExp(s_v);
		if (re2.test(stem)) {
		w = stem;
		re2 = /(at\|bl\|iz)$/;
		re3 = new RegExp("([^aeiouylsz])\\1$");
		re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
		if (re2.test(w))
		w = w + "e";
		else if (re3.test(w)) {
		re = /.$/;
		w = w.replace(re,"");
		}
		else if (re4.test(w))
		w = w + "e";
		}
		}

		// Step 1c
		re = /^(.+?)y$/;
		if (re.test(w)) {
		var fp = re.exec(w);
		stem = fp[1];
		re = new RegExp(s_v);
		if (re.test(stem))
		w = stem + "i";
		}

		// Step 2
		re = /^(.+?)(ational\|tional\|enci\|anci\|izer\|bli\|alli\|entli\|eli\|ousli\|ization\|ation\|ator\|alism\|iveness\|fulness\|ousness\|aliti\|iviti\|biliti\|logi)$/;
		if (re.test(w)) {
		var fp = re.exec(w);
		stem = fp[1];
		suffix = fp[2];
		re = new RegExp(mgr0);
		if (re.test(stem))
		w = stem + step2list[suffix];
		}

		// Step 3
		re = /^(.+?)(icate\|ative\|alize\|iciti\|ical\|ful\|ness)$/;
		if (re.test(w)) {
		var fp = re.exec(w);
		stem = fp[1];
		suffix = fp[2];
		re = new RegExp(mgr0);
		if (re.test(stem))
		w = stem + step3list[suffix];
		}

		// Step 4
		re = /^(.+?)(al\|ance\|ence\|er\|ic\|able\|ible\|ant\|ement\|ment\|ent\|ou\|ism\|ate\|iti\|ous\|ive\|ize)$/;
		re2 = /^(.+?)(s\|t)(ion)$/;
		if (re.test(w)) {
		var fp = re.exec(w);
		stem = fp[1];
		re = new RegExp(mgr1);
		if (re.test(stem))
		w = stem;
		}
		else if (re2.test(w)) {
		var fp = re2.exec(w);
		stem = fp[1] + fp[2];
		re2 = new RegExp(mgr1);
		if (re2.test(stem))
		w = stem;
		}

		// Step 5
		re = /^(.+?)e$/;
		if (re.test(w)) {
		var fp = re.exec(w);
		stem = fp[1];
		re = new RegExp(mgr1);
		re2 = new RegExp(meq1);
		re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
		if (re.test(stem) \|\| (re2.test(stem) && !(re3.test(stem))))
		w = stem;
		}
		re = /ll$/;
		re2 = new RegExp(mgr1);
		if (re.test(w) && re2.test(w)) {
		re = /.$/;
		w = w.replace(re,"");
		}

		// and turn initial Y back to y
		if (firstch == "y")
		w = firstch.toLowerCase() + w.substr(1);
		return w;
		}
		}



		/**
		* Simple result scoring code.
		*/
		var Scorer = {
		// Implement the following function to further tweak the score for each result
		// The function takes a result array [filename, title, anchor, descr, score]
		// and returns the new score.
		/*
		score: function(result) {
		return result[4];
		},
		*/

		// query matches the full name of an object
		objNameMatch: 11,
		// or matches in the last dotted part of the object name
		objPartialMatch: 6,
		// Additive scores depending on the priority of the object
		objPrio: {0: 15, // used to be importantResults
		1: 5, // used to be objectResults
		2: -5}, // used to be unimportantResults
		// Used when the priority is not in the mapping.
		objPrioDefault: 0,

		// query found in title
		title: 15,
		// query found in terms
		term: 5
		};


		/**
		* Search Module
		*/
		var Search = {

		_index : null,
		_queued_query : null,
		_pulse_status : -1,

		init : function() {
		var params = $.getQueryParameters();
		if (params.q) {
		var query = params.q[0];
		$('input[name="q"]')[0].value = query;
		this.performSearch(query);
		}
		},

		loadIndex : function(url) {
		$.ajax({type: "GET", url: url, data: null,
		dataType: "script", cache: true,
		complete: function(jqxhr, textstatus) {
		if (textstatus != "success") {
		document.getElementById("searchindexloader").src = url;
		}
		}});
		},

		setIndex : function(index) {
		var q;
		this._index = index;
		if ((q = this._queued_query) !== null) {
		this._queued_query = null;
		Search.query(q);
		}
		},

		hasIndex : function() {
		return this._index !== null;
		},

		deferQuery : function(query) {
		this._queued_query = query;
		},

		stopPulse : function() {
		this._pulse_status = 0;
		},

		startPulse : function() {
		if (this._pulse_status >= 0)
		return;
		function pulse() {
		var i;
		Search._pulse_status = (Search._pulse_status + 1) % 4;
		var dotString = '';
		for (i = 0; i < Search._pulse_status; i++)
		dotString += '.';
		Search.dots.text(dotString);
		if (Search._pulse_status > -1)
		window.setTimeout(pulse, 500);
		}
		pulse();
		},

		/**
		* perform a search for something (or wait until index is loaded)
		*/
		performSearch : function(query) {
		// create the required interface elements
		this.out = $('#search-results');
		this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
		this.dots = $('<span></span>').appendTo(this.title);
		this.status = $('<p style="display: none"></p>').appendTo(this.out);
		this.output = $('<ul class="search"/>').appendTo(this.out);

		$('#search-progress').text(_('Preparing search...'));
		this.startPulse();

		// index already loaded, the browser was quick!
		if (this.hasIndex())
		this.query(query);
		else
		this.deferQuery(query);
		},

		/**
		* execute search (requires search index to be loaded)
		*/
		query : function(query) {
		var i;
		var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];

		// stem the searchterms and add them to the correct list
		var stemmer = new Stemmer();
		var searchterms = [];
		var excluded = [];
		var hlterms = [];
		var tmp = query.split(/\s+/);
		var objectterms = [];
		for (i = 0; i < tmp.length; i++) {
		if (tmp[i] !== "") {
		objectterms.push(tmp[i].toLowerCase());
		}

		if ($u.indexOf(stopwords, tmp[i]) != -1 \|\| tmp[i].match(/^\d+$/) \|\|
		tmp[i] === "") {
		// skip this "word"
		continue;
		}
		// stem the word
		var word = stemmer.stemWord(tmp[i]).toLowerCase();
		var toAppend;
		// select the correct list
		if (word[0] == '-') {
		toAppend = excluded;
		word = word.substr(1);
		}
		else {
		toAppend = searchterms;
		hlterms.push(tmp[i].toLowerCase());
		}
		// only add if not already in the list
		if (!$u.contains(toAppend, word))
		toAppend.push(word);
		}
		var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));

		// console.debug('SEARCH: searching for:');
		// console.info('required: ', searchterms);
		// console.info('excluded: ', excluded);

		// prepare search
		var terms = this._index.terms;
		var titleterms = this._index.titleterms;

		// array of [filename, title, anchor, descr, score]
		var results = [];
		$('#search-progress').empty();

		// lookup as object
		for (i = 0; i < objectterms.length; i++) {
		var others = [].concat(objectterms.slice(0, i),
		objectterms.slice(i+1, objectterms.length));
		results = results.concat(this.performObjectSearch(objectterms[i], others));
		}

		// lookup as search terms in fulltext
		results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
		.concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));

		// let the scorer override scores with a custom scoring function
		if (Scorer.score) {
		for (i = 0; i < results.length; i++)
		results[i][4] = Scorer.score(results[i]);
		}

		// now sort the results by score (in opposite order of appearance, since the
		// display function below uses pop() to retrieve items) and then
		// alphabetically
		results.sort(function(a, b) {
		var left = a[4];
		var right = b[4];
		if (left > right) {
		return 1;
		} else if (left < right) {
		return -1;
		} else {
		// same score: sort alphabetically
		left = a[1].toLowerCase();
		right = b[1].toLowerCase();
		return (left > right) ? -1 : ((left < right) ? 1 : 0);
		}
		});

		// for debugging
		//Search.lastresults = results.slice(); // a copy
		//console.info('search results:', Search.lastresults);

		// print the results
		var resultCount = results.length;
		function displayNextItem() {
		// results left, load the summary and display it
		if (results.length) {
		var item = results.pop();
		var listItem = $('<li style="display:none"></li>');
		if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
		// dirhtml builder
		var dirname = item[0] + '/';
		if (dirname.match(/\/index\/$/)) {
		dirname = dirname.substring(0, dirname.length-6);
		} else if (dirname == 'index/') {
		dirname = '';
		}
		listItem.append($('<a/>').attr('href',
		DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
		highlightstring + item[2]).html(item[1]));
		} else {
		// normal html builders
		listItem.append($('<a/>').attr('href',
		item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
		highlightstring + item[2]).html(item[1]));
		}
		if (item[3]) {
		listItem.append($('<span> (' + item[3] + ')</span>'));
		Search.output.append(listItem);
		listItem.slideDown(5, function() {
		displayNextItem();
		});
		} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
		$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt',
		dataType: "text",
		complete: function(jqxhr, textstatus) {
		var data = jqxhr.responseText;
		if (data !== '') {
		listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
		}
		Search.output.append(listItem);
		listItem.slideDown(5, function() {
		displayNextItem();
		});
		}});
		} else {
		// no source available, just display title
		Search.output.append(listItem);
		listItem.slideDown(5, function() {
		displayNextItem();
		});
		}
		}
		// search finished, update title and status message
		else {
		Search.stopPulse();
		Search.title.text(_('Search Results'));
		if (!resultCount)
		Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
		else
		Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
		Search.status.fadeIn(500);
		}
		}
		displayNextItem();
		},

		/**
		* search for object names
		*/
		performObjectSearch : function(object, otherterms) {
		var filenames = this._index.filenames;
		var objects = this._index.objects;
		var objnames = this._index.objnames;
		var titles = this._index.titles;

		var i;
		var results = [];

		for (var prefix in objects) {
		for (var name in objects[prefix]) {
		var fullname = (prefix ? prefix + '.' : '') + name;
		if (fullname.toLowerCase().indexOf(object) > -1) {
		var score = 0;
		var parts = fullname.split('.');
		// check for different match types: exact matches of full name or
		// "last name" (i.e. last dotted part)
		if (fullname == object \|\| parts[parts.length - 1] == object) {
		score += Scorer.objNameMatch;
		// matches in last name
		} else if (parts[parts.length - 1].indexOf(object) > -1) {
		score += Scorer.objPartialMatch;
		}
		var match = objects[prefix][name];
		var objname = objnames[match[1]][2];
		var title = titles[match[0]];
		// If more than one term searched for, we require other words to be
		// found in the name/title/description
		if (otherterms.length > 0) {
		var haystack = (prefix + ' ' + name + ' ' +
		objname + ' ' + title).toLowerCase();
		var allfound = true;
		for (i = 0; i < otherterms.length; i++) {
		if (haystack.indexOf(otherterms[i]) == -1) {
		allfound = false;
		break;
		}
		}
		if (!allfound) {
		continue;
		}
		}
		var descr = objname + _(', in ') + title;

		var anchor = match[3];
		if (anchor === '')
		anchor = fullname;
		else if (anchor == '-')
		anchor = objnames[match[1]][1] + '-' + fullname;
		// add custom score for some objects according to scorer
		if (Scorer.objPrio.hasOwnProperty(match[2])) {
		score += Scorer.objPrio[match[2]];
		} else {
		score += Scorer.objPrioDefault;
		}
		results.push([filenames[match[0]], fullname, '#'+anchor, descr, score]);
		}
		}
		}

		return results;
		},

		/**
		* search for full-text terms in the index
		*/
		performTermsSearch : function(searchterms, excluded, terms, score) {
		var filenames = this._index.filenames;
		var titles = this._index.titles;

		var i, j, file, files;
		var fileMap = {};
		var results = [];

		// perform the search on the required terms
		for (i = 0; i < searchterms.length; i++) {
		var word = searchterms[i];
		// no match but word was a required one
		if (!(files = terms[word]))
		break;
		if (files.length === undefined) {
		files = [files];
		}
		// create the mapping
		for (j = 0; j < files.length; j++) {
		file = files[j];
		if (file in fileMap)
		fileMap[file].push(word);
		else
		fileMap[file] = [word];
		}
		}

		// now check if the files don't contain excluded terms
		for (file in fileMap) {
		var valid = true;

		// check if all requirements are matched
		if (fileMap[file].length != searchterms.length)
		continue;

		// ensure that none of the excluded terms is in the search result
		for (i = 0; i < excluded.length; i++) {
		if (terms[excluded[i]] == file \|\|
		$u.contains(terms[excluded[i]] \|\| [], file)) {
		valid = false;
		break;
		}
		}

		// if we have still a valid result we can add it to the result list
		if (valid) {
		results.push([filenames[file], titles[file], '', null, score]);
		}
		}
		return results;
		},

		/**
		* helper function to return a node containing the
		* search summary for a given text. keywords is a list
		* of stemmed words, hlwords is the list of normal, unstemmed
		* words. the first one is used to find the occurance, the
		* latter for highlighting it.
		*/
		makeSearchSummary : function(text, keywords, hlwords) {
		var textLower = text.toLowerCase();
		var start = 0;
		$.each(keywords, function() {
		var i = textLower.indexOf(this.toLowerCase());
		if (i > -1)
		start = i;
		});
		start = Math.max(start - 120, 0);
		var excerpt = ((start > 0) ? '...' : '') +
		$.trim(text.substr(start, 240)) +
		((start + 240 - text.length) ? '...' : '');
		var rv = $('<div class="context"></div>').text(excerpt);
		$.each(hlwords, function() {
		rv = rv.highlightText(this, 'highlighted');
		});
		return rv;
		}
		};

		$(document).ready(function() {
		Search.init();
		});

+159

docs/_build/html/_static/sidebar.js

		/*
		* sidebar.js
		* ~~~~~~~~~~
		*
		* This script makes the Sphinx sidebar collapsible.
		*
		* .sphinxsidebar contains .sphinxsidebarwrapper. This script adds
		* in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
		* used to collapse and expand the sidebar.
		*
		* When the sidebar is collapsed the .sphinxsidebarwrapper is hidden
		* and the width of the sidebar and the margin-left of the document
		* are decreased. When the sidebar is expanded the opposite happens.
		* This script saves a per-browser/per-session cookie used to
		* remember the position of the sidebar among the pages.
		* Once the browser is closed the cookie is deleted and the position
		* reset to the default (expanded).
		*
		* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
		* :license: BSD, see LICENSE for details.
		*
		*/

		$(function() {








		// global elements used by the functions.
		// the 'sidebarbutton' element is defined as global after its
		// creation, in the add_sidebar_button function
		var bodywrapper = $('.bodywrapper');
		var sidebar = $('.sphinxsidebar');
		var sidebarwrapper = $('.sphinxsidebarwrapper');

		// for some reason, the document has no sidebar; do not run into errors
		if (!sidebar.length) return;

		// original margin-left of the bodywrapper and width of the sidebar
		// with the sidebar expanded
		var bw_margin_expanded = bodywrapper.css('margin-left');
		var ssb_width_expanded = sidebar.width();

		// margin-left of the bodywrapper and width of the sidebar
		// with the sidebar collapsed
		var bw_margin_collapsed = '.8em';
		var ssb_width_collapsed = '.8em';

		// colors used by the current theme
		var dark_color = $('.related').css('background-color');
		var light_color = $('.document').css('background-color');

		function sidebar_is_collapsed() {
		return sidebarwrapper.is(':not(:visible)');
		}

		function toggle_sidebar() {
		if (sidebar_is_collapsed())
		expand_sidebar();
		else
		collapse_sidebar();
		}

		function collapse_sidebar() {
		sidebarwrapper.hide();
		sidebar.css('width', ssb_width_collapsed);
		bodywrapper.css('margin-left', bw_margin_collapsed);
		sidebarbutton.css({
		'margin-left': '0',
		'height': bodywrapper.height()
		});
		sidebarbutton.find('span').text('»');
		sidebarbutton.attr('title', _('Expand sidebar'));
		document.cookie = 'sidebar=collapsed';
		}

		function expand_sidebar() {
		bodywrapper.css('margin-left', bw_margin_expanded);
		sidebar.css('width', ssb_width_expanded);
		sidebarwrapper.show();
		sidebarbutton.css({
		'margin-left': ssb_width_expanded-12,
		'height': bodywrapper.height()
		});
		sidebarbutton.find('span').text('«');
		sidebarbutton.attr('title', _('Collapse sidebar'));
		document.cookie = 'sidebar=expanded';
		}

		function add_sidebar_button() {
		sidebarwrapper.css({
		'float': 'left',
		'margin-right': '0',
		'width': ssb_width_expanded - 28
		});
		// create the button
		sidebar.append(
		'<div id="sidebarbutton"><span>«</span></div>'
		);
		var sidebarbutton = $('#sidebarbutton');
		light_color = sidebarbutton.css('background-color');
		// find the height of the viewport to center the '<<' in the page
		var viewport_height;
		if (window.innerHeight)
		viewport_height = window.innerHeight;
		else
		viewport_height = $(window).height();
		sidebarbutton.find('span').css({
		'display': 'block',
		'margin-top': (viewport_height - sidebar.position().top - 20) / 2
		});

		sidebarbutton.click(toggle_sidebar);
		sidebarbutton.attr('title', _('Collapse sidebar'));
		sidebarbutton.css({
		'color': '#FFFFFF',
		'border-left': '1px solid ' + dark_color,
		'font-size': '1.2em',
		'cursor': 'pointer',
		'height': bodywrapper.height(),
		'padding-top': '1px',
		'margin-left': ssb_width_expanded - 12
		});

		sidebarbutton.hover(
		function () {
		$(this).css('background-color', dark_color);
		},
		function () {
		$(this).css('background-color', light_color);
		}
		);
		}

		function set_position_from_cookie() {
		if (!document.cookie)
		return;
		var items = document.cookie.split(';');
		for(var k=0; k<items.length; k++) {
		var key_val = items[k].split('=');
		var key = key_val[0];
		if (key == 'sidebar') {
		var value = key_val[1];
		if ((value == 'collapsed') && (!sidebar_is_collapsed()))
		collapse_sidebar();
		else if ((value == 'expanded') && (sidebar_is_collapsed()))
		expand_sidebar();
		}
		}
		}

		add_sidebar_button();
		var sidebarbutton = $('#sidebarbutton');
		set_position_from_cookie();
		});

+31

docs/_build/html/_static/underscore.js

		// Underscore.js 1.3.1
		// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
		// Underscore is freely distributable under the MIT license.
		// Portions of Underscore are inspired or borrowed from Prototype,
		// Oliver Steele's Functional, and John Resig's Micro-Templating.
		// For all details and documentation:
		// http://documentcloud.github.com/underscore
		(function(){function q(a,c,d){if(a===c)return a!==0\|\|1/a==1/c;if(a==null\|\|c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
		c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"\|\|typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c\|\|a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
		h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
		b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a==
		null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect=
		function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)\|\|(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e=
		e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c\|\|(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e\|\|(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c\|\|a:a[c]).apply(a,d)})};b.pluck=
		function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})});
		return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]\|\|(d[c]=[])).push(a)});return d};b.sortedIndex=function(a,
		c,d){d\|\|(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null\|\|d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest=
		b.tail=function(a,b,d){return i.call(a,b==null\|\|d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h\|\|(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]);
		return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c,
		d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a\|\|0,a=0);for(var d=arguments[2]\|\|1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g};
		var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a,
		c){var d={};c\|\|(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f\|\|(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true:
		a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}};
		b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J\|\|function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments,
		1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)\|\|b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o\|\|function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)};
		b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a\|\|!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true\|\|a===false\|\|l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"};
		b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")};b.mixin=function(a){j(b.functions(a),
		function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj\|\|{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape\|\|t,function(a,b){return"',_.escape("+
		u(b)+"),'"}).replace(d.interpolate\|\|t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate\|\|t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]=
		function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"\|\|a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain=
		true;return this};m.prototype.value=function(){return this._wrapped}}).call(this);

docs/_build/html/_static/up-pressed.png

Sorry, the diff of this file is not supported yet

docs/_build/html/_static/up.png

Sorry, the diff of this file is not supported yet

+808

docs/_build/html/_static/websupport.js

		/*
		* websupport.js
		* ~~~~~~~~~~~~~
		*
		* sphinx.websupport utilties for all documentation.
		*
		* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
		* :license: BSD, see LICENSE for details.
		*
		*/

		(function($) {
		$.fn.autogrow = function() {
		return this.each(function() {
		var textarea = this;

		$.fn.autogrow.resize(textarea);

		$(textarea)
		.focus(function() {
		textarea.interval = setInterval(function() {
		$.fn.autogrow.resize(textarea);
		}, 500);
		})
		.blur(function() {
		clearInterval(textarea.interval);
		});
		});
		};

		$.fn.autogrow.resize = function(textarea) {
		var lineHeight = parseInt($(textarea).css('line-height'), 10);
		var lines = textarea.value.split('\n');
		var columns = textarea.cols;
		var lineCount = 0;
		$.each(lines, function() {
		lineCount += Math.ceil(this.length / columns) \|\| 1;
		});
		var height = lineHeight * (lineCount + 1);
		$(textarea).css('height', height);
		};
		})(jQuery);

		(function($) {
		var comp, by;

		function init() {
		initEvents();
		initComparator();
		}

		function initEvents() {
		$('a.comment-close').live("click", function(event) {
		event.preventDefault();
		hide($(this).attr('id').substring(2));
		});
		$('a.vote').live("click", function(event) {
		event.preventDefault();
		handleVote($(this));
		});
		$('a.reply').live("click", function(event) {
		event.preventDefault();
		openReply($(this).attr('id').substring(2));
		});
		$('a.close-reply').live("click", function(event) {
		event.preventDefault();
		closeReply($(this).attr('id').substring(2));
		});
		$('a.sort-option').live("click", function(event) {
		event.preventDefault();
		handleReSort($(this));
		});
		$('a.show-proposal').live("click", function(event) {
		event.preventDefault();
		showProposal($(this).attr('id').substring(2));
		});
		$('a.hide-proposal').live("click", function(event) {
		event.preventDefault();
		hideProposal($(this).attr('id').substring(2));
		});
		$('a.show-propose-change').live("click", function(event) {
		event.preventDefault();
		showProposeChange($(this).attr('id').substring(2));
		});
		$('a.hide-propose-change').live("click", function(event) {
		event.preventDefault();
		hideProposeChange($(this).attr('id').substring(2));
		});
		$('a.accept-comment').live("click", function(event) {
		event.preventDefault();
		acceptComment($(this).attr('id').substring(2));
		});
		$('a.delete-comment').live("click", function(event) {
		event.preventDefault();
		deleteComment($(this).attr('id').substring(2));
		});
		$('a.comment-markup').live("click", function(event) {
		event.preventDefault();
		toggleCommentMarkupBox($(this).attr('id').substring(2));
		});
		}

		/**
		* Set comp, which is a comparator function used for sorting and
		* inserting comments into the list.
		*/
		function setComparator() {
		// If the first three letters are "asc", sort in ascending order
		// and remove the prefix.
		if (by.substring(0,3) == 'asc') {
		var i = by.substring(3);
		comp = function(a, b) { return a[i] - b[i]; };
		} else {
		// Otherwise sort in descending order.
		comp = function(a, b) { return b[by] - a[by]; };
		}

		// Reset link styles and format the selected sort option.
		$('a.sel').attr('href', '#').removeClass('sel');
		$('a.by' + by).removeAttr('href').addClass('sel');
		}

		/**
		* Create a comp function. If the user has preferences stored in
		* the sortBy cookie, use those, otherwise use the default.
		*/
		function initComparator() {
		by = 'rating'; // Default to sort by rating.
		// If the sortBy cookie is set, use that instead.
		if (document.cookie.length > 0) {
		var start = document.cookie.indexOf('sortBy=');
		if (start != -1) {
		start = start + 7;
		var end = document.cookie.indexOf(";", start);
		if (end == -1) {
		end = document.cookie.length;
		by = unescape(document.cookie.substring(start, end));
		}
		}
		}
		setComparator();
		}

		/**
		* Show a comment div.
		*/
		function show(id) {
		$('#ao' + id).hide();
		$('#ah' + id).show();
		var context = $.extend({id: id}, opts);
		var popup = $(renderTemplate(popupTemplate, context)).hide();
		popup.find('textarea[name="proposal"]').hide();
		popup.find('a.by' + by).addClass('sel');
		var form = popup.find('#cf' + id);
		form.submit(function(event) {
		event.preventDefault();
		addComment(form);
		});
		$('#s' + id).after(popup);
		popup.slideDown('fast', function() {
		getComments(id);
		});
		}

		/**
		* Hide a comment div.
		*/
		function hide(id) {
		$('#ah' + id).hide();
		$('#ao' + id).show();
		var div = $('#sc' + id);
		div.slideUp('fast', function() {
		div.remove();
		});
		}

		/**
		* Perform an ajax request to get comments for a node
		* and insert the comments into the comments tree.
		*/
		function getComments(id) {
		$.ajax({
		type: 'GET',
		url: opts.getCommentsURL,
		data: {node: id},
		success: function(data, textStatus, request) {
		var ul = $('#cl' + id);
		var speed = 100;
		$('#cf' + id)
		.find('textarea[name="proposal"]')
		.data('source', data.source);

		if (data.comments.length === 0) {
		ul.html('<li>No comments yet.</li>');
		ul.data('empty', true);
		} else {
		// If there are comments, sort them and put them in the list.
		var comments = sortComments(data.comments);
		speed = data.comments.length * 100;
		appendComments(comments, ul);
		ul.data('empty', false);
		}
		$('#cn' + id).slideUp(speed + 200);
		ul.slideDown(speed);
		},
		error: function(request, textStatus, error) {
		showError('Oops, there was a problem retrieving the comments.');
		},
		dataType: 'json'
		});
		}

		/**
		* Add a comment via ajax and insert the comment into the comment tree.
		*/
		function addComment(form) {
		var node_id = form.find('input[name="node"]').val();
		var parent_id = form.find('input[name="parent"]').val();
		var text = form.find('textarea[name="comment"]').val();
		var proposal = form.find('textarea[name="proposal"]').val();

		if (text == '') {
		showError('Please enter a comment.');
		return;
		}

		// Disable the form that is being submitted.
		form.find('textarea,input').attr('disabled', 'disabled');

		// Send the comment to the server.
		$.ajax({
		type: "POST",
		url: opts.addCommentURL,
		dataType: 'json',
		data: {
		node: node_id,
		parent: parent_id,
		text: text,
		proposal: proposal
		},
		success: function(data, textStatus, error) {
		// Reset the form.
		if (node_id) {
		hideProposeChange(node_id);
		}
		form.find('textarea')
		.val('')
		.add(form.find('input'))
		.removeAttr('disabled');
		var ul = $('#cl' + (node_id \|\| parent_id));
		if (ul.data('empty')) {
		$(ul).empty();
		ul.data('empty', false);
		}
		insertComment(data.comment);
		var ao = $('#ao' + node_id);
		ao.find('img').attr({'src': opts.commentBrightImage});
		if (node_id) {
		// if this was a "root" comment, remove the commenting box
		// (the user can get it back by reopening the comment popup)
		$('#ca' + node_id).slideUp();
		}
		},
		error: function(request, textStatus, error) {
		form.find('textarea,input').removeAttr('disabled');
		showError('Oops, there was a problem adding the comment.');
		}
		});
		}

		/**
		* Recursively append comments to the main comment list and children
		* lists, creating the comment tree.
		*/
		function appendComments(comments, ul) {
		$.each(comments, function() {
		var div = createCommentDiv(this);
		ul.append($(document.createElement('li')).html(div));
		appendComments(this.children, div.find('ul.comment-children'));
		// To avoid stagnating data, don't store the comments children in data.
		this.children = null;
		div.data('comment', this);
		});
		}

		/**
		* After adding a new comment, it must be inserted in the correct
		* location in the comment tree.
		*/
		function insertComment(comment) {
		var div = createCommentDiv(comment);

		// To avoid stagnating data, don't store the comments children in data.
		comment.children = null;
		div.data('comment', comment);

		var ul = $('#cl' + (comment.node \|\| comment.parent));
		var siblings = getChildren(ul);

		var li = $(document.createElement('li'));
		li.hide();

		// Determine where in the parents children list to insert this comment.
		for(i=0; i < siblings.length; i++) {
		if (comp(comment, siblings[i]) <= 0) {
		$('#cd' + siblings[i].id)
		.parent()
		.before(li.html(div));
		li.slideDown('fast');
		return;
		}
		}

		// If we get here, this comment rates lower than all the others,
		// or it is the only comment in the list.
		ul.append(li.html(div));
		li.slideDown('fast');
		}

		function acceptComment(id) {
		$.ajax({
		type: 'POST',
		url: opts.acceptCommentURL,
		data: {id: id},
		success: function(data, textStatus, request) {
		$('#cm' + id).fadeOut('fast');
		$('#cd' + id).removeClass('moderate');
		},
		error: function(request, textStatus, error) {
		showError('Oops, there was a problem accepting the comment.');
		}
		});
		}

		function deleteComment(id) {
		$.ajax({
		type: 'POST',
		url: opts.deleteCommentURL,
		data: {id: id},
		success: function(data, textStatus, request) {
		var div = $('#cd' + id);
		if (data == 'delete') {
		// Moderator mode: remove the comment and all children immediately
		div.slideUp('fast', function() {
		div.remove();
		});
		return;
		}
		// User mode: only mark the comment as deleted
		div
		.find('span.user-id:first')
		.text('[deleted]').end()
		.find('div.comment-text:first')
		.text('[deleted]').end()
		.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
		', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
		.remove();
		var comment = div.data('comment');
		comment.username = '[deleted]';
		comment.text = '[deleted]';
		div.data('comment', comment);
		},
		error: function(request, textStatus, error) {
		showError('Oops, there was a problem deleting the comment.');
		}
		});
		}

		function showProposal(id) {
		$('#sp' + id).hide();
		$('#hp' + id).show();
		$('#pr' + id).slideDown('fast');
		}

		function hideProposal(id) {
		$('#hp' + id).hide();
		$('#sp' + id).show();
		$('#pr' + id).slideUp('fast');
		}

		function showProposeChange(id) {
		$('#pc' + id).hide();
		$('#hc' + id).show();
		var textarea = $('#pt' + id);
		textarea.val(textarea.data('source'));
		$.fn.autogrow.resize(textarea[0]);
		textarea.slideDown('fast');
		}

		function hideProposeChange(id) {
		$('#hc' + id).hide();
		$('#pc' + id).show();
		var textarea = $('#pt' + id);
		textarea.val('').removeAttr('disabled');
		textarea.slideUp('fast');
		}

		function toggleCommentMarkupBox(id) {
		$('#mb' + id).toggle();
		}

		/** Handle when the user clicks on a sort by link. */
		function handleReSort(link) {
		var classes = link.attr('class').split(/\s+/);
		for (var i=0; i<classes.length; i++) {
		if (classes[i] != 'sort-option') {
		by = classes[i].substring(2);
		}
		}
		setComparator();
		// Save/update the sortBy cookie.
		var expiration = new Date();
		expiration.setDate(expiration.getDate() + 365);
		document.cookie= 'sortBy=' + escape(by) +
		';expires=' + expiration.toUTCString();
		$('ul.comment-ul').each(function(index, ul) {
		var comments = getChildren($(ul), true);
		comments = sortComments(comments);
		appendComments(comments, $(ul).empty());
		});
		}

		/**
		* Function to process a vote when a user clicks an arrow.
		*/
		function handleVote(link) {
		if (!opts.voting) {
		showError("You'll need to login to vote.");
		return;
		}

		var id = link.attr('id');
		if (!id) {
		// Didn't click on one of the voting arrows.
		return;
		}
		// If it is an unvote, the new vote value is 0,
		// Otherwise it's 1 for an upvote, or -1 for a downvote.
		var value = 0;
		if (id.charAt(1) != 'u') {
		value = id.charAt(0) == 'u' ? 1 : -1;
		}
		// The data to be sent to the server.
		var d = {
		comment_id: id.substring(2),
		value: value
		};

		// Swap the vote and unvote links.
		link.hide();
		$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
		.show();

		// The div the comment is displayed in.
		var div = $('div#cd' + d.comment_id);
		var data = div.data('comment');

		// If this is not an unvote, and the other vote arrow has
		// already been pressed, unpress it.
		if ((d.value !== 0) && (data.vote === d.value * -1)) {
		$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
		$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
		}

		// Update the comments rating in the local data.
		data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
		data.vote = d.value;
		div.data('comment', data);

		// Change the rating text.
		div.find('.rating:first')
		.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));

		// Send the vote information to the server.
		$.ajax({
		type: "POST",
		url: opts.processVoteURL,
		data: d,
		error: function(request, textStatus, error) {
		showError('Oops, there was a problem casting that vote.');
		}
		});
		}

		/**
		* Open a reply form used to reply to an existing comment.
		*/
		function openReply(id) {
		// Swap out the reply link for the hide link
		$('#rl' + id).hide();
		$('#cr' + id).show();

		// Add the reply li to the children ul.
		var div = $(renderTemplate(replyTemplate, {id: id})).hide();
		$('#cl' + id)
		.prepend(div)
		// Setup the submit handler for the reply form.
		.find('#rf' + id)
		.submit(function(event) {
		event.preventDefault();
		addComment($('#rf' + id));
		closeReply(id);
		})
		.find('input[type=button]')
		.click(function() {
		closeReply(id);
		});
		div.slideDown('fast', function() {
		$('#rf' + id).find('textarea').focus();
		});
		}

		/**
		* Close the reply form opened with openReply.
		*/
		function closeReply(id) {
		// Remove the reply div from the DOM.
		$('#rd' + id).slideUp('fast', function() {
		$(this).remove();
		});

		// Swap out the hide link for the reply link
		$('#cr' + id).hide();
		$('#rl' + id).show();
		}

		/**
		* Recursively sort a tree of comments using the comp comparator.
		*/
		function sortComments(comments) {
		comments.sort(comp);
		$.each(comments, function() {
		this.children = sortComments(this.children);
		});
		return comments;
		}

		/**
		* Get the children comments from a ul. If recursive is true,
		* recursively include childrens' children.
		*/
		function getChildren(ul, recursive) {
		var children = [];
		ul.children().children("[id^='cd']")
		.each(function() {
		var comment = $(this).data('comment');
		if (recursive)
		comment.children = getChildren($(this).find('#cl' + comment.id), true);
		children.push(comment);
		});
		return children;
		}

		/** Create a div to display a comment in. */
		function createCommentDiv(comment) {
		if (!comment.displayed && !opts.moderator) {
		return $('<div class="moderate">Thank you! Your comment will show up '
		+ 'once it is has been approved by a moderator.</div>');
		}
		// Prettify the comment rating.
		comment.pretty_rating = comment.rating + ' point' +
		(comment.rating == 1 ? '' : 's');
		// Make a class (for displaying not yet moderated comments differently)
		comment.css_class = comment.displayed ? '' : ' moderate';
		// Create a div for this comment.
		var context = $.extend({}, opts, comment);
		var div = $(renderTemplate(commentTemplate, context));

		// If the user has voted on this comment, highlight the correct arrow.
		if (comment.vote) {
		var direction = (comment.vote == 1) ? 'u' : 'd';
		div.find('#' + direction + 'v' + comment.id).hide();
		div.find('#' + direction + 'u' + comment.id).show();
		}

		if (opts.moderator \|\| comment.text != '[deleted]') {
		div.find('a.reply').show();
		if (comment.proposal_diff)
		div.find('#sp' + comment.id).show();
		if (opts.moderator && !comment.displayed)
		div.find('#cm' + comment.id).show();
		if (opts.moderator \|\| (opts.username == comment.username))
		div.find('#dc' + comment.id).show();
		}
		return div;
		}

		/**
		* A simple template renderer. Placeholders such as <%id%> are replaced
		* by context['id'] with items being escaped. Placeholders such as <#id#>
		* are not escaped.
		*/
		function renderTemplate(template, context) {
		var esc = $(document.createElement('div'));

		function handle(ph, escape) {
		var cur = context;
		$.each(ph.split('.'), function() {
		cur = cur[this];
		});
		return escape ? esc.text(cur \|\| "").html() : cur;
		}

		return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
		return handle(arguments[2], arguments[1] == '%' ? true : false);
		});
		}

		/** Flash an error message briefly. */
		function showError(message) {
		$(document.createElement('div')).attr({'class': 'popup-error'})
		.append($(document.createElement('div'))
		.attr({'class': 'error-message'}).text(message))
		.appendTo('body')
		.fadeIn("slow")
		.delay(2000)
		.fadeOut("slow");
		}

		/** Add a link the user uses to open the comments popup. */
		$.fn.comment = function() {
		return this.each(function() {
		var id = $(this).attr('id').substring(1);
		var count = COMMENT_METADATA[id];
		var title = count + ' comment' + (count == 1 ? '' : 's');
		var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
		var addcls = count == 0 ? ' nocomment' : '';
		$(this)
		.append(
		$(document.createElement('a')).attr({
		href: '#',
		'class': 'sphinx-comment-open' + addcls,
		id: 'ao' + id
		})
		.append($(document.createElement('img')).attr({
		src: image,
		alt: 'comment',
		title: title
		}))
		.click(function(event) {
		event.preventDefault();
		show($(this).attr('id').substring(2));
		})
		)
		.append(
		$(document.createElement('a')).attr({
		href: '#',
		'class': 'sphinx-comment-close hidden',
		id: 'ah' + id
		})
		.append($(document.createElement('img')).attr({
		src: opts.closeCommentImage,
		alt: 'close',
		title: 'close'
		}))
		.click(function(event) {
		event.preventDefault();
		hide($(this).attr('id').substring(2));
		})
		);
		});
		};

		var opts = {
		processVoteURL: '/_process_vote',
		addCommentURL: '/_add_comment',
		getCommentsURL: '/_get_comments',
		acceptCommentURL: '/_accept_comment',
		deleteCommentURL: '/_delete_comment',
		commentImage: '/static/_static/comment.png',
		closeCommentImage: '/static/_static/comment-close.png',
		loadingImage: '/static/_static/ajax-loader.gif',
		commentBrightImage: '/static/_static/comment-bright.png',
		upArrow: '/static/_static/up.png',
		downArrow: '/static/_static/down.png',
		upArrowPressed: '/static/_static/up-pressed.png',
		downArrowPressed: '/static/_static/down-pressed.png',
		voting: false,
		moderator: false
		};

		if (typeof COMMENT_OPTIONS != "undefined") {
		opts = jQuery.extend(opts, COMMENT_OPTIONS);
		}

		var popupTemplate = '\
		<div class="sphinx-comments" id="sc<%id%>">\
		<p class="sort-options">\
		Sort by:\
		<a href="#" class="sort-option byrating">best rated</a>\
		<a href="#" class="sort-option byascage">newest</a>\
		<a href="#" class="sort-option byage">oldest</a>\
		</p>\
		<div class="comment-header">Comments</div>\
		<div class="comment-loading" id="cn<%id%>">\
		loading comments... <img src="<%loadingImage%>" alt="" /></div>\
		<ul id="cl<%id%>" class="comment-ul"></ul>\
		<div id="ca<%id%>">\
		<p class="add-a-comment">Add a comment\
		(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
		<div class="comment-markup-box" id="mb<%id%>">\
		reStructured text markup: <i>emph</i>, <b>strong</b>, \
		<tt>``code``</tt>, \
		code blocks: <tt>::</tt> and an indented block after blank line</div>\
		<form method="post" id="cf<%id%>" class="comment-form" action="">\
		<textarea name="comment" cols="80"></textarea>\
		<p class="propose-button">\
		<a href="#" id="pc<%id%>" class="show-propose-change">\
		Propose a change ▹\
		</a>\
		<a href="#" id="hc<%id%>" class="hide-propose-change">\
		Propose a change ▿\
		</a>\
		</p>\
		<textarea name="proposal" id="pt<%id%>" cols="80"\
		spellcheck="false"></textarea>\
		<input type="submit" value="Add comment" />\
		<input type="hidden" name="node" value="<%id%>" />\
		<input type="hidden" name="parent" value="" />\
		</form>\
		</div>\
		</div>';

		var commentTemplate = '\
		<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
		<div class="vote">\
		<div class="arrow">\
		<a href="#" id="uv<%id%>" class="vote" title="vote up">\
		<img src="<%upArrow%>" />\
		</a>\
		<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
		<img src="<%upArrowPressed%>" />\
		</a>\
		</div>\
		<div class="arrow">\
		<a href="#" id="dv<%id%>" class="vote" title="vote down">\
		<img src="<%downArrow%>" id="da<%id%>" />\
		</a>\
		<a href="#" id="du<%id%>" class="un vote" title="vote down">\
		<img src="<%downArrowPressed%>" />\
		</a>\
		</div>\
		</div>\
		<div class="comment-content">\
		<p class="tagline comment">\
		<span class="user-id"><%username%></span>\
		<span class="rating"><%pretty_rating%></span>\
		<span class="delta"><%time.delta%></span>\
		</p>\
		<div class="comment-text comment"><#text#></div>\
		<p class="comment-opts comment">\
		<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
		<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
		<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
		<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
		<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
		<span id="cm<%id%>" class="moderation hidden">\
		<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
		</span>\
		</p>\
		<pre class="proposal" id="pr<%id%>">\
		<#proposal_diff#>\
		</pre>\
		<ul class="comment-children" id="cl<%id%>"></ul>\
		</div>\
		<div class="clearleft"></div>\
		</div>\
		</div>';

		var replyTemplate = '\
		<li>\
		<div class="reply-div" id="rd<%id%>">\
		<form id="rf<%id%>">\
		<textarea name="comment" cols="80"></textarea>\
		<input type="submit" value="Add reply" />\
		<input type="button" value="Cancel" />\
		<input type="hidden" name="parent" value="<%id%>" />\
		<input type="hidden" name="node" value="" />\
		</form>\
		</div>\
		</li>';

		$(document).ready(function() {
		init();
		});
		})(jQuery);

		$(document).ready(function() {
		// add comment anchors for all paragraphs that are commentable
		$('.sphinx-has-comment').comment();

		// highlight search words in search results
		$("div.context").each(function() {
		var params = $.getQueryParameters();
		var terms = (params.q) ? params.q[0].split(/\s+/) : [];
		var result = $(this);
		$.each(terms, function() {
		result.highlightText(this.toLowerCase(), 'highlighted');
		});
		});

		// directly open comment window if requested
		var anchor = document.location.hash;
		if (anchor.substring(0, 9) == '#comment-') {
		$('#ao' + anchor.substring(9)).click();
		document.location.hash = '#s' + anchor.substring(9);
		}
		});

docs/_build/html/.buildinfo

Sorry, the diff of this file is not supported yet

+337

docs/_build/html/api.html

		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>Python API — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="_static/default.css" type="text/css" />
		<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: './',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="_static/jquery.js"></script>
		<script type="text/javascript" src="_static/underscore.js"></script>
		<script type="text/javascript" src="_static/doctools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="index.html" />
		<link rel="next" title="Changelog" href="changelog.html" />
		<link rel="prev" title="Usage" href="usage.html" />
		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		accesskey="I">index</a></li>
		<li class="right" >
		<a href="changelog.html" title="Changelog"
		accesskey="N">next</a> \|</li>
		<li class="right" >
		<a href="usage.html" title="Usage"
		accesskey="P">previous</a> \|</li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">

		<div class="section" id="python-api">
		<h1>Python API<a class="headerlink" href="#python-api" title="Permalink to this headline">¶</a></h1>
		<dl class="function">
		<dt id="envdir.open">
		<tt class="descclassname">envdir.</tt><tt class="descname">open</tt><big>(</big><span class="optional">[</span><em>path</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#envdir.open" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<p>To use an envdir in a Python file (e.g. Django’s <tt class="docutils literal"><span class="pre">manage.py</span></tt>) simply call
		the <tt class="docutils literal"><span class="pre">open</span></tt> function of the envdir module:</p>
		<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">envdir</span>
		<span class="n">envdir</span><span class="o">.</span><span class="n">open</span><span class="p">()</span>
		</pre></div>
		</div>
		<p>envdir will try to find an <tt class="file docutils literal"><span class="pre">envdir</span></tt> directory next to the file you modified.</p>
		<p>It’s also possible to explicitly pass the path to the envdir:</p>
		<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">envdir</span>

		<span class="n">envdir</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">'/home/jezdez/mysite/envs/prod'</span><span class="p">)</span>
		</pre></div>
		</div>
		<p>Calling <tt class="docutils literal"><span class="pre">open</span></tt> will automatically apply all environment variables to the
		current instance of <tt class="docutils literal"><span class="pre">os.environ</span></tt>.</p>
		<p>If you want to implement more advanced access to envdirs there is also an
		own dict-like <a class="reference internal" href="#envdir.Env" title="envdir.Env"><tt class="xref py py-class docutils literal"><span class="pre">Env</span></tt></a> object to work with. The above example
		could also be written like this:</p>
		<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">envdir</span>

		<span class="n">env</span> <span class="o">=</span> <span class="n">envdir</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">'/home/jezdez/mysite/envs/prod'</span><span class="p">)</span>
		</pre></div>
		</div>
		<p>The returned <a class="reference internal" href="#envdir.Env" title="envdir.Env"><tt class="xref py py-class docutils literal"><span class="pre">Env</span></tt></a> instance has a dict-like interface but also
		features a <a class="reference internal" href="#envdir.Env.clear" title="envdir.Env.clear"><tt class="xref py py-meth docutils literal"><span class="pre">clear()</span></tt></a> method to reset the current instance of
		<a class="reference external" href="http://docs.python.org/library/os.html#os.environ" title="(in Python v2.7)"><tt class="xref py py-data docutils literal"><span class="pre">os.environ</span></tt></a> to the value it had before the envdir was opened:</p>
		<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">envdir</span>

		<span class="n">env</span> <span class="o">=</span> <span class="n">envdir</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">'/home/jezdez/mysite/envs/prod'</span><span class="p">)</span>

		<span class="c"># do something</span>

		<span class="n">env</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
		</pre></div>
		</div>
		<p>Since calling the clear method should be done in a transparent manner
		you can also use it as a context manager:</p>
		<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">envdir</span>

		<span class="k">with</span> <span class="n">envdir</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">'/home/jezdez/mysite/envs/prod'</span><span class="p">)</span> <span class="k">as</span> <span class="n">env</span><span class="p">:</span>
		<span class="c"># do something</span>
		</pre></div>
		</div>
		<p>Outside the context manager block the environ is reset back automatically.</p>
		<p>To access and write values you can also use the dict-like interface:</p>
		<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">envdir</span>

		<span class="k">with</span> <span class="n">envdir</span><span class="o">.</span><span class="n">open</span><span class="p">()</span> <span class="k">as</span> <span class="n">env</span><span class="p">:</span>
		<span class="n">env</span><span class="p">[</span><span class="s">'DATABASE_URL'</span><span class="p">]</span> <span class="o">=</span> <span class="s">'sqlite://:memory:'</span>
		<span class="k">assert</span> <span class="s">'DATABASE_URL'</span> <span class="ow">in</span> <span class="n">env</span>
		<span class="k">assert</span> <span class="n">env</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="o">==</span> <span class="p">[(</span><span class="s">'DATABASE_URL'</span><span class="p">,</span> <span class="s">'sqlite://:memory:'</span><span class="p">)]</span>
		</pre></div>
		</div>
		<div class="admonition note">
		<p class="first admonition-title">Note</p>
		<p class="last">Additions to the envdir done inside the context manager block are
		persisted to disk and will be available the next time your open the
		envdir again.</p>
		</div>
		<p>Of course you can also directly interact with <a class="reference internal" href="#envdir.Env" title="envdir.Env"><tt class="xref py py-class docutils literal"><span class="pre">Env</span></tt></a> instances,
		e.g.:</p>
		<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">envdir</span>

		<span class="k">with</span> <span class="n">envdir</span><span class="o">.</span><span class="n">Env</span><span class="p">(</span><span class="s">'/home/jezdez/mysite/envs/prod'</span><span class="p">)</span> <span class="k">as</span> <span class="n">env</span><span class="p">:</span>
		<span class="c"># do something here</span>
		</pre></div>
		</div>
		<p>The difference between instantiating an <a class="reference internal" href="#envdir.Env" title="envdir.Env"><tt class="xref py py-class docutils literal"><span class="pre">Env</span></tt></a> yourself to
		using <a class="reference internal" href="#envdir.open" title="envdir.open"><tt class="xref py py-func docutils literal"><span class="pre">envdir.open()</span></tt></a> is that you’ll lose the automatic discovery of
		the <tt class="docutils literal"><span class="pre">envdir</span></tt> directory.</p>
		<p>See the API docs below for a full list of methods available in the
		<a class="reference internal" href="#envdir.Env" title="envdir.Env"><tt class="xref py py-class docutils literal"><span class="pre">Env</span></tt></a> object.</p>
		<dl class="class">
		<dt id="envdir.Env">
		<em class="property">class </em><tt class="descclassname">envdir.</tt><tt class="descname">Env</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#envdir.Env" title="Permalink to this definition">¶</a></dt>
		<dd><p>An dict-like object to represent an envdir environment with extensive
		API, can be used as context manager, too.</p>
		<dl class="method">
		<dt id="envdir.Env.__cmp__">
		<tt class="descname">__cmp__</tt><big>(</big><em>dict</em><big>)</big><a class="headerlink" href="#envdir.Env.__cmp__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__contains__">
		<tt class="descname">__contains__</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#envdir.Env.__contains__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__delitem__">
		<tt class="descname">__delitem__</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#envdir.Env.__delitem__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__enter__">
		<tt class="descname">__enter__</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.__enter__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__exit__">
		<tt class="descname">__exit__</tt><big>(</big><em>type</em>, <em>value</em>, <em>traceback</em><big>)</big><a class="headerlink" href="#envdir.Env.__exit__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__getitem__">
		<tt class="descname">__getitem__</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#envdir.Env.__getitem__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="attribute">
		<dt id="envdir.Env.__hash__">
		<tt class="descname">__hash__</tt><em class="property"> = None</em><a class="headerlink" href="#envdir.Env.__hash__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__init__">
		<tt class="descname">__init__</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#envdir.Env.__init__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__iter__">
		<tt class="descname">__iter__</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.__iter__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__len__">
		<tt class="descname">__len__</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.__len__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="attribute">
		<dt id="envdir.Env.__module__">
		<tt class="descname">__module__</tt><em class="property"> = 'envdir.env'</em><a class="headerlink" href="#envdir.Env.__module__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__repr__">
		<tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.__repr__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.__setitem__">
		<tt class="descname">__setitem__</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#envdir.Env.__setitem__" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.clear">
		<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.clear" title="Permalink to this definition">¶</a></dt>
		<dd><p>Clears the envdir by resetting the os.environ items to the
		values it had before opening this envdir (or removing them
		if they didn’t exist). Doesn’t delete the envdir files.</p>
		</dd></dl>

		<dl class="method">
		<dt id="envdir.Env.copy">
		<tt class="descname">copy</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.copy" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="classmethod">
		<dt id="envdir.Env.fromkeys">
		<em class="property">classmethod </em><tt class="descname">fromkeys</tt><big>(</big><em>iterable</em>, <em>value=None</em><big>)</big><a class="headerlink" href="#envdir.Env.fromkeys" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.get">
		<tt class="descname">get</tt><big>(</big><em>key</em>, <em>failobj=None</em><big>)</big><a class="headerlink" href="#envdir.Env.get" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.has_key">
		<tt class="descname">has_key</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#envdir.Env.has_key" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.items">
		<tt class="descname">items</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.items" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.iteritems">
		<tt class="descname">iteritems</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.iteritems" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.iterkeys">
		<tt class="descname">iterkeys</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.iterkeys" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.itervalues">
		<tt class="descname">itervalues</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.itervalues" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.keys">
		<tt class="descname">keys</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.keys" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.pop">
		<tt class="descname">pop</tt><big>(</big><em>key</em>, <em>*args</em><big>)</big><a class="headerlink" href="#envdir.Env.pop" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.popitem">
		<tt class="descname">popitem</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.popitem" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.setdefault">
		<tt class="descname">setdefault</tt><big>(</big><em>key</em>, <em>failobj=None</em><big>)</big><a class="headerlink" href="#envdir.Env.setdefault" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.update">
		<tt class="descname">update</tt><big>(</big><em>dict=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#envdir.Env.update" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		<dl class="method">
		<dt id="envdir.Env.values">
		<tt class="descname">values</tt><big>(</big><big>)</big><a class="headerlink" href="#envdir.Env.values" title="Permalink to this definition">¶</a></dt>
		<dd></dd></dl>

		</dd></dl>

		</div>


		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">
		<h4>Previous topic</h4>
		<p class="topless"><a href="usage.html"
		title="previous chapter">Usage</a></p>
		<h4>Next topic</h4>
		<p class="topless"><a href="changelog.html"
		title="next chapter">Changelog</a></p>
		<h3>This Page</h3>
		<ul class="this-page-menu">
		<li><a href="_sources/api.txt"
		rel="nofollow">Show Source</a></li>
		</ul>
		<div id="searchbox" style="display: none">
		<h3>Quick search</h3>
		<form class="search" action="search.html" method="get">
		<input type="text" name="q" />
		<input type="submit" value="Go" />
		<input type="hidden" name="check_keywords" value="yes" />
		<input type="hidden" name="area" value="default" />
		</form>
		<p class="searchtip" style="font-size: 90%">
		Enter search terms or a module, class or function name.
		</p>
		</div>
		<script type="text/javascript">$('#searchbox').show(0);</script>
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		>index</a></li>
		<li class="right" >
		<a href="changelog.html" title="Changelog"
		>next</a> \|</li>
		<li class="right" >
		<a href="usage.html" title="Usage"
		>previous</a> \|</li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

+182

docs/_build/html/changelog.html

		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>Changelog — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="_static/default.css" type="text/css" />
		<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: './',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="_static/jquery.js"></script>
		<script type="text/javascript" src="_static/underscore.js"></script>
		<script type="text/javascript" src="_static/doctools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="index.html" />
		<link rel="prev" title="Python API" href="api.html" />
		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		accesskey="I">index</a></li>
		<li class="right" >
		<a href="api.html" title="Python API"
		accesskey="P">previous</a> \|</li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">

		<div class="section" id="changelog">
		<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
		<div class="section" id="id1">
		<h2>0.6 (12/02/2013)<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
		<ul class="simple">
		<li>Rewrote tests with pytest.</li>
		<li>Vastly extended Python API.</li>
		<li>Added Sphinx based docs: <a class="reference external" href="http://envdir.readthedocs.org/">http://envdir.readthedocs.org/</a></li>
		<li>Fixed killing child process when capturing keyboard interrupt.</li>
		</ul>
		</div>
		<div class="section" id="id2">
		<h2>0.5 (09/22/2013)<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
		<ul class="simple">
		<li>Added check if the the provided path is a directory and throw an error if
		not. This adds compatibility to the daemontools’ envdir.</li>
		<li>Make sure to convert Nulls (<tt class="docutils literal"><span class="pre">\0</span></tt>) to newlines as done so in daemontools’
		envdir.</li>
		</ul>
		</div>
		<div class="section" id="id3">
		<h2>0.4.1 (08/21/2013)<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
		<ul class="simple">
		<li>Fixed <tt class="docutils literal"><span class="pre">envdir.read()</span></tt> to actually work with already existing environment
		variables. Extended docs to test Python use.</li>
		</ul>
		</div>
		<div class="section" id="id4">
		<h2>0.4 (08/09/2013)<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
		<ul>
		<li><p class="first">Added <tt class="docutils literal"><span class="pre">envshell</span></tt> command which launches a subshell using the environment
		as defined in the given envdir. Example:</p>
		<div class="highlight-python"><pre>$ envshell ~/mysite/envs/prod/
		Launching envshell for /home/jezdez/mysite/envs/prod. Type 'exit' or 'Ctrl+D' to return.
		$ python manage.py runserver
		..</pre>
		</div>
		</li>
		</ul>
		</div>
		<div class="section" id="id5">
		<h2>0.3 (07/30/2013)<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
		<ul class="simple">
		<li>Catch <tt class="docutils literal"><span class="pre">KeyboardInterrupt</span></tt> exceptions to not show a traceback from envdir
		but the repsonse from the called command.</li>
		<li>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.</li>
		</ul>
		</div>
		<div class="section" id="id6">
		<h2>0.2.1 (07/11/2013)<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
		<ul class="simple">
		<li>Fixed <tt class="docutils literal"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">envdir</span></tt></li>
		<li>Extended README to better describe the purpose</li>
		</ul>
		</div>
		<div class="section" id="id7">
		<h2>0.2 (07/10/2013)<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2>
		<ul class="simple">
		<li>Added ability to use envdir from Python.</li>
		</ul>
		</div>
		<div class="section" id="id8">
		<h2>0.1 (07/10/2013)<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2>
		<ul class="simple">
		<li>Initial release.</li>
		</ul>
		</div>
		</div>


		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">
		<h3><a href="index.html">Table Of Contents</a></h3>
		<ul>
		<li><a class="reference internal" href="#">Changelog</a><ul>
		<li><a class="reference internal" href="#id1">0.6 (12/02/2013)</a></li>
		<li><a class="reference internal" href="#id2">0.5 (09/22/2013)</a></li>
		<li><a class="reference internal" href="#id3">0.4.1 (08/21/2013)</a></li>
		<li><a class="reference internal" href="#id4">0.4 (08/09/2013)</a></li>
		<li><a class="reference internal" href="#id5">0.3 (07/30/2013)</a></li>
		<li><a class="reference internal" href="#id6">0.2.1 (07/11/2013)</a></li>
		<li><a class="reference internal" href="#id7">0.2 (07/10/2013)</a></li>
		<li><a class="reference internal" href="#id8">0.1 (07/10/2013)</a></li>
		</ul>
		</li>
		</ul>

		<h4>Previous topic</h4>
		<p class="topless"><a href="api.html"
		title="previous chapter">Python API</a></p>
		<h3>This Page</h3>
		<ul class="this-page-menu">
		<li><a href="_sources/changelog.txt"
		rel="nofollow">Show Source</a></li>
		</ul>
		<div id="searchbox" style="display: none">
		<h3>Quick search</h3>
		<form class="search" action="search.html" method="get">
		<input type="text" name="q" />
		<input type="submit" value="Go" />
		<input type="hidden" name="check_keywords" value="yes" />
		<input type="hidden" name="area" value="default" />
		</form>
		<p class="searchtip" style="font-size: 90%">
		Enter search terms or a module, class or function name.
		</p>
		</div>
		<script type="text/javascript">$('#searchbox').show(0);</script>
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		>index</a></li>
		<li class="right" >
		<a href="api.html" title="Python API"
		>previous</a> \|</li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

+306

docs/_build/html/genindex.html


		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>Index — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="_static/default.css" type="text/css" />
		<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: './',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="_static/jquery.js"></script>
		<script type="text/javascript" src="_static/underscore.js"></script>
		<script type="text/javascript" src="_static/doctools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="index.html" />
		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="#" title="General Index"
		accesskey="I">index</a></li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">


		<h1 id="index">Index</h1>

		<div class="genindex-jumpbox">
		<a href="#_"><strong>_</strong></a>
		\| <a href="#C"><strong>C</strong></a>
		\| <a href="#E"><strong>E</strong></a>
		\| <a href="#F"><strong>F</strong></a>
		\| <a href="#G"><strong>G</strong></a>
		\| <a href="#H"><strong>H</strong></a>
		\| <a href="#I"><strong>I</strong></a>
		\| <a href="#K"><strong>K</strong></a>
		\| <a href="#P"><strong>P</strong></a>
		\| <a href="#S"><strong>S</strong></a>
		\| <a href="#U"><strong>U</strong></a>
		\| <a href="#V"><strong>V</strong></a>

		</div>
		<h2 id="_">_</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.__cmp__">__cmp__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__contains__">__contains__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__delitem__">__delitem__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__enter__">__enter__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__exit__">__exit__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__getitem__">__getitem__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__hash__">__hash__ (envdir.Env attribute)</a>
		</dt>

		</dl></td>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.__init__">__init__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__iter__">__iter__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__len__">__len__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__module__">__module__ (envdir.Env attribute)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__repr__">__repr__() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.__setitem__">__setitem__() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="C">C</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.clear">clear() (envdir.Env method)</a>
		</dt>

		</dl></td>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.copy">copy() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="E">E</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env">Env (class in envdir)</a>
		</dt>

		</dl></td>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.open">envdir.open() (built-in function)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="F">F</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.fromkeys">fromkeys() (envdir.Env class method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="G">G</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.get">get() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="H">H</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.has_key">has_key() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="I">I</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.items">items() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.iteritems">iteritems() (envdir.Env method)</a>
		</dt>

		</dl></td>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.iterkeys">iterkeys() (envdir.Env method)</a>
		</dt>


		<dt><a href="api.html#envdir.Env.itervalues">itervalues() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="K">K</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.keys">keys() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="P">P</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.pop">pop() (envdir.Env method)</a>
		</dt>

		</dl></td>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.popitem">popitem() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="S">S</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.setdefault">setdefault() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="U">U</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.update">update() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>

		<h2 id="V">V</h2>
		<table style="width: 100%" class="indextable genindextable"><tr>
		<td style="width: 33%" valign="top"><dl>

		<dt><a href="api.html#envdir.Env.values">values() (envdir.Env method)</a>
		</dt>

		</dl></td>
		</tr></table>



		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">



		<div id="searchbox" style="display: none">
		<h3>Quick search</h3>
		<form class="search" action="search.html" method="get">
		<input type="text" name="q" />
		<input type="submit" value="Go" />
		<input type="hidden" name="check_keywords" value="yes" />
		<input type="hidden" name="area" value="default" />
		</form>
		<p class="searchtip" style="font-size: 90%">
		Enter search terms or a module, class or function name.
		</p>
		</div>
		<script type="text/javascript">$('#searchbox').show(0);</script>
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="#" title="General Index"
		>index</a></li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

+188

docs/_build/html/index.html

		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>envdir (Python port) — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="_static/default.css" type="text/css" />
		<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: './',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="_static/jquery.js"></script>
		<script type="text/javascript" src="_static/underscore.js"></script>
		<script type="text/javascript" src="_static/doctools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="#" />
		<link rel="next" title="Installation" href="installation.html" />
		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		accesskey="I">index</a></li>
		<li class="right" >
		<a href="installation.html" title="Installation"
		accesskey="N">next</a> \|</li>
		<li><a href="#">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">

		<div class="section" id="envdir-python-port">
		<h1>envdir (Python port)<a class="headerlink" href="#envdir-python-port" title="Permalink to this headline">¶</a></h1>
		<a class="reference external image-reference" href="https://travis-ci.org/jezdez/envdir"><img alt="Build Status" src="https://api.travis-ci.org/jezdez/envdir.png" /></a>
		<p>This is a Python port of <a class="reference external" href="http://cr.yp.to/daemontools.html">daemontools</a>‘ tool <a class="reference external" href="http://cr.yp.to/daemontools/envdir.html">envdir</a>. It works on Windows and
		other systems which can run Python. It’s well tested and doesn’t need a
		compiler to be installed.</p>
		<p>envdir runs another program with a modified environment according to files
		in a specified directory.</p>
		<p>So for example, imagine a software you want to run on a server but don’t
		want to leave certain configuration variables embedded in the program’s source
		code. A common pattern to solve this problem is to use environment variables
		to separate configuration from code.</p>
		<p>envdir allows you to set a series of environment variables at once to simplify
		maintaining complicated environments, for example in which you have multiple sets
		of those configuration variables depending on the infrastructure you run your
		program on (e.g. Windows vs. Linux, Staging vs. Production, Old system vs.
		New system etc).</p>
		<p>Let’s have a look at a typical envdir:</p>
		<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> tree envs/prod/
		<span class="go">envs/prod/</span>
		<span class="go">├── DJANGO_SETTINGS_MODULE</span>
		<span class="go">├── MYSITE_DEBUG</span>
		<span class="go">├── MYSITE_DEPLOY_DIR</span>
		<span class="go">├── MYSITE_SECRET_KEY</span>
		<span class="go">└── PYTHONSTARTUP</span>

		<span class="go">0 directories, 3 files</span>
		<span class="gp">$</span> cat envs/prod/DJANGO_SETTINGS_MODULE
		<span class="go">mysite.settings</span>
		<span class="gp">$</span>
		</pre></div>
		</div>
		<p>As you can see each file has a capitalized name and contains the value of the
		environment variable to set when running your program. To use it, simply
		prefix the call to your program with envdir:</p>
		<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> envdir envs/prod/ python manage.py runserver
		</pre></div>
		</div>
		<p>That’s it, nothing more and nothing less. The way you structure your envdir
		is left to you but can easily match your configuration requirements and
		integrate with other configuration systems. envdirs contain just files after
		all.</p>
		<p>An interesting summary about why it’s good to store configuration values in
		environment variables can be found on the <a class="reference external" href="http://12factor.net/config">12factor</a> site.</p>
		<div class="admonition note">
		<p class="first admonition-title">Note</p>
		<p class="last">This Python port behaves different for multi line environment variables.
		It will not only read the first line of the file but the whole file. Take
		care with big files!</p>
		</div>
		<div class="admonition tip">
		<p class="first admonition-title">Tip</p>
		<p class="last">Feel free to open tickets at <a class="reference external" href="https://github.com/jezdez/envdir/issues">https://github.com/jezdez/envdir/issues</a>.
		Say thanks at <a class="reference external" href="https://www.gittip.com/jezdez/">https://www.gittip.com/jezdez/</a>.</p>
		</div>
		<div class="section" id="more-documentation">
		<h2>More documentation<a class="headerlink" href="#more-documentation" title="Permalink to this headline">¶</a></h2>
		<div class="toctree-wrapper compound">
		<ul>
		<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
		<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
		<li class="toctree-l2"><a class="reference internal" href="usage.html#command-line">Command line</a></li>
		<li class="toctree-l2"><a class="reference internal" href="usage.html#isolated-shell">Isolated shell</a></li>
		</ul>
		</li>
		<li class="toctree-l1"><a class="reference internal" href="api.html">Python API</a></li>
		<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
		<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">0.6 (12/02/2013)</a></li>
		<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">0.5 (09/22/2013)</a></li>
		<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">0.4.1 (08/21/2013)</a></li>
		<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">0.4 (08/09/2013)</a></li>
		<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">0.3 (07/30/2013)</a></li>
		<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">0.2.1 (07/11/2013)</a></li>
		<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">0.2 (07/10/2013)</a></li>
		<li class="toctree-l2"><a class="reference internal" href="changelog.html#id8">0.1 (07/10/2013)</a></li>
		</ul>
		</li>
		</ul>
		</div>
		</div>
		</div>


		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">
		<h3><a href="#">Table Of Contents</a></h3>
		<ul>
		<li><a class="reference internal" href="#">envdir (Python port)</a><ul>
		<li><a class="reference internal" href="#more-documentation">More documentation</a><ul>
		</ul>
		</li>
		</ul>
		</li>
		</ul>

		<h4>Next topic</h4>
		<p class="topless"><a href="installation.html"
		title="next chapter">Installation</a></p>
		<h3>This Page</h3>
		<ul class="this-page-menu">
		<li><a href="_sources/index.txt"
		rel="nofollow">Show Source</a></li>
		</ul>
		<div id="searchbox" style="display: none">
		<h3>Quick search</h3>
		<form class="search" action="search.html" method="get">
		<input type="text" name="q" />
		<input type="submit" value="Go" />
		<input type="hidden" name="check_keywords" value="yes" />
		<input type="hidden" name="area" value="default" />
		</form>
		<p class="searchtip" style="font-size: 90%">
		Enter search terms or a module, class or function name.
		</p>
		</div>
		<script type="text/javascript">$('#searchbox').show(0);</script>
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		>index</a></li>
		<li class="right" >
		<a href="installation.html" title="Installation"
		>next</a> \|</li>
		<li><a href="#">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

+117

docs/_build/html/installation.html

		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>Installation — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="_static/default.css" type="text/css" />
		<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: './',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="_static/jquery.js"></script>
		<script type="text/javascript" src="_static/underscore.js"></script>
		<script type="text/javascript" src="_static/doctools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="index.html" />
		<link rel="next" title="Usage" href="usage.html" />
		<link rel="prev" title="envdir (Python port)" href="index.html" />
		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		accesskey="I">index</a></li>
		<li class="right" >
		<a href="usage.html" title="Usage"
		accesskey="N">next</a> \|</li>
		<li class="right" >
		<a href="index.html" title="envdir (Python port)"
		accesskey="P">previous</a> \|</li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">

		<div class="section" id="installation">
		<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
		<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> pip install envdir
		</pre></div>
		</div>
		<p>or:</p>
		<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> easy_install envdir
		</pre></div>
		</div>
		</div>


		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">
		<h4>Previous topic</h4>
		<p class="topless"><a href="index.html"
		title="previous chapter">envdir (Python port)</a></p>
		<h4>Next topic</h4>
		<p class="topless"><a href="usage.html"
		title="next chapter">Usage</a></p>
		<h3>This Page</h3>
		<ul class="this-page-menu">
		<li><a href="_sources/installation.txt"
		rel="nofollow">Show Source</a></li>
		</ul>
		<div id="searchbox" style="display: none">
		<h3>Quick search</h3>
		<form class="search" action="search.html" method="get">
		<input type="text" name="q" />
		<input type="submit" value="Go" />
		<input type="hidden" name="check_keywords" value="yes" />
		<input type="hidden" name="area" value="default" />
		</form>
		<p class="searchtip" style="font-size: 90%">
		Enter search terms or a module, class or function name.
		</p>
		</div>
		<script type="text/javascript">$('#searchbox').show(0);</script>
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		>index</a></li>
		<li class="right" >
		<a href="usage.html" title="Usage"
		>next</a> \|</li>
		<li class="right" >
		<a href="index.html" title="envdir (Python port)"
		>previous</a> \|</li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

docs/_build/html/objects.inv

Sorry, the diff of this file is not supported yet

+99

docs/_build/html/search.html

		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>Search — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="_static/default.css" type="text/css" />
		<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: './',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="_static/jquery.js"></script>
		<script type="text/javascript" src="_static/underscore.js"></script>
		<script type="text/javascript" src="_static/doctools.js"></script>
		<script type="text/javascript" src="_static/searchtools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="index.html" />
		<script type="text/javascript">
		jQuery(function() { Search.loadIndex("searchindex.js"); });
		</script>

		<script type="text/javascript" id="searchindexloader"></script>


		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		accesskey="I">index</a></li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">

		<h1 id="search-documentation">Search</h1>
		<div id="fallback" class="admonition warning">
		<script type="text/javascript">$('#fallback').hide();</script>
		<p>
		Please activate JavaScript to enable the search
		functionality.
		</p>
		</div>
		<p>
		From here you can search these documents. Enter your search
		words into the box below and click "search". Note that the search
		function will automatically search for all of the words. Pages
		containing fewer words won't appear in the result list.
		</p>
		<form action="" method="get">
		<input type="text" name="q" value="" />
		<input type="submit" value="search" />
		<span id="search-progress" style="padding-left: 10px"></span>
		</form>

		<div id="search-results">

		</div>

		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		>index</a></li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

+1

docs/_build/html/searchindex.js

Search.setIndex({envversion:42,terms:{all:[1,2],code:[0,1],database_url:2,prefix:1,runserv:[0,1,4],abil:4,disk:2,whose:0,depend:1,rewrot:4,"__cmp__":2,program:[0,1],exit:[0,4],sourc:1,"__exit__":2,vastli:4,ticket:1,list:2,iter:2,"try":2,item:2,readthedoc:4,pass:2,compat:4,mysite_debug:1,current:[0,2],delet:2,"new":[0,1],method:2,full:2,iteritem:2,here:2,let:1,path:[2,4],modifi:[0,1,2],sinc:2,valu:[0,1,2],convert:4,mysit:[0,1,2,4],behav:1,chang:0,"__enter__":2,appli:2,modul:2,instal:[],from:[0,1,4],describ:4,memori:[0,2],next:2,call:[0,1,2,4],type:[0,2,4],more:2,capit:1,"__iter__":2,stick:0,must:0,none:2,work:[1,2,4],cat:1,can:[0,1,2],purpos:4,sqlite:2,want:[1,2],process:4,tab:0,cours:2,multipl:1,newlin:[0,4],anoth:[0,1],write:2,env:[0,1,2,4],simpl:0,updat:2,product:1,after:1,befor:2,end:0,github:1,classmethod:2,django:2,issu:1,maintain:1,environ:[0,1,2,4],allow:[0,1,4],failobj:2,keyboard:4,thank:[1,4],itervalu:2,fix:4,better:4,window:1,infrastructur:1,persist:2,them:2,good:1,"return":[0,2,4],"__getitem__":2,envshel:4,initi:4,interrupt:4,"__delitem__":2,name:[0,1,2],didn:2,separ:1,easili:1,each:1,found:1,compil:1,happen:0,out:0,variabl:[0,1,2,4],space:0,common:1,multilin:4,insid:2,advanc:2,differ:[1,2],free:1,standard:4,standalon:[],"__setitem__":2,base:4,releas:4,org:4,"byte":0,care:1,departur:4,setdefault:2,launch:[0,4],could:2,traceback:[2,4],outsid:[0,2],first:[0,1,4],origin:0,softwar:1,directli:2,subshel:[0,4],feel:1,onc:1,yourself:2,alreadi:4,done:[2,4],open:[1,2],given:[0,4],script:0,interact:2,system:1,horst:4,too:2,store:1,shell:[],option:0,pythonstartup:1,tool:[0,1],copi:2,specifi:[0,1],provid:4,remov:[0,2],tree:1,cli:0,structur:1,keyboardinterrupt:4,seri:1,sai:1,argument:0,packag:[],manner:2,have:1,need:1,"null":[0,4],imagin:1,jezdez:[0,1,2,4],also:[0,2],without:0,take:1,which:[0,1,4],noth:1,singl:0,simplifi:1,sure:4,object:2,why:1,don:1,doc:[2,4],clear:2,has_kei:2,show:4,session:0,find:2,access:2,onli:[1,4],explicitli:2,just:1,configur:1,should:2,dict:2,reset:2,variou:0,get:2,gittip:1,cannot:0,popitem:2,requir:1,integr:1,contain:[0,1],summari:1,"__module__":2,set:[0,1],see:[1,2],arg:2,kei:2,pattern:1,someth:2,discoveri:2,written:2,between:2,"import":2,altern:0,accord:[0,1],extend:4,isol:[],extens:2,solv:1,embed:1,addit:2,etc:1,instanc:2,context:2,com:1,simpli:[0,1,2],instanti:2,pop:2,linux:1,typic:1,mysite_deploy_dir:1,empti:0,interest:1,basic:0,"__len__":2,assert:2,child:[0,4],"catch":4,those:1,multi:1,look:1,defin:4,abov:2,error:4,"__hash__":2,"12factor":1,ctrl:[0,4],readm:4,site:1,kwarg:2,"__init__":2,thei:2,suggest:4,make:[0,4],same:0,pytest:4,complet:0,http:[1,4],mysite_secret_kei:1,implement:2,fromkei:2,whole:1,well:1,exampl:[0,1,2,4],command:4,thi:[1,2,4],left:1,execut:[],less:1,kill:4,had:2,except:4,add:[0,4],match:1,transpar:2,read:[0,1,4],big:1,press:0,like:2,server:1,lose:2,django_settings_modul:1,manag:[0,1,2,4],gutmann:4,www:1,old:1,captur:4,back:2,home:[0,2,4],"__contains__":2,leav:[0,1],prod:[0,1,2,4],complic:1,run:[0,1],usag:[],"throw":4,stage:1,about:1,actual:4,block:2,own:2,easy_instal:3,automat:2,repsons:4,your:[0,1,2],wai:1,daemontool:[1,4],"long":0,"class":2,avail:2,interfac:[0,2],includ:0,lot:0,"function":2,form:0,line:4,iterkei:2,consist:0,possibl:2,envdir:[2,4],troubl:0,below:2,otherwis:0,problem:1,"__repr__":2,featur:2,certain:1,doesn:[1,2],repres:2,exist:[0,2,4],file:[0,1,2,4],pip:3,check:4,again:2,when:[1,4],other:1,test:[1,4],you:[0,1,2],sphinx:4,directori:[0,1,2,4],time:2},objtypes:{"0":"py:method","1":"py:function","2":"py:classmethod","3":"py:class","4":"py:attribute"},objnames:{"0":["py","method","Python method"],"1":["py","function","Python function"],"2":["py","classmethod","Python class method"],"3":["py","class","Python class"],"4":["py","attribute","Python attribute"]},filenames:["usage","index","api","installation","changelog"],titles:["Usage","envdir (Python port)","Python API","Installation","Changelog"],objects:{envdir:{open:[2,1,1,""],Env:[2,3,1,""]},"envdir.Env":{"__module__":[2,4,1,""],iteritems:[2,0,1,""],pop:[2,0,1,""],has_key:[2,0,1,""],"__init__":[2,0,1,""],"__contains__":[2,0,1,""],"__enter__":[2,0,1,""],"__cmp__":[2,0,1,""],itervalues:[2,0,1,""],"__len__":[2,0,1,""],"__exit__":[2,0,1,""],"__getitem__":[2,0,1,""],get:[2,0,1,""],keys:[2,0,1,""],update:[2,0,1,""],"__iter__":[2,0,1,""],popitem:[2,0,1,""],copy:[2,0,1,""],iterkeys:[2,0,1,""],"__delitem__":[2,0,1,""],fromkeys:[2,2,1,""],setdefault:[2,0,1,""],items:[2,0,1,""],clear:[2,0,1,""],"__setitem__":[2,0,1,""],values:[2,0,1,""],"__repr__":[2,0,1,""],"__hash__":[2,4,1,""]}},titleterms:{shell:0,feedback:[],execut:[],changelog:4,python:[1,2],usag:0,isol:0,packag:[],api:2,command:0,envshel:[],document:1,instal:3,line:0,standalon:[],envdir:1,port:1,more:1}})

+160

docs/_build/html/usage.html

		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


		<html xmlns="http://www.w3.org/1999/xhtml">
		<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<title>Usage — envdir 0.6 documentation</title>

		<link rel="stylesheet" href="_static/default.css" type="text/css" />
		<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

		<script type="text/javascript">
		var DOCUMENTATION_OPTIONS = {
		URL_ROOT: './',
		VERSION: '0.6',
		COLLAPSE_INDEX: false,
		FILE_SUFFIX: '.html',
		HAS_SOURCE: true
		};
		</script>
		<script type="text/javascript" src="_static/jquery.js"></script>
		<script type="text/javascript" src="_static/underscore.js"></script>
		<script type="text/javascript" src="_static/doctools.js"></script>
		<link rel="top" title="envdir 0.6 documentation" href="index.html" />
		<link rel="next" title="Python API" href="api.html" />
		<link rel="prev" title="Installation" href="installation.html" />
		</head>
		<body>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		accesskey="I">index</a></li>
		<li class="right" >
		<a href="api.html" title="Python API"
		accesskey="N">next</a> \|</li>
		<li class="right" >
		<a href="installation.html" title="Installation"
		accesskey="P">previous</a> \|</li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>

		<div class="document">
		<div class="documentwrapper">
		<div class="bodywrapper">
		<div class="body">

		<div class="section" id="usage">
		<h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
		<div class="section" id="command-line">
		<h2>Command line<a class="headerlink" href="#command-line" title="Permalink to this headline">¶</a></h2>
		<p>From the original <a class="reference external" href="http://cr.yp.to/daemontools/envdir.html">envdir</a> documentation:</p>
		<blockquote>
		<div><p>envdir runs another program with environment modified according to files
		in a specified directory.</p>
		<p>Interface:</p>
		<div class="highlight-python"><pre>envdir d child</pre>
		</div>
		<p><tt class="docutils literal"><span class="pre">d</span></tt> is a single argument. <tt class="docutils literal"><span class="pre">child</span></tt> consists of one or more arguments.</p>
		<p>envdir sets various environment variables as specified by files in the
		directory named <tt class="docutils literal"><span class="pre">d</span></tt>. It then runs <tt class="docutils literal"><span class="pre">child</span></tt>.</p>
		<p>If <tt class="docutils literal"><span class="pre">d</span></tt> contains a file named <tt class="docutils literal"><span class="pre">s</span></tt> whose first line is <tt class="docutils literal"><span class="pre">t</span></tt>, envdir
		removes an environment variable named <tt class="docutils literal"><span class="pre">s</span></tt> if one exists, and then adds
		an environment variable named <tt class="docutils literal"><span class="pre">s</span></tt> with value <tt class="docutils literal"><span class="pre">t</span></tt>. The name <tt class="docutils literal"><span class="pre">s</span></tt> must
		not contain <tt class="docutils literal"><span class="pre">=</span></tt>. Spaces and tabs at the end of <tt class="docutils literal"><span class="pre">t</span></tt> are removed.
		Nulls in <tt class="docutils literal"><span class="pre">t</span></tt> are changed to newlines in the environment variable.</p>
		<p>If the file <tt class="docutils literal"><span class="pre">s</span></tt> is completely empty (0 bytes long), envdir removes an
		environment variable named <tt class="docutils literal"><span class="pre">s</span></tt> if one exists, without adding a new
		variable.</p>
		<p>envdir exits <tt class="docutils literal"><span class="pre">111</span></tt> if it has trouble reading <tt class="docutils literal"><span class="pre">d</span></tt>, 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.</p>
		</div></blockquote>
		<p>Alternatively you can also use the <tt class="docutils literal"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">envdir</span></tt> form to call envdir.</p>
		</div>
		<div class="section" id="isolated-shell">
		<h2>Isolated shell<a class="headerlink" href="#isolated-shell" title="Permalink to this headline">¶</a></h2>
		<p>envdir also includes an optional CLI tool called <tt class="docutils literal"><span class="pre">envshell</span></tt> 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.</p>
		<p>For example:</p>
		<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> envshell ~/mysite/envs/prod/
		<span class="go">Launching envshell for /home/jezdez/mysite/envs/prod. Type 'exit' or 'Ctrl+D' to return.</span>
		<span class="gp">$</span> python manage.py runserver
		<span class="go">..</span>
		</pre></div>
		</div>
		<p>To leave the subshell, simply use the <tt class="docutils literal"><span class="pre">exit</span></tt> command or press <tt class="docutils literal"><span class="pre">Ctrl+D</span></tt>.</p>
		</div>
		</div>


		</div>
		</div>
		</div>
		<div class="sphinxsidebar">
		<div class="sphinxsidebarwrapper">
		<h3><a href="index.html">Table Of Contents</a></h3>
		<ul>
		<li><a class="reference internal" href="#">Usage</a><ul>
		<li><a class="reference internal" href="#command-line">Command line</a></li>
		<li><a class="reference internal" href="#isolated-shell">Isolated shell</a></li>
		</ul>
		</li>
		</ul>

		<h4>Previous topic</h4>
		<p class="topless"><a href="installation.html"
		title="previous chapter">Installation</a></p>
		<h4>Next topic</h4>
		<p class="topless"><a href="api.html"
		title="next chapter">Python API</a></p>
		<h3>This Page</h3>
		<ul class="this-page-menu">
		<li><a href="_sources/usage.txt"
		rel="nofollow">Show Source</a></li>
		</ul>
		<div id="searchbox" style="display: none">
		<h3>Quick search</h3>
		<form class="search" action="search.html" method="get">
		<input type="text" name="q" />
		<input type="submit" value="Go" />
		<input type="hidden" name="check_keywords" value="yes" />
		<input type="hidden" name="area" value="default" />
		</form>
		<p class="searchtip" style="font-size: 90%">
		Enter search terms or a module, class or function name.
		</p>
		</div>
		<script type="text/javascript">$('#searchbox').show(0);</script>
		</div>
		</div>
		<div class="clearer"></div>
		</div>
		<div class="related">
		<h3>Navigation</h3>
		<ul>
		<li class="right" style="margin-right: 10px">
		<a href="genindex.html" title="General Index"
		>index</a></li>
		<li class="right" >
		<a href="api.html" title="Python API"
		>next</a> \|</li>
		<li class="right" >
		<a href="installation.html" title="Installation"
		>previous</a> \|</li>
		<li><a href="index.html">envdir 0.6 documentation</a> »</li>
		</ul>
		</div>
		<div class="footer">
		© Copyright 2013, Jannis Leidel and contributors.
		Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
		</div>
		</body>
		</html>

docs/.DS_Store

Sorry, the diff of this file is not supported yet

+101

docs/api.rst

		Python API
		==========

		.. function:: envdir.open([path])

		To use an envdir in a Python file (e.g. Django's ``manage.py``) simply call
		the ``open`` function of the envdir module:

		.. code-block:: python

		import envdir
		envdir.open()

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

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

		.. code-block:: python

		import envdir

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

		Calling ``open`` will automatically apply all environment variables to the
		current instance of ``os.environ``.

		If you want to implement more advanced access to envdirs there is also an
		own dict-like :class:`~envdir.Env` object to work with. The above example
		could also be written like this:

		.. code-block:: python

		import envdir

		env = envdir.open('/home/jezdez/mysite/envs/prod')

		The returned :class:`~envdir.Env` instance has a dict-like interface but also
		features a :meth:`~envdir.Env.clear` method to reset the current instance of
		:data:`os.environ` to the value it had before the envdir was opened:

		.. code-block:: python

		import envdir

		env = envdir.open('/home/jezdez/mysite/envs/prod')

		# do something

		env.clear()

		Since calling the clear method should be done in a transparent manner
		you can also use it as a context manager:

		.. code-block:: python

		import envdir

		with envdir.open('/home/jezdez/mysite/envs/prod') as env:
		# do something

		Outside the context manager block the environ is reset back automatically.

		To access and write values you can also use the dict-like interface:

		.. code-block:: python

		import envdir

		with envdir.open() as env:
		env['DATABASE_URL'] = 'sqlite://:memory:'
		assert 'DATABASE_URL' in env
		assert env.items() == [('DATABASE_URL', 'sqlite://:memory:')]

		.. note::

		Additions to the envdir done inside the context manager block are
		persisted to disk and will be available the next time your open the
		envdir again.

		Of course you can also directly interact with :class:`~envdir.Env` instances,
		e.g.:

		.. code-block:: python

		import envdir

		with envdir.Env('/home/jezdez/mysite/envs/prod') as env:
		# do something here

		The difference between instantiating an :class:`~envdir.Env` yourself to
		using :func:`envdir.open` is that you'll lose the automatic discovery of
		the ``envdir`` directory.

		See the API docs below for a full list of methods available in the
		:class:`~envdir.Env` object.

		.. autoclass:: envdir.Env
		:members:
		:undoc-members:
		:special-members:
		:inherited-members:

+69

docs/changelog.rst

		Changelog
		---------

		0.6 (12/02/2013)
		^^^^^^^^^^^^^^^^

		* Rewrote tests with pytest.

		* Vastly extended Python API.

		* Added Sphinx based docs: http://envdir.readthedocs.org/

		* Fixed killing child process when capturing keyboard interrupt.

		* Added standalone script based on PEPs 441 and 397, compatible with
		Python Launcher for Windows. See the installation instructions for more
		info.

		0.5 (09/22/2013)
		^^^^^^^^^^^^^^^^

		* Added check if the the provided path is a directory and throw an error if
		not. This adds compatibility to the daemontools' envdir.

		* Make sure to convert Nulls (``\0``) to newlines as done so in daemontools'
		envdir.

		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.

+314

docs/conf.py

		# -- coding: utf-8 --
		#
		# envdir documentation build configuration file, created by
		# sphinx-quickstart on Mon Nov 11 13:23:54 2013.
		#
		# This file is execfile()d with the current directory set to its containing dir.
		#
		# Note that not all possible configuration values are present in this
		# autogenerated file.
		#
		# All configuration values have a default; values that are commented out
		# serve to show the default.

		import sys, os

		# If extensions (or modules to document with autodoc) are in another directory,
		# add these directories to sys.path here. If the directory is relative to the
		# documentation root, use os.path.abspath to make it absolute, like shown here.
		sys.path.insert(0, os.path.abspath('..'))

		# -- General configuration -----------------------------------------------------

		# If your documentation needs a minimal Sphinx version, state it here.
		#needs_sphinx = '1.0'

		# Add any Sphinx extension module names here, as strings. They can be extensions
		# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
		extensions = [
		'sphinx.ext.autodoc',
		'sphinx.ext.intersphinx',
		'sphinx.ext.viewcode',
		]

		# Add any paths that contain templates here, relative to this directory.
		templates_path = ['_templates']

		# The suffix of source filenames.
		source_suffix = '.rst'

		# The encoding of source files.
		#source_encoding = 'utf-8-sig'

		# The master toctree document.
		master_doc = 'index'

		# General information about the project.
		project = u'envdir'
		copyright = u'2013, Jannis Leidel and contributors'

		# The version info for the project you're documenting, acts as replacement for
		# \|version\| and \|release\|, also used in various other places throughout the
		# built documents.
		#
		# The short X.Y version.
		version = '0.6'
		# The full version, including alpha/beta/rc tags.
		release = '0.6'

		# The language for content autogenerated by Sphinx. Refer to documentation
		# for a list of supported languages.
		#language = None

		# There are two options for replacing \|today\|: either, you set today to some
		# non-false value, then it is used:
		#today = ''
		# Else, today_fmt is used as the format for a strftime call.
		#today_fmt = '%B %d, %Y'

		# List of patterns, relative to source directory, that match files and
		# directories to ignore when looking for source files.
		exclude_patterns = ['_build']

		# The reST default role (used for this markup: `text`) to use for all documents.
		#default_role = None

		# If true, '()' will be appended to :func: etc. cross-reference text.
		#add_function_parentheses = True

		# If true, the current module name will be prepended to all description
		# unit titles (such as .. function::).
		#add_module_names = True

		# If true, sectionauthor and moduleauthor directives will be shown in the
		# output. They are ignored by default.
		#show_authors = False

		# The name of the Pygments (syntax highlighting) style to use.
		pygments_style = 'sphinx'

		# A list of ignored prefixes for module index sorting.
		#modindex_common_prefix = []

		# If true, keep warnings as "system message" paragraphs in the built documents.
		#keep_warnings = False


		# -- Options for HTML output ---------------------------------------------------

		# The theme to use for HTML and HTML Help pages. See the documentation for
		# a list of builtin themes.
		html_theme = 'default'

		# Theme options are theme-specific and customize the look and feel of a theme
		# further. For a list of options available for each theme, see the
		# documentation.
		#html_theme_options = {}

		# Add any paths that contain custom themes here, relative to this directory.
		#html_theme_path = []

		# The name for this set of Sphinx documents. If None, it defaults to
		# "<project> v<release> documentation".
		#html_title = None

		# A shorter title for the navigation bar. Default is the same as html_title.
		#html_short_title = None

		# The name of an image file (relative to this directory) to place at the top
		# of the sidebar.
		#html_logo = None

		# The name of an image file (within the static path) to use as favicon of the
		# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
		# pixels large.
		#html_favicon = None

		# Add any paths that contain custom static files (such as style sheets) here,
		# relative to this directory. They are copied after the builtin static files,
		# so a file named "default.css" will overwrite the builtin "default.css".
		html_static_path = ['_static']

		# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
		# using the given strftime format.
		#html_last_updated_fmt = '%b %d, %Y'

		# If true, SmartyPants will be used to convert quotes and dashes to
		# typographically correct entities.
		#html_use_smartypants = True

		# Custom sidebar templates, maps document names to template names.
		#html_sidebars = {}

		# Additional templates that should be rendered to pages, maps page names to
		# template names.
		#html_additional_pages = {}

		# If false, no module index is generated.
		#html_domain_indices = True

		# If false, no index is generated.
		#html_use_index = True

		# If true, the index is split into individual pages for each letter.
		#html_split_index = False

		# If true, links to the reST sources are added to the pages.
		#html_show_sourcelink = True

		# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
		#html_show_sphinx = True

		# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
		#html_show_copyright = True

		# If true, an OpenSearch description file will be output, and all pages will
		# contain a <link> tag referring to it. The value of this option must be the
		# base URL from which the finished HTML is served.
		#html_use_opensearch = ''

		# This is the file name suffix for HTML files (e.g. ".xhtml").
		#html_file_suffix = None

		# Output file base name for HTML help builder.
		htmlhelp_basename = 'envdirdoc'


		# -- Options for LaTeX output --------------------------------------------------

		latex_elements = {
		# The paper size ('letterpaper' or 'a4paper').
		#'papersize': 'letterpaper',

		# The font size ('10pt', '11pt' or '12pt').
		#'pointsize': '10pt',

		# Additional stuff for the LaTeX preamble.
		#'preamble': '',
		}

		# Grouping the document tree into LaTeX files. List of tuples
		# (source start file, target name, title, author, documentclass [howto/manual]).
		latex_documents = [
		('index', 'envdir.tex', u'envdir Documentation',
		u'Jannis Leidel and contributors', 'manual'),
		]

		# The name of an image file (relative to this directory) to place at the top of
		# the title page.
		#latex_logo = None

		# For "manual" documents, if this is true, then toplevel headings are parts,
		# not chapters.
		#latex_use_parts = False

		# If true, show page references after internal links.
		#latex_show_pagerefs = False

		# If true, show URL addresses after external links.
		#latex_show_urls = False

		# Documents to append as an appendix to all manuals.
		#latex_appendices = []

		# If false, no module index is generated.
		#latex_domain_indices = True


		# -- Options for manual page output --------------------------------------------

		# One entry per manual page. List of tuples
		# (source start file, name, description, authors, manual section).
		man_pages = [
		('index', 'envdir', u'envdir Documentation',
		[u'Jannis Leidel and contributors'], 1)
		]

		# If true, show URL addresses after external links.
		#man_show_urls = False


		# -- Options for Texinfo output ------------------------------------------------

		# Grouping the document tree into Texinfo files. List of tuples
		# (source start file, target name, title, author,
		# dir menu entry, description, category)
		texinfo_documents = [
		('index', 'envdir', u'envdir Documentation',
		u'Jannis Leidel and contributors', 'envdir', 'One line description of project.',
		'Miscellaneous'),
		]

		# Documents to append as an appendix to all manuals.
		#texinfo_appendices = []

		# If false, no module index is generated.
		#texinfo_domain_indices = True

		# How to display URL addresses: 'footnote', 'no', or 'inline'.
		#texinfo_show_urls = 'footnote'

		# If true, do not generate a @detailmenu in the "Top" node's menu.
		#texinfo_no_detailmenu = False


		# -- Options for Epub output ---------------------------------------------------

		# Bibliographic Dublin Core info.
		epub_title = u'envdir'
		epub_author = u'Jannis Leidel and contributors'
		epub_publisher = u'Jannis Leidel and contributors'
		epub_copyright = u'2013, Jannis Leidel and contributors'

		# The language of the text. It defaults to the language option
		# or en if the language is not set.
		#epub_language = ''

		# The scheme of the identifier. Typical schemes are ISBN or URL.
		#epub_scheme = ''

		# The unique identifier of the text. This can be a ISBN number
		# or the project homepage.
		#epub_identifier = ''

		# A unique identification for the text.
		#epub_uid = ''

		# A tuple containing the cover image and cover page html template filenames.
		#epub_cover = ()

		# A sequence of (type, uri, title) tuples for the guide element of content.opf.
		#epub_guide = ()

		# HTML files that should be inserted before the pages created by sphinx.
		# The format is a list of tuples containing the path and title.
		#epub_pre_files = []

		# HTML files shat should be inserted after the pages created by sphinx.
		# The format is a list of tuples containing the path and title.
		#epub_post_files = []

		# A list of files that should not be packed into the epub file.
		#epub_exclude_files = []

		# The depth of the table of contents in toc.ncx.
		#epub_tocdepth = 3

		# Allow duplicate toc entries.
		#epub_tocdup = True

		# Fix unsupported image types using the PIL.
		#epub_fix_images = False

		# Scale large images.
		#epub_max_image_width = 0

		# If 'no', URL addresses will not be shown.
		#epub_show_urls = 'inline'

		# If false, no index is generated.
		#epub_use_index = True


		# Example configuration for intersphinx: refer to the Python standard library.
		intersphinx_mapping = {'http://docs.python.org/': None}

+12

docs/index.rst

		.. include:: ../README.rst

		More documentation
		------------------

		.. toctree::
		:maxdepth: 3

		installation
		usage
		api
		changelog

+70

docs/installation.rst

		Installation
		============

		As Python package
		-----------------

		.. highlight:: console

		::

		$ pip install envdir

		or:

		::

		$ easy_install envdir

		As standalone script
		--------------------

		Alternatively you can also download a standalone executable that follows
		Python's `PEP 441`_ and works with the Python Launcher for Windows (`PEP 397`_).
		Simply install the launcher from its site_ (downloads_) and you're ready to
		follow the rest of the instructions below.

		Windows
		^^^^^^^

		.. note::

		The Python Launcher for Windows also provides other useful features like
		being able to correctly launch Python when double clicking a file with
		the .py file extension, a ``py`` command line tool to easily launch the
		interactive Python shell when you're working on the command line. See
		the `Python Launcher for Windows documentation`_ for more infos.

		Next step is downloading the actual standalone script. On Windows this entails
		using your web browser to download the following URL:

		https://github.com/jezdez/envdir/releases/download/0.6/envdir-0.6.pyz

		Or simply run this on the command line to trigger the download with your
		default web browser::

		C:\Windows\Explorer.exe https://github.com/jezdez/envdir/releases/download/0.6/envdir-0.6.pyz

		Then -- from the location you downloaded the file to -- run the envdir script
		like you would any other script::

		C:\Users\jezdez\Desktop>.\envdir-0.6.pyz ..

		Linux, Mac OS, others
		^^^^^^^^^^^^^^^^^^^^^

		On Linux, Mac OS and other platforms with a shell like bash simply download
		the standalone file from PyPI::

		$ curl -O https://github.com/jezdez/envdir/releases/download/0.6/envdir-0.6.pyz

		and then run the file like you would do when running the script installed by
		the envdir package (see above)::

		$ ./envdir-0.6.pyz ..

		.. _`PEP 441`: http://www.python.org/dev/peps/pep-0441/
		.. _`PEP 397`: http://www.python.org/dev/peps/pep-0397/
		.. _site: https://bitbucket.org/pypa/pylauncher/
		.. _downloads: https://bitbucket.org/pypa/pylauncher/downloads
		.. _`Python Launcher for Windows documentation`: https://bitbucket.org/pypa/pylauncher/src/tip/Doc/launcher.rst

+242

docs/make.bat

		@ECHO OFF

		REM Command file for Sphinx documentation

		if "%SPHINXBUILD%" == "" (
		set SPHINXBUILD=sphinx-build
		)
		set BUILDDIR=_build
		set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
		set I18NSPHINXOPTS=%SPHINXOPTS% .
		if NOT "%PAPER%" == "" (
		set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
		set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
		)

		if "%1" == "" goto help

		if "%1" == "help" (
		:help
		echo.Please use `make ^<target^>` where ^<target^> is one of
		echo. html to make standalone HTML files
		echo. dirhtml to make HTML files named index.html in directories
		echo. singlehtml to make a single large HTML file
		echo. pickle to make pickle files
		echo. json to make JSON files
		echo. htmlhelp to make HTML files and a HTML help project
		echo. qthelp to make HTML files and a qthelp project
		echo. devhelp to make HTML files and a Devhelp project
		echo. epub to make an epub
		echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
		echo. text to make text files
		echo. man to make manual pages
		echo. texinfo to make Texinfo files
		echo. gettext to make PO message catalogs
		echo. changes to make an overview over all changed/added/deprecated items
		echo. xml to make Docutils-native XML files
		echo. pseudoxml to make pseudoxml-XML files for display purposes
		echo. linkcheck to check all external links for integrity
		echo. doctest to run all doctests embedded in the documentation if enabled
		goto end
		)

		if "%1" == "clean" (
		for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
		del /q /s %BUILDDIR%\*
		goto end
		)


		%SPHINXBUILD% 2> nul
		if errorlevel 9009 (
		echo.
		echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
		echo.installed, then set the SPHINXBUILD environment variable to point
		echo.to the full path of the 'sphinx-build' executable. Alternatively you
		echo.may add the Sphinx directory to PATH.
		echo.
		echo.If you don't have Sphinx installed, grab it from
		echo.http://sphinx-doc.org/
		exit /b 1
		)

		if "%1" == "html" (
		%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The HTML pages are in %BUILDDIR%/html.
		goto end
		)

		if "%1" == "dirhtml" (
		%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
		goto end
		)

		if "%1" == "singlehtml" (
		%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
		goto end
		)

		if "%1" == "pickle" (
		%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished; now you can process the pickle files.
		goto end
		)

		if "%1" == "json" (
		%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished; now you can process the JSON files.
		goto end
		)

		if "%1" == "htmlhelp" (
		%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished; now you can run HTML Help Workshop with the ^
		.hhp project file in %BUILDDIR%/htmlhelp.
		goto end
		)

		if "%1" == "qthelp" (
		%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished; now you can run "qcollectiongenerator" with the ^
		.qhcp project file in %BUILDDIR%/qthelp, like this:
		echo.^> qcollectiongenerator %BUILDDIR%\qthelp\envdir.qhcp
		echo.To view the help file:
		echo.^> assistant -collectionFile %BUILDDIR%\qthelp\envdir.ghc
		goto end
		)

		if "%1" == "devhelp" (
		%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished.
		goto end
		)

		if "%1" == "epub" (
		%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The epub file is in %BUILDDIR%/epub.
		goto end
		)

		if "%1" == "latex" (
		%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
		goto end
		)

		if "%1" == "latexpdf" (
		%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
		cd %BUILDDIR%/latex
		make all-pdf
		cd %BUILDDIR%/..
		echo.
		echo.Build finished; the PDF files are in %BUILDDIR%/latex.
		goto end
		)

		if "%1" == "latexpdfja" (
		%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
		cd %BUILDDIR%/latex
		make all-pdf-ja
		cd %BUILDDIR%/..
		echo.
		echo.Build finished; the PDF files are in %BUILDDIR%/latex.
		goto end
		)

		if "%1" == "text" (
		%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The text files are in %BUILDDIR%/text.
		goto end
		)

		if "%1" == "man" (
		%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The manual pages are in %BUILDDIR%/man.
		goto end
		)

		if "%1" == "texinfo" (
		%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
		goto end
		)

		if "%1" == "gettext" (
		%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
		goto end
		)

		if "%1" == "changes" (
		%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
		if errorlevel 1 exit /b 1
		echo.
		echo.The overview file is in %BUILDDIR%/changes.
		goto end
		)

		if "%1" == "linkcheck" (
		%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
		if errorlevel 1 exit /b 1
		echo.
		echo.Link check complete; look for any errors in the above output ^
		or in %BUILDDIR%/linkcheck/output.txt.
		goto end
		)

		if "%1" == "doctest" (
		%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
		if errorlevel 1 exit /b 1
		echo.
		echo.Testing of doctests in the sources finished, look at the ^
		results in %BUILDDIR%/doctest/output.txt.
		goto end
		)

		if "%1" == "xml" (
		%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The XML files are in %BUILDDIR%/xml.
		goto end
		)

		if "%1" == "pseudoxml" (
		%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
		if errorlevel 1 exit /b 1
		echo.
		echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
		goto end
		)

		:end

+177

docs/Makefile

		# Makefile for Sphinx documentation
		#

		# You can set these variables from the command line.
		SPHINXOPTS =
		SPHINXBUILD = sphinx-build
		PAPER =
		BUILDDIR = _build

		# User-friendly check for sphinx-build
		ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
		$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
		endif

		# Internal variables.
		PAPEROPT_a4 = -D latex_paper_size=a4
		PAPEROPT_letter = -D latex_paper_size=letter
		ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
		# the i18n builder cannot share the environment and doctrees with the others
		I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

		.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

		help:
		@echo "Please use \`make <target>' where <target> is one of"
		@echo " html to make standalone HTML files"
		@echo " dirhtml to make HTML files named index.html in directories"
		@echo " singlehtml to make a single large HTML file"
		@echo " pickle to make pickle files"
		@echo " json to make JSON files"
		@echo " htmlhelp to make HTML files and a HTML help project"
		@echo " qthelp to make HTML files and a qthelp project"
		@echo " devhelp to make HTML files and a Devhelp project"
		@echo " epub to make an epub"
		@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
		@echo " latexpdf to make LaTeX files and run them through pdflatex"
		@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
		@echo " text to make text files"
		@echo " man to make manual pages"
		@echo " texinfo to make Texinfo files"
		@echo " info to make Texinfo files and run them through makeinfo"
		@echo " gettext to make PO message catalogs"
		@echo " changes to make an overview of all changed/added/deprecated items"
		@echo " xml to make Docutils-native XML files"
		@echo " pseudoxml to make pseudoxml-XML files for display purposes"
		@echo " linkcheck to check all external links for integrity"
		@echo " doctest to run all doctests embedded in the documentation (if enabled)"

		clean:
		rm -rf $(BUILDDIR)/*

		html:
		$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
		@echo
		@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

		dirhtml:
		$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
		@echo
		@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

		singlehtml:
		$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
		@echo
		@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

		pickle:
		$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
		@echo
		@echo "Build finished; now you can process the pickle files."

		json:
		$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
		@echo
		@echo "Build finished; now you can process the JSON files."

		htmlhelp:
		$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
		@echo
		@echo "Build finished; now you can run HTML Help Workshop with the" \
		".hhp project file in $(BUILDDIR)/htmlhelp."

		qthelp:
		$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
		@echo
		@echo "Build finished; now you can run "qcollectiongenerator" with the" \
		".qhcp project file in $(BUILDDIR)/qthelp, like this:"
		@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/envdir.qhcp"
		@echo "To view the help file:"
		@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/envdir.qhc"

		devhelp:
		$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
		@echo
		@echo "Build finished."
		@echo "To view the help file:"
		@echo "# mkdir -p $$HOME/.local/share/devhelp/envdir"
		@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/envdir"
		@echo "# devhelp"

		epub:
		$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
		@echo
		@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

		latex:
		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
		@echo
		@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
		@echo "Run \`make' in that directory to run these through (pdf)latex" \
		"(use \`make latexpdf' here to do that automatically)."

		latexpdf:
		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
		@echo "Running LaTeX files through pdflatex..."
		$(MAKE) -C $(BUILDDIR)/latex all-pdf
		@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

		latexpdfja:
		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
		@echo "Running LaTeX files through platex and dvipdfmx..."
		$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
		@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

		text:
		$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
		@echo
		@echo "Build finished. The text files are in $(BUILDDIR)/text."

		man:
		$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
		@echo
		@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

		texinfo:
		$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
		@echo
		@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
		@echo "Run \`make' in that directory to run these through makeinfo" \
		"(use \`make info' here to do that automatically)."

		info:
		$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
		@echo "Running Texinfo files through makeinfo..."
		make -C $(BUILDDIR)/texinfo info
		@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

		gettext:
		$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
		@echo
		@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

		changes:
		$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
		@echo
		@echo "The overview file is in $(BUILDDIR)/changes."

		linkcheck:
		$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
		@echo
		@echo "Link check complete; look for any errors in the above output " \
		"or in $(BUILDDIR)/linkcheck/output.txt."

		doctest:
		$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
		@echo "Testing of doctests in the sources finished, look at the " \
		"results in $(BUILDDIR)/doctest/output.txt."

		xml:
		$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
		@echo
		@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

		pseudoxml:
		$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
		@echo
		@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

+56

docs/usage.rst

		Usage
		=====

		Command line
		------------

		From the original 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.

		Isolated 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:

		.. code-block:: console

		$ 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``.

		.. _envdir: http://cr.yp.to/daemontools/envdir.html

+99

envdir/env.py

		import glob
		import os

		try:
		from UserDict import IterableUserDict as UserDict
		except ImportError:
		from collections import UserDict


		def isenvvar(name):
		root, name = os.path.split(name)
		return (name == name.upper() and
		not name.startswith('_') and
		not '=' in name)


		class Env(UserDict):
		"""
		An dict-like object to represent an envdir environment with extensive
		API, can be used as context manager, too.
		"""
		def __init__(self, path):
		self.path = path
		self.data = {}
		self.originals = {}
		self.created = {}
		self._load()

		def __repr__(self):
		return "<envdir.Env '%s'>" % self.path

		def __enter__(self):
		return self

		def __exit__(self, type, value, traceback):
		self.clear()

		def __getitem__(self, name):
		return self._get(name)

		def __setitem__(self, name, value):
		self._write(**{name: value})
		self._set(name, value)
		self.created[name] = value

		def __delitem__(self, name):
		os.remove(os.path.join(self.path, name))
		self._delete(name)

		def __contains__(self, name):
		return (name in self.data or
		os.path.exists(os.path.join(self.path, name)))

		def _load(self):
		for path in filter(isenvvar, glob.glob(os.path.join(self.path, '*'))):
		root, name = os.path.split(path)
		value = self._get(name)
		self._set(name, value)

		def _open(self, name, mode='r'):
		return open(os.path.join(self.path, name), mode)

		def _get(self, name, default=None):
		path = os.path.join(self.path, name)
		if not os.path.exists(path):
		return default
		with self._open(name) as var:
		return var.read().strip().replace('\x00', '\n')

		def _set(self, name, value):
		if name in os.environ:
		self.originals[name] = os.environ[name]
		self.data[name] = value
		if value:
		os.environ[name] = value
		elif name in os.environ:
		del os.environ[name]

		def _delete(self, name):
		if name in self.originals:
		os.environ[name] = self.originals[name]
		elif name in os.environ:
		del os.environ[name]
		if name in self.data:
		del self.data[name]

		def _write(self, **values):
		for name, value in values.items():
		with self._open(name, 'w') as env:
		env.write(value)

		def clear(self):
		"""
		Clears the envdir by resetting the os.environ items to the
		values it had before opening this envdir (or removing them
		if they didn't exist). Doesn't delete the envdir files.
		"""
		for name in list(self.data.keys()):
		self._delete(name)

+122

envdir/runner.py

		import optparse
		import os
		import subprocess
		import sys

		from .env import Env
		from .version import __version__

		# must have shell = True on Windows
		shellout = sys.platform == 'win32'


		class Response(Exception):
		def __init__(self, message='', status=0):
		self.message = message
		self.status = status


		class Runner(object):
		envdir_usage = "usage: %prog [--help] [--version] dir child"
		envshell_usage = "usage: %prog [--help] [--version] dir"

		def __init__(self):
		self.parser = optparse.OptionParser(version=__version__)
		self.parser.disable_interspersed_args()
		self.parser.prog = 'envdir'

		def path(self, path):
		real_path = os.path.realpath(os.path.expanduser(path))
		if not os.path.exists(real_path):
		# use 111 error code to adher to envdir's standard
		raise Response("envdir %r does not exist" % path, 111)
		if not os.path.isdir(real_path):
		# use 111 error code to adher to envdir's standard
		raise Response("envdir %r not a directory" % path, 111)
		return real_path

		def open(self, path=None, stacklevel=1):
		if path is None:
		frame = sys._getframe()
		get_parent = lambda frame: frame.f_back
		for _ in range(stacklevel):
		frame = get_parent(frame)
		if frame is not None:
		callerdir = os.path.dirname(frame.f_code.co_filename)
		path = os.path.join(callerdir, 'envdir')
		else:
		# last holdout, assume cwd
		path = 'envdir'
		return Env(self.path(path))

		def shell(self, name, *args):
		self.parser.set_usage(self.envshell_usage)
		self.parser.prog = 'envshell'
		options, args = self.parser.parse_args(list(args))

		if len(args) == 0:
		raise Response("%s\nError: incorrect number of arguments" %
		(self.parser.get_usage()), 2)

		sys.stdout.write("Launching envshell for %s. "
		"Type 'exit' or 'Ctrl+D' to return.\n" %
		self.path(args[0]))
		sys.stdout.flush()
		self.open(args[0], 2)

		shell = os.environ['SHELL']
		try:
		subprocess.check_call([shell],
		universal_newlines=True,
		shell=shellout,
		bufsize=0,
		close_fds=True)
		except OSError as err:
		if err.errno == 2:
		raise Response("Unable to find shell %s" % shell, err.errno)
		else:
		raise Response("An error occurred: %s" % err,
		status=err.errno)

		raise Response()

		def run(self, name, *args):
		self.parser.set_usage(self.envdir_usage)
		self.parser.prog = 'envdir'
		options, args = self.parser.parse_args(list(args))

		if len(args) < 2:
		raise Response("%s\nError: incorrect number of arguments\n" %
		(self.parser.get_usage()), 2)

		self.open(args[0], 2)

		# the args to call later
		args = args[1:]

		# in case someone passes in -- for any reason to separate the commands
		if args[0] == '--':
		args = args[1:]

		try:
		process = subprocess.Popen(args,
		universal_newlines=True,
		shell=shellout,
		bufsize=0,
		close_fds=True)
		process.wait()
		except OSError as err:
		if err.errno == 2:
		raise Response("Unable to find command %s" %
		args[0], err.errno)
		else:
		raise Response(status=err.errno)
		except KeyboardInterrupt:
		# first send mellow signal
		process.terminate()
		process.poll()
		if process.returncode is None:
		# still running, kill it
		process.kill()

		raise Response(status=process.returncode)

+307

envdir/test_envdir.py

		import os
		import subprocess
		import py
		import pytest

		import envdir
		from envdir.runner import Response
		from envdir.__main__ import go


		@pytest.fixture(scope="module")
		def run():
		from envdir.runner import Runner
		runner = Runner()
		return runner.run


		@pytest.fixture(scope="module")
		def shell():
		from envdir.runner import Runner
		runner = Runner()
		return runner.shell


		@pytest.fixture
		def tmpenvdir(tmpdir):
		return tmpdir.mkdir('testenvdir')


		def test_usage(run):
		"Testing the usage"
		with py.test.raises(Response) as response:
		run('envdir')
		assert "incorrect number of arguments" in response.value.message
		assert response.value.status == 2


		def test_default(run, tmpenvdir):
		"Default cases."
		tmpenvdir.join('DEFAULT').write('test')
		with py.test.raises(Response) as response:
		run('envdir', str(tmpenvdir), 'ls')
		assert "DEFAULT" in os.environ
		assert response.value.status == 0
		assert response.value.message == ''

		tmpenvdir.join('DEFAULT_DASHDASH').write('test')
		with py.test.raises(Response) as response:
		run('envdir', str(tmpenvdir), '--', 'ls')
		assert "DEFAULT_DASHDASH" in os.environ

		# Overriding an env var inline
		os.environ['DEFAULT_OVERRIDE'] = 'test2'
		with py.test.raises(Response) as response:
		run('envdir', str(tmpenvdir), 'ls')
		assert "DEFAULT" in os.environ
		assert "DEFAULT_OVERRIDE" in os.environ
		assert response.value.status == 0
		assert response.value.message == ''


		def test_reset(run, tmpenvdir):
		"Resetting an env var with an empty file"
		tmpenvdir.join('RESET').write('')
		os.environ['RESET'] = 'test3'
		with py.test.raises(Response):
		run('envdir', str(tmpenvdir), 'ls')
		assert os.environ['DEFAULT'] == 'test'
		with py.test.raises(KeyError):
		assert os.environ['RESET'] == 'test3'


		def test_multiline(run, tmpenvdir):
		"Multiline envdir file"
		tmpenvdir.join('MULTI_LINE').write("""multi
		line
		""")
		with py.test.raises(Response):
		run('envdir', str(tmpenvdir), 'ls')
		assert os.environ['MULTI_LINE'] == 'multi\nline'


		def test_translate_nulls(run, tmpenvdir):
		"NULLs are translated into newline"
		tmpenvdir.join('NULL_CHARS').write("""null\x00character""")
		with py.test.raises(Response):
		run('envdir', str(tmpenvdir), 'ls')
		assert os.environ['NULL_CHARS'] == 'null\ncharacter'


		def test_incorrect_no_args(run, tmpenvdir):
		"Incorrect number of arguments"
		with py.test.raises(Response) as response:
		run('envdir', str(tmpenvdir))
		assert 'incorrect number of arguments' in response.value.message
		assert 2 == response.value.status


		def test_doesnt_exist(run, tmpdir):
		with py.test.raises(Response) as response:
		run('envdir', str(tmpdir.join('missing')), 'ls')
		assert 'does not exist' in response.value.message
		assert 111 == response.value.status

		with py.test.raises(Response) as response:
		run('envdir', str(tmpdir), 'doesnt-exist')
		assert 'Unable to find command' in response.value.message
		assert 2 == response.value.status


		def test_must_be_directory(run, tmpdir):
		"The envdir must be a directory"
		tmpdir.join('not-a-directory').write('')
		with py.test.raises(Response) as response:
		run('envdir', str(tmpdir.join('not-a-directory')), 'ls')
		assert 'not a directory' in response.value.message
		assert 111 == response.value.status


		def test_error_code(run, tmpenvdir):
		with py.test.raises(Response) as response:
		run('envdir', str(tmpenvdir),
		'python', '-c', 'import sys; sys.exit(19)')
		assert response.value.status == 19


		def test_equal_sign(run, tmpenvdir):
		tmpenvdir.join('EQUAL_SIGN=').write('test')
		with py.test.raises(Response):
		run('envdir', str(tmpenvdir), 'printenv')
		assert 'EQUAL_SIGN' not in os.environ


		timeout = py.path.local.sysfind('timeout') or py.path.local.sysfind('gtimeout')


		@py.test.mark.skipif(timeout is None,
		reason="(g)timeout command not found")
		def test_keyboard_interrupt(run, tmpenvdir):
		with py.test.raises(SystemExit) as exit:
		go(run, (str(timeout), '--signal=SIGTERM', '--', '1', 'envdir',
		str(tmpenvdir), 'ls'))
		if py.std.sys.version_info[:2] == (2, 6):
		assert exit.value == 2
		else:
		assert exit.value.code == 2


		def test_shell(shell, tmpenvdir, capfd):
		tmpenvdir.join('TEST_SHELL').write('test')
		with py.test.raises(Response) as response:
		shell('envshell', str(tmpenvdir))
		out, err = capfd.readouterr()
		assert response.value.status == 0
		assert "Launching envshell for " in out

		with py.test.raises(Response) as response:
		shell('envshell')
		assert "incorrect number of arguments" in response.value.message


		def test_shell_doesnt_exist(shell, tmpenvdir):
		tmpenvdir.join('NO_TEST_SHELL').write('test')
		os.environ['SHELL'] = '/does/not/exist'
		with py.test.raises(Response) as response:
		shell('envshell', str(tmpenvdir))
		assert "Unable to find shell" in response.value.message


		def test_read(tmpenvdir):
		tmpenvdir.join('READ').write('test')
		applied = envdir.read(str(tmpenvdir))
		assert 'READ' in os.environ
		assert 'READ' in applied


		def test_read_magic_dir(capfd, tmpdir):
		"Python usage with magic envdir"
		tmp = tmpdir.mkdir('envdir')
		tmp.join('READ_MAGIC').write('test')
		magic_scripts = tmpdir.join('test_magic.py')
		magic_scripts.write("""
		import envdir, os, sys
		envdir.read()
		if 'READ_MAGIC' in os.environ:
		sys.exit(42)
		""")
		status = subprocess.call(['python', str(magic_scripts)])
		assert status == 42

		# this should raise a Response with an error because envdir.run()
		# can't have all arguments
		with py.test.raises(SystemExit) as response:
		envdir.run('envdir', str(tmp))
		out, err = capfd.readouterr()

		if py.std.sys.version_info[:2] == (2, 6):
		assert response.value == 2
		else:
		assert response.value.code == 2
		assert "incorrect number of arguments" in err

		with py.test.raises(SystemExit) as response:
		envdir.run()
		out, err = capfd.readouterr()
		if py.std.sys.version_info[:2] == (2, 6):
		assert response.value == 2
		else:
		assert response.value.code == 2


		def test_read_existing_var(tmpenvdir):
		tmpenvdir.join('READ_EXISTING').write('override')
		os.environ['READ_EXISTING'] = 'test'
		envdir.read(str(tmpenvdir))
		assert os.environ['READ_EXISTING'] == 'override'


		def test_write(tmpenvdir):
		env = envdir.open(str(tmpenvdir))
		env['WRITE'] = 'test'
		assert tmpenvdir.ensure('WRITE')
		assert tmpenvdir.join('WRITE').read() == 'test'
		envdir.read(str(tmpenvdir))
		assert os.environ['WRITE'] == 'test'


		def test_write_magic(tmpdir):
		tmp = tmpdir.mkdir('envdir')
		magic_scripts = tmpdir.join('test_magic_write.py')
		magic_scripts.write("""
		import envdir, os, sys
		env = envdir.open()
		env['WRITE_MAGIC'] = 'test'
		""")
		subprocess.call(['python', str(magic_scripts)])
		assert tmp.join('WRITE_MAGIC').read() == 'test'
		envdir.read(str(tmp))
		assert os.environ['WRITE_MAGIC'] == 'test'


		def test_context_manager(tmpenvdir):
		tmpenvdir.join('CONTEXT_MANAGER').write('test')

		with envdir.open(str(tmpenvdir)) as env:
		assert 'CONTEXT_MANAGER' in os.environ
		assert 'CONTEXT_MANAGER' not in os.environ
		assert repr(env) == "<envdir.Env '%s'>" % tmpenvdir


		def test_dict_like(tmpenvdir):
		tmpenvdir.join('ITER').write('test')
		env = envdir.open(str(tmpenvdir))
		assert list(env) == ['ITER']
		assert hasattr(env, '__iter__')

		assert [k for k in env] == ['ITER']
		assert list(env.values()) == ['test']
		assert list(env.items()) == [('ITER', 'test')]
		assert 'ITER' in os.environ
		env.clear()
		assert list(env.items()) == []
		assert 'ITER' not in os.environ

		with envdir.open(str(tmpenvdir)) as env:
		assert list(env.items()) == [('ITER', 'test')]


		def test_context_manager_reset(tmpenvdir):
		tmpenvdir.join('CONTEXT_MANAGER_RESET').write('test')
		# make the var exist in the enviroment
		os.environ['CONTEXT_MANAGER_RESET'] = 'moot'
		with envdir.open(str(tmpenvdir)) as env:
		assert os.environ['CONTEXT_MANAGER_RESET'] == 'test'
		env.clear()
		# because we reset the original value
		assert os.environ['CONTEXT_MANAGER_RESET'] == 'moot'
		assert 'CONTEXT_MANAGER_RESET' in os.environ


		def test_context_manager_write(tmpenvdir):
		with envdir.open(str(tmpenvdir)) as env:
		assert 'CONTEXT_MANAGER_WRITE' not in os.environ
		env['CONTEXT_MANAGER_WRITE'] = 'test'
		assert 'CONTEXT_MANAGER_WRITE' in os.environ
		assert 'CONTEXT_MANAGER_WRITE' not in os.environ


		def test_context_manager_item(tmpenvdir):
		tmpenvdir.join('CONTEXT_MANAGER_ITEM').write('test')

		with envdir.open(str(tmpenvdir)) as env:
		assert 'CONTEXT_MANAGER_ITEM' in os.environ
		# the variable is in the env, but not in the env
		assert env['CONTEXT_MANAGER_ITEM'] == 'test'
		del env['CONTEXT_MANAGER_ITEM']
		assert 'CONTEXT_MANAGER_ITEM' not in os.environ
		assert 'CONTEXT_MANAGER_ITEM' not in env

		env['CONTEXT_MANAGER_ITEM_SET'] = 'test'
		assert 'CONTEXT_MANAGER_ITEM_SET' in os.environ
		assert tmpenvdir.join('CONTEXT_MANAGER_ITEM_SET').check()
		del env['CONTEXT_MANAGER_ITEM_SET']
		assert 'CONTEXT_MANAGER_ITEM_SET' not in os.environ
		assert not tmpenvdir.join('CONTEXT_MANAGER_ITEM_SET').check()
		assert tmpenvdir.ensure('CONTEXT_MANAGER_ITEM_SET')
		assert 'CONTEXT_MANAGER_ITEM_SET' not in os.environ

+1

envdir/version.py

__version__ = '0.6' # noqa

+1

-0

AUTHORS.rst

		@@ -7,1 +7,2 @@ Authors
		Jannis Leidel
		Kuba Janoszek

+2

-2

envdir.egg-info/entry_points.txt

		[console_scripts]
		envshell = envdir:main
		envdir = envdir:main
		envshell = envdir:shell
		envdir = envdir:run

+31

-103

envdir.egg-info/PKG-INFO

		Metadata-Version: 1.1
		Name: envdir
		Version: 0.5
		Version: 0.6
		Summary: A Python port of daemontools' envdir.
		Home-page: http://github.com/jezdez/envdir
		Home-page: http://envdir.readthedocs.org/
		Author: Jannis Leidel
		@@ -16,9 +16,6 @@ Author-email: jannis@leidel.info

		This is a Python port of daemontools_' tool `envdir <http://cr.yp.to/daemontools/envdir.html>`_.
		This is a Python port of daemontools_' tool envdir_. It works on Windows and
		other systems which can run Python. It's well tested and doesn't need a
		compiler to be installed.

		.. _daemontools: http://cr.yp.to/daemontools.html

		What?
		-----

		envdir runs another program with a modified environment according to files
		@@ -38,4 +35,6 @@ in a specified directory.

		Let's have a look at a typical envdir::
		Let's have a look at a typical envdir:

		.. code-block:: console

		$ tree envs/prod/
		@@ -56,4 +55,6 @@ envs/prod/
		environment variable to set when running your program. To use it, simply
		prefix the call to your program with envdir::
		prefix the call to your program with envdir:

		.. code-block:: console

		$ envdir envs/prod/ python manage.py runserver
		@@ -69,109 +70,36 @@

		.. _12factor: http://12factor.net/config

		Why?
		----

		Because envdir is small enough that it shouldn't be tied to a bigger
		software distribution like daemontools that requires a compiler.

		Also, this Python port can easily be used on Windows, not only UNIX systems.

		Installation
		------------

		::

		pip install envdir

		or::

		easy_install envdir

		Usage
		-----

		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.

		.. note::

		This Python port behaves different for multi line environment variables.
		It will not only read the first line of the file but the whole file. Take
		care with big files!
		This Python port behaves different for multi line environment variables.
		It will not only read the first line of the file but the whole file. Take
		care with big files!

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

		Python
		^^^^^^
		Feel free to open tickets at https://github.com/jezdez/envdir/issues.
		Say thanks at https://www.gittip.com/jezdez/.

		To use envdir in a Python file (e.g. Django's ``manage.py``) you can use::
		.. _12factor: http://12factor.net/config
		.. _daemontools: http://cr.yp.to/daemontools.html
		.. _envdir: http://cr.yp.to/daemontools/envdir.html

		import envdir
		envdir.read()

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

		It's also possible to explicitly pass the path to the envdir::
		0.6 (12/02/2013)
		^^^^^^^^^^^^^^^^

		import os
		import envdir
		* Rewrote tests with pytest.

		envdir.read('/home/jezdez/mysite/envs/prod')
		* Vastly extended Python API.

		Shell
		^^^^^
		* Added Sphinx based docs: http://envdir.readthedocs.org/

		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.
		* Fixed killing child process when capturing keyboard interrupt.

		For example::
		* Added standalone script based on PEPs 441 and 397, compatible with
		Python Launcher for Windows. See the installation instructions for more
		info.

		$ 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``.

		Feedback
		--------

		Feel free to open tickets at https://github.com/jezdez/envdir/issues.
		Say thanks at https://www.gittip.com/jezdez/.


		Changelog
		---------

		0.5 (09/22/2013)
		@@ -178,0 +106,0 @@ ^^^^^^^^^^^^^^^^

+57

-3

envdir.egg-info/SOURCES.txt

		AUTHORS.rst
		CHANGES.rst
		MANIFEST.in
		@@ -7,7 +6,62 @@ README.rst
		setup.py
		tests.t
		tox.ini
		docs/.DS_Store
		docs/Makefile
		docs/api.rst
		docs/changelog.rst
		docs/conf.py
		docs/index.rst
		docs/installation.rst
		docs/make.bat
		docs/usage.rst
		docs/_build/.DS_Store
		docs/_build/doctrees/api.doctree
		docs/_build/doctrees/changelog.doctree
		docs/_build/doctrees/environment.pickle
		docs/_build/doctrees/index.doctree
		docs/_build/doctrees/installation.doctree
		docs/_build/doctrees/usage.doctree
		docs/_build/html/.buildinfo
		docs/_build/html/api.html
		docs/_build/html/changelog.html
		docs/_build/html/genindex.html
		docs/_build/html/index.html
		docs/_build/html/installation.html
		docs/_build/html/objects.inv
		docs/_build/html/search.html
		docs/_build/html/searchindex.js
		docs/_build/html/usage.html
		docs/_build/html/_modules/envdir.html
		docs/_build/html/_modules/index.html
		docs/_build/html/_sources/api.txt
		docs/_build/html/_sources/changelog.txt
		docs/_build/html/_sources/index.txt
		docs/_build/html/_sources/installation.txt
		docs/_build/html/_sources/usage.txt
		docs/_build/html/_static/ajax-loader.gif
		docs/_build/html/_static/basic.css
		docs/_build/html/_static/comment-bright.png
		docs/_build/html/_static/comment-close.png
		docs/_build/html/_static/comment.png
		docs/_build/html/_static/default.css
		docs/_build/html/_static/doctools.js
		docs/_build/html/_static/down-pressed.png
		docs/_build/html/_static/down.png
		docs/_build/html/_static/file.png
		docs/_build/html/_static/jquery.js
		docs/_build/html/_static/minus.png
		docs/_build/html/_static/plus.png
		docs/_build/html/_static/pygments.css
		docs/_build/html/_static/searchtools.js
		docs/_build/html/_static/sidebar.js
		docs/_build/html/_static/underscore.js
		docs/_build/html/_static/up-pressed.png
		docs/_build/html/_static/up.png
		docs/_build/html/_static/websupport.js
		envdir/__init__.py
		envdir/__main__.py
		envdir/__version__.py
		envdir/env.py
		envdir/runner.py
		envdir/test_envdir.py
		envdir/version.py
		envdir.egg-info/PKG-INFO
		@@ -14,0 +68,0 @@ envdir.egg-info/SOURCES.txt

+17

-3

envdir/__init__.py

		@@ -1,4 +0,18 @@
		from .__main__ import envdir, main # noop
		from .__version__ import __version__ # noop
		from .__main__ import runner, go
		from .env import Env # noqa
		from .version import __version__ # noqa

		read = envdir.read
		open = runner.open


		# for backward compatibility
		def read(path=None):
		return open(path, stacklevel=2)


		def run(*args):
		go(runner.run, *args)


		def shell(*args):
		go(runner.shell, *args)

+14

-141

envdir/__main__.py

		@@ -1,149 +0,22 @@
		import glob
		import optparse
		import os
		import subprocess
		import sys

		from .__version__ import __version__
		from .runner import Runner, Response

		# must have shell = True on Windows
		shellout = sys.platform == 'win32'
		runner = Runner()


		class EnvOptionParser(optparse.OptionParser):
		def go(caller, *args):
		if not args:
		args = sys.argv
		try:
		caller(args[0], *args[1:])
		except Response as response:
		if response.message:
		sys.stderr.write(response.message)
		sys.exit(response.status or 0)
		else:
		sys.exit(0)

		def error(self, msg, no=2):
		"""error(msg : string, [no : int])

		Print a usage message incorporating 'msg' to stderr and exit.
		Takes an optional error number.
		"""
		self.print_usage(sys.stderr)
		self.exit(no, "%s: error: %s\n" % (self.get_prog_name(), msg))


		class Runner(object):
		envdir_usage = "usage: %prog [--help] [--version] dir child"
		envshell_usage = "usage: %prog [--help] [--version] dir"

		def __init__(self):
		self.parser = EnvOptionParser(version=__version__)
		self.parser.disable_interspersed_args()

		@staticmethod
		def is_envvar(name):
		root, name = os.path.split(name)
		return (name == name.upper() and
		not name.startswith('_') and
		not '=' in name)

		def environ(self, path):
		env_paths = filter(self.is_envvar, glob.glob(os.path.join(path, '*')))
		for env_path in env_paths:
		with open(env_path, 'r') as env_file:
		root, name = os.path.split(env_path)
		value = env_file.read().strip().replace('\x00', '\n')
		yield name, value

		def path(self, path):
		real_path = os.path.realpath(os.path.expanduser(path))
		if not os.path.exists(real_path):
		# use 111 error code to adher to envdir's standard
		self.parser.error("envdir %r does not exist" % path, no=111)
		if not os.path.isdir(real_path):
		# use 111 error code to adher to envdir's standard
		self.parser.error("envdir %r not a directory" % path, no=111)
		return real_path

		def read(self, path=None):
		if path is None:
		frame = sys._getframe()
		callerdir = os.path.dirname(frame.f_back.f_code.co_filename)
		path = os.path.join(callerdir, 'envdir')

		for name, value in self.environ(self.path(path)):
		if value:
		os.environ[name] = value
		elif name in os.environ:
		del os.environ[name]

		def shell(self, args):
		self.parser.set_usage(self.envshell_usage)
		self.parser.prog = 'envshell'

		if len(args) == 0:
		self.parser.error("incorrect number of arguments")
		self.parser.print_usage()

		sys.stdout.write("Launching envshell for %s. "
		"Type 'exit' or 'Ctrl+D' to return.\n" %
		self.path(args[0]))
		sys.stdout.flush()
		self.read(args[0])

		try:
		subprocess.check_call([os.environ['SHELL']],
		universal_newlines=True,
		shell=shellout,
		bufsize=0,
		close_fds=True)
		except OSError as err:
		if err.errno == 2:
		self.parser.error(err.errno,
		"Unable to find shell %s" %
		os.environ['SHELL'])
		else:
		self.parser.exit(err.errno, '')

		def call(self, args):
		self.parser.set_usage(self.envdir_usage)
		self.parser.prog = 'envdir'

		if len(args) < 2:
		self.parser.error("incorrect number of arguments")
		self.parser.print_usage()

		self.read(args[0])

		# the args to call later
		child_args = args[1:]

		# in case someone passes in -- for any reason to separate the commands
		if child_args[0] == '--':
		child_args = child_args[1:]

		try:
		subprocess.check_call(child_args,
		universal_newlines=True,
		shell=shellout,
		bufsize=0,
		close_fds=True)
		except OSError as err:
		if err.errno == 2:
		self.parser.error(err.errno,
		"Unable to find command %s" %
		child_args[0])
		else:
		self.parser.exit(err.errno, '')
		except subprocess.CalledProcessError as err:
		self.parser.exit(err.returncode, '')
		except KeyboardInterrupt:
		self.parser.exit()

		def main(self, name, args):
		options, args = self.parser.parse_args(args)
		if name.endswith('envdir') or name.endswith('__main__.py'):
		self.call(args)
		elif name.endswith('envshell'):
		self.shell(args)
		else:
		self.parser.print_usage(sys.stderr)

		envdir = Runner()


		def main():
		envdir.main(sys.argv[0], sys.argv[1:])

		if __name__ == '__main__':
		main()
		go(runner.run) # pragma: no cover

+2

-1

MANIFEST.in

		@@ -1,1 +0,2 @@
		include README.rst AUTHORS.rst CHANGES.rst tests.t tox.ini
		include README.rst AUTHORS.rst tox.ini
		recursive-include docs *

+31

-103

PKG-INFO

		Metadata-Version: 1.1
		Name: envdir
		Version: 0.5
		Version: 0.6
		Summary: A Python port of daemontools' envdir.
		Home-page: http://github.com/jezdez/envdir
		Home-page: http://envdir.readthedocs.org/
		Author: Jannis Leidel
		@@ -16,9 +16,6 @@ Author-email: jannis@leidel.info

		This is a Python port of daemontools_' tool `envdir <http://cr.yp.to/daemontools/envdir.html>`_.
		This is a Python port of daemontools_' tool envdir_. It works on Windows and
		other systems which can run Python. It's well tested and doesn't need a
		compiler to be installed.

		.. _daemontools: http://cr.yp.to/daemontools.html

		What?
		-----

		envdir runs another program with a modified environment according to files
		@@ -38,4 +35,6 @@ in a specified directory.

		Let's have a look at a typical envdir::
		Let's have a look at a typical envdir:

		.. code-block:: console

		$ tree envs/prod/
		@@ -56,4 +55,6 @@ envs/prod/
		environment variable to set when running your program. To use it, simply
		prefix the call to your program with envdir::
		prefix the call to your program with envdir:

		.. code-block:: console

		$ envdir envs/prod/ python manage.py runserver
		@@ -69,109 +70,36 @@

		.. _12factor: http://12factor.net/config

		Why?
		----

		Because envdir is small enough that it shouldn't be tied to a bigger
		software distribution like daemontools that requires a compiler.

		Also, this Python port can easily be used on Windows, not only UNIX systems.

		Installation
		------------

		::

		pip install envdir

		or::

		easy_install envdir

		Usage
		-----

		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.

		.. note::

		This Python port behaves different for multi line environment variables.
		It will not only read the first line of the file but the whole file. Take
		care with big files!
		This Python port behaves different for multi line environment variables.
		It will not only read the first line of the file but the whole file. Take
		care with big files!

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

		Python
		^^^^^^
		Feel free to open tickets at https://github.com/jezdez/envdir/issues.
		Say thanks at https://www.gittip.com/jezdez/.

		To use envdir in a Python file (e.g. Django's ``manage.py``) you can use::
		.. _12factor: http://12factor.net/config
		.. _daemontools: http://cr.yp.to/daemontools.html
		.. _envdir: http://cr.yp.to/daemontools/envdir.html

		import envdir
		envdir.read()

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

		It's also possible to explicitly pass the path to the envdir::
		0.6 (12/02/2013)
		^^^^^^^^^^^^^^^^

		import os
		import envdir
		* Rewrote tests with pytest.

		envdir.read('/home/jezdez/mysite/envs/prod')
		* Vastly extended Python API.

		Shell
		^^^^^
		* Added Sphinx based docs: http://envdir.readthedocs.org/

		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.
		* Fixed killing child process when capturing keyboard interrupt.

		For example::
		* Added standalone script based on PEPs 441 and 397, compatible with
		Python Launcher for Windows. See the installation instructions for more
		info.

		$ 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``.

		Feedback
		--------

		Feel free to open tickets at https://github.com/jezdez/envdir/issues.
		Say thanks at https://www.gittip.com/jezdez/.


		Changelog
		---------

		0.5 (09/22/2013)
		@@ -178,0 +106,0 @@ ^^^^^^^^^^^^^^^^

+18

-105

README.rst

		@@ -8,9 +8,6 @@ envdir (Python port)

		This is a Python port of daemontools_' tool `envdir <http://cr.yp.to/daemontools/envdir.html>`_.
		This is a Python port of daemontools_' tool envdir_. It works on Windows and
		other systems which can run Python. It's well tested and doesn't need a
		compiler to be installed.

		.. _daemontools: http://cr.yp.to/daemontools.html

		What?
		-----

		envdir runs another program with a modified environment according to files
		@@ -30,4 +27,6 @@ in a specified directory.

		Let's have a look at a typical envdir::
		Let's have a look at a typical envdir:

		.. code-block:: console

		$ tree envs/prod/
		@@ -48,4 +47,6 @@ envs/prod/
		environment variable to set when running your program. To use it, simply
		prefix the call to your program with envdir::
		prefix the call to your program with envdir:

		.. code-block:: console

		$ envdir envs/prod/ python manage.py runserver
		@@ -61,103 +62,15 @@

		.. _12factor: http://12factor.net/config

		Why?
		----

		Because envdir is small enough that it shouldn't be tied to a bigger
		software distribution like daemontools that requires a compiler.

		Also, this Python port can easily be used on Windows, not only UNIX systems.

		Installation
		------------

		::

		pip install envdir

		or::

		easy_install envdir

		Usage
		-----

		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.

		.. note::

		This Python port behaves different for multi line environment variables.
		It will not only read the first line of the file but the whole file. Take
		care with big files!
		This Python port behaves different for multi line environment variables.
		It will not only read the first line of the file but the whole file. Take
		care with big files!

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

		Python
		^^^^^^
		Feel free to open tickets at https://github.com/jezdez/envdir/issues.
		Say thanks at https://www.gittip.com/jezdez/.

		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``.

		Feedback
		--------

		Feel free to open tickets at https://github.com/jezdez/envdir/issues.
		Say thanks at https://www.gittip.com/jezdez/.
		.. _12factor: http://12factor.net/config
		.. _daemontools: http://cr.yp.to/daemontools.html
		.. _envdir: http://cr.yp.to/daemontools/envdir.html

+11

-0

setup.cfg

		[wheel]
		universal = 1

		[flake8]
		exclude = .tox,*.egg

		[pytest]
		flakes-ignore = UnusedImport
		addopts = --strict --quiet --tb=short
		markers =
		api: mark a test as a python API test
		run: mark a test as a envdir test
		shell: mark a test as a envshell test

		[egg_info]
		@@ -5,0 +16,0 @@ tag_build =

+20

-26

setup.py

		@@ -0,21 +1,18 @@
		import ast
		import codecs
		import os
		import re
		import sys

		from setuptools import setup
		from setuptools.command.test import test as TestCommand


		here = os.path.abspath(os.path.dirname(__file__))


		class CramTest(TestCommand):
		def finalize_options(self):
		TestCommand.finalize_options(self)
		self.test_args = []
		self.test_suite = True
		class VersionFinder(ast.NodeVisitor):
		def __init__(self):
		self.version = None

		def run_tests(self):
		import cram
		sys.exit(cram.main(['tests.t']))
		def visit_Assign(self, node):
		if node.targets[0].id == '__version__':
		self.version = node.value.s

		@@ -27,13 +24,10 @@

		def find_version(*file_paths):
		version_file = read(*file_paths)
		version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
		version_file, re.M)
		if version_match:
		return version_match.group(1)
		raise RuntimeError("Unable to find version string.")
		def find_version(*parts):
		finder = VersionFinder()
		finder.visit(ast.parse(read(*parts)))
		return finder.version


		setup(name="envdir",
		version=find_version('envdir', '__version__.py'),
		version=find_version('envdir', 'version.py'),
		classifiers=[
		@@ -53,12 +47,12 @@ 'Development Status :: 4 - Beta',
		description="A Python port of daemontools' envdir.",
		long_description=read('README.rst') + '\n\n' + read('CHANGES.rst'),
		long_description=(read('README.rst') +
		'\n\n' +
		read(os.path.join('docs', 'changelog.rst'))),
		author='Jannis Leidel',
		author_email='jannis@leidel.info',
		url='http://github.com/jezdez/envdir',
		url='http://envdir.readthedocs.org/',
		license='MIT',
		packages=['envdir'],
		entry_points=dict(console_scripts=['envdir=envdir:main',
		'envshell=envdir:main']),
		zip_safe=False,
		tests_require=['cram'],
		cmdclass={'test': CramTest})
		entry_points=dict(console_scripts=['envdir=envdir:run',
		'envshell=envdir:shell']),
		zip_safe=False)

+18

-2

tox.ini

		[tox]
		envlist = py26,py27,py33
		envlist = py26,py27,pypy,py32,py33,flake827,flake833
		;envlist = py27,flake827

		[testenv]
		commands = python setup.py test
		deps =
		pytest
		coverage
		commands =
		coverage run --source=envdir/ -m pytest []
		coverage report -m --omit=envdir/test_envdir.py

		[testenv:flake827]
		basepython = python2.7
		deps = flake8
		commands = flake8 envdir

		[testenv:flake833]
		basepython = python3.3
		deps = flake8
		commands = flake8 envdir

-54

CHANGES.rst

		Changelog
		---------

		0.5 (09/22/2013)
		^^^^^^^^^^^^^^^^

		* Added check if the the provided path is a directory and throw an error if
		not. This adds compatibility to the daemontools' envdir.

		* Make sure to convert Nulls (``\0``) to newlines as done so in daemontools'
		envdir.

		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.

-1

envdir/__version__.py

__version__ = '0.5'

tests.t

Sorry, the diff of this file is not supported yet

envdir - pypi Package Compare versions

Improved metrics