File: //proc/thread-self/root/usr/share/doc/python27-virtualenv-15.1.0/html/development.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>Development — virtualenv 15.1.0 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: '15.1.0',
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="virtualenv 15.1.0 documentation" href="index.html" />
<link rel="next" title="Release History" href="changes.html" />
<link rel="prev" title="Reference Guide" href="reference.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="changes.html" title="Release History"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="reference.html" title="Reference Guide"
accesskey="P">previous</a> |</li>
<li><a href="index.html">virtualenv 15.1.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="development">
<h1>Development<a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
<div class="section" id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
<p>Refer to the <a class="reference external" href="http://www.pip-installer.org/en/latest/development.html">pip development</a> documentation - it applies equally to
virtualenv, except that virtualenv issues should filed on the <a class="reference external" href="https://github.com/pypa/virtualenv/">virtualenv
repo</a> at GitHub.</p>
<p>Virtualenv’s release schedule is tied to pip’s – each time there’s a new pip
release, there will be a new virtualenv release that bundles the new version of
pip.</p>
<p>Files in the <cite>virtualenv_embedded/</cite> subdirectory are embedded into
<cite>virtualenv.py</cite> itself as base64-encoded strings (in order to support
single-file use of <cite>virtualenv.py</cite> without installing it). If your patch
changes any file in <cite>virtualenv_embedded/</cite>, run <cite>bin/rebuild-script.py</cite> to
update the embedded version of that file in <cite>virtualenv.py</cite>; commit that and
submit it as part of your patch / pull request.</p>
</div>
<div class="section" id="running-the-tests">
<h2>Running the tests<a class="headerlink" href="#running-the-tests" title="Permalink to this headline">¶</a></h2>
<p>Virtualenv’s test suite is small and not yet at all comprehensive, but we aim
to grow it.</p>
<p>The easy way to run tests (handles test dependencies automatically):</p>
<div class="highlight-python"><pre>$ python setup.py test</pre>
</div>
<p>If you want to run only a selection of the tests, you’ll need to run them
directly with pytest instead. Create a virtualenv, and install required
packages:</p>
<div class="highlight-python"><pre>$ pip install pytest mock</pre>
</div>
<p>Run pytest:</p>
<div class="highlight-python"><pre>$ pytest</pre>
</div>
<p>Or select just a single test file to run:</p>
<div class="highlight-python"><pre>$ pytest tests/test_virtualenv</pre>
</div>
</div>
<div class="section" id="status-and-license">
<h2>Status and License<a class="headerlink" href="#status-and-license" title="Permalink to this headline">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">virtualenv</span></tt> is a successor to <a class="reference external" href="http://cheeseshop.python.org/pypi/workingenv.py">workingenv</a>, and an extension
of <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall#creating-a-virtual-python">virtual-python</a>.</p>
<p>It was written by Ian Bicking, sponsored by the <a class="reference external" href="http://openplans.org">Open Planning
Project</a> and is now maintained by a
<a class="reference external" href="https://github.com/pypa/virtualenv/raw/master/AUTHORS.txt">group of developers</a>.
It is licensed under an
<a class="reference external" href="https://github.com/pypa/virtualenv/raw/master/LICENSE.txt">MIT-style permissive license</a>.</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="#">Development</a><ul>
<li><a class="reference internal" href="#contributing">Contributing</a></li>
<li><a class="reference internal" href="#running-the-tests">Running the tests</a></li>
<li><a class="reference internal" href="#status-and-license">Status and License</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="reference.html"
title="previous chapter">Reference Guide</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="changes.html"
title="next chapter">Release History</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/development.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="changes.html" title="Release History"
>next</a> |</li>
<li class="right" >
<a href="reference.html" title="Reference Guide"
>previous</a> |</li>
<li><a href="index.html">virtualenv 15.1.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2007-2014, Ian Bicking, The Open Planning Project, PyPA.
Last updated on Sep 08, 2017.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>