/usr/share/doc/tox/html/index.html is in tox 2.3.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | <!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>Welcome to the tox automation project — tox 2.3.1 documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.3.1',
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="tox 2.3.1 documentation" href="#" />
<link rel="next" title="tox installation" href="install.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="install.html" title="tox installation"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">tox 2.3.1 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3>quicklinks</h3>
<div style="text-align: left; font-size: 100%; vertical-align: middle;">
<table>
<tr>
<td>
<a href="#">home</a>
</td><td>
<a href="examples.html">examples</a>
</td></tr><tr><td>
<a href="install.html">install</a>
</td><td>
<a href="changelog.html">changelog</a>
</td></tr><tr><td>
<a href="config.html">config</a>
</td><td>
<a href="https://bitbucket.org/hpk42/tox/issues?status=new&status=open">issues[bb]</a>
</td></tr><tr><td>
<a href="support.html">support</a>
</td><td>
</td></tr></table>
</div>
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to the tox automation project</a><ul>
<li><a class="reference internal" href="#vision-standardize-testing-in-python">vision: standardize testing in Python</a></li>
<li><a class="reference internal" href="#what-is-tox">What is Tox?</a></li>
<li><a class="reference internal" href="#basic-example">Basic example</a></li>
<li><a class="reference internal" href="#current-features">Current features</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="install.html"
title="next chapter">tox installation</a></p>
<div id="searchbox" style="display: none" role="search">
<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="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-the-tox-automation-project">
<h1>Welcome to the tox automation project<a class="headerlink" href="#welcome-to-the-tox-automation-project" title="Permalink to this headline">¶</a></h1>
<div class="section" id="vision-standardize-testing-in-python">
<h2>vision: standardize testing in Python<a class="headerlink" href="#vision-standardize-testing-in-python" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal"><span class="pre">tox</span></code> aims to automate and standardize testing in Python. It is part
of a larger vision of easing the packaging, testing and release process
of Python software.</p>
</div>
<div class="section" id="what-is-tox">
<h2>What is Tox?<a class="headerlink" href="#what-is-tox" title="Permalink to this headline">¶</a></h2>
<p>Tox is a generic <a class="reference external" href="https://pypi.python.org/pypi/virtualenv">virtualenv</a> management and test command line tool you can use for:</p>
<ul class="simple">
<li>checking your package installs correctly with different Python versions and
interpreters</li>
<li>running your tests in each of the environments, configuring your test tool of choice</li>
<li>acting as a frontend to Continuous Integration servers, greatly
reducing boilerplate and merging CI and shell-based testing.</li>
</ul>
</div>
<div class="section" id="basic-example">
<h2>Basic example<a class="headerlink" href="#basic-example" title="Permalink to this headline">¶</a></h2>
<p>First, install <code class="docutils literal"><span class="pre">tox</span></code> with <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">tox</span></code> or <code class="docutils literal"><span class="pre">easy_install</span> <span class="pre">tox</span></code>.
Then put basic information about your project and the test environments you
want your project to run in into a <code class="docutils literal"><span class="pre">tox.ini</span></code> file residing
right next to your <code class="docutils literal"><span class="pre">setup.py</span></code> file:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c1"># content of: tox.ini , put in same dir as setup.py</span>
<span class="p">[</span><span class="n">tox</span><span class="p">]</span>
<span class="n">envlist</span> <span class="o">=</span> <span class="n">py26</span><span class="p">,</span><span class="n">py27</span>
<span class="p">[</span><span class="n">testenv</span><span class="p">]</span>
<span class="n">deps</span><span class="o">=</span><span class="n">pytest</span> <span class="c1"># install pytest in the venvs</span>
<span class="n">commands</span><span class="o">=</span><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="c1"># or 'nosetests' or ...</span>
</pre></div>
</div>
<p>You can also try generating a <code class="docutils literal"><span class="pre">tox.ini</span></code> file automatically, by running
<code class="docutils literal"><span class="pre">tox-quickstart</span></code> and then answering a few simple questions.</p>
<p>To sdist-package, install and test your project against Python2.6 and Python2.7, just type:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">tox</span>
</pre></div>
</div>
<p>and watch things happening (you must have python2.6 and python2.7 installed in your
environment otherwise you will see errors). When you run <code class="docutils literal"><span class="pre">tox</span></code> a second time
you’ll note that it runs much faster because it keeps track of virtualenv details
and will not recreate or re-install dependencies. You also might want to
checkout <a class="reference internal" href="examples.html"><em>tox configuration and usage examples</em></a> to get some more ideas.</p>
</div>
<div class="section" id="current-features">
<h2>Current features<a class="headerlink" href="#current-features" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first"><strong>automation of tedious Python related test activities</strong></p>
</li>
<li><p class="first"><strong>test your Python package against many interpreter and dependency configs</strong></p>
<blockquote>
<div><ul class="simple">
<li>automatic customizable (re)creation of <a class="reference external" href="https://pypi.python.org/pypi/virtualenv">virtualenv</a> test environments</li>
<li>installs your <code class="docutils literal"><span class="pre">setup.py</span></code> based project into each virtual environment</li>
<li>test-tool agnostic: runs py.test, nose or unittests in a uniform manner</li>
</ul>
</div></blockquote>
</li>
<li><p class="first"><a class="reference internal" href="plugins.html"><em>(new in 2.0) plugin system</em></a> to modify tox execution with simple hooks.</p>
</li>
<li><p class="first">uses <a class="reference external" href="https://pypi.python.org/pypi/pip">pip</a> and <a class="reference external" href="https://pypi.python.org/pypi/setuptools">setuptools</a> by default. Support for configuring the installer command
through <a class="reference internal" href="config.html#confval-install_command=ARGV"><code class="xref std std-confval docutils literal"><span class="pre">install_command=ARGV</span></code></a>.</p>
</li>
<li><p class="first"><strong>cross-Python compatible</strong>: CPython-2.6, 2.7, 3.2 and higher,
Jython and <a class="reference external" href="http://pypy.org">pypy</a>.</p>
</li>
<li><p class="first"><strong>cross-platform</strong>: Windows and Unix style environments</p>
</li>
<li><p class="first"><strong>integrates with continuous integration servers</strong> like <a class="reference external" href="http://jenkins-ci.org/">Jenkins</a>
(formerly known as Hudson) and helps you to avoid boilerplatish
and platform-specific build-step hacks.</p>
</li>
<li><p class="first"><strong>full interoperability with devpi</strong>: is integrated with and
is used for testing in the <a class="reference external" href="http://doc.devpi.net">devpi</a> system, a versatile pypi
index server and release managing tool.</p>
</li>
<li><p class="first"><strong>driven by a simple ini-style config file</strong></p>
</li>
<li><p class="first"><strong>documented</strong> <a class="reference internal" href="examples.html"><em>examples</em></a> and <a class="reference internal" href="config.html"><em>configuration</em></a></p>
</li>
<li><p class="first"><strong>concise reporting</strong> about tool invocations and configuration errors</p>
</li>
<li><p class="first"><strong>professionally</strong> <a class="reference internal" href="support.html"><em>supported</em></a></p>
</li>
<li><p class="first">supports <a class="reference internal" href="example/basic.html#multiindex"><span>using different / multiple PyPI index servers</span></a></p>
</li>
</ul>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="install.html" title="tox installation"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">tox 2.3.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2015, holger krekel and others.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
</div>
</body>
</html>
|