<!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>pep8’s documentation — pep8 1.5.7 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: '1.5.7',
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="pep8 1.5.7 documentation" href="#" />
<link rel="next" title="Introduction" href="intro.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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction"
accesskey="N">next</a> |</li>
<li><a href="#">pep8 1.5.7 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="pep8-s-documentation">
<h1>pep8’s documentation<a class="headerlink" href="#pep8-s-documentation" title="Permalink to this headline">¶</a></h1>
<p><em>Python style guide checker</em></p>
<p>pep8 is a tool to check your Python code against some of the style
conventions in <a class="reference external" href="http://www.python.org/dev/peps/pep-0008/">PEP 8</a>.</p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#disclaimer">Disclaimer</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#example-usage-and-output">Example usage and output</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#error-codes">Error codes</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#related-tools">Related tools</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advanced.html#automated-tests">Automated tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced.html#skip-file-header">Skip file header</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#checker-classes">Checker Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#report-classes">Report Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#utilities">Utilities</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">Developer’s notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developer.html#source-code">Source code</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#contribute">Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer.html#changes">Changes</a></li>
</ul>
</li>
</ul>
</div>
<ul class="simple">
<li>Online documentation: <a class="reference external" href="http://pep8.readthedocs.org/">http://pep8.readthedocs.org/</a></li>
<li>Source code and issue tracker: <a class="reference external" href="https://github.com/jcrocholl/pep8">https://github.com/jcrocholl/pep8</a></li>
</ul>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
<div class="section" id="credits">
<h1>Credits<a class="headerlink" href="#credits" title="Permalink to this headline">¶</a></h1>
<p>Created by Johann C. Rocholl.</p>
<p>Maintained by Florent Xicluna.</p>
</div>
<div class="section" id="license">
<span id="id1"></span><h1>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h1>
<p>The <tt class="docutils literal"><span class="pre">pep8</span></tt> library is provided under the terms and conditions of the
Expat license:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># Permission is hereby granted, free of charge, to any person</span>
<span class="c"># obtaining a copy of this software and associated documentation files</span>
<span class="c"># (the "Software"), to deal in the Software without restriction,</span>
<span class="c"># including without limitation the rights to use, copy, modify, merge,</span>
<span class="c"># publish, distribute, sublicense, and/or sell copies of the Software,</span>
<span class="c"># and to permit persons to whom the Software is furnished to do so,</span>
<span class="c"># subject to the following conditions:</span>
<span class="c">#</span>
<span class="c"># The above copyright notice and this permission notice shall be</span>
<span class="c"># included in all copies or substantial portions of the Software.</span>
<span class="c">#</span>
<span class="c"># THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<span class="c"># EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<span class="c"># MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
<span class="c"># NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS</span>
<span class="c"># BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN</span>
<span class="c"># ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span>
<span class="c"># CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
<span class="c"># SOFTWARE.</span>
</pre></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="#">pep8’s documentation</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
<li><a class="reference internal" href="#credits">Credits</a></li>
<li><a class="reference internal" href="#license">License</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="intro.html"
title="next chapter">Introduction</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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction"
>next</a> |</li>
<li><a href="#">pep8 1.5.7 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012-2013, Florent Xicluna.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
45e989b293a0716dd7760fd2ff478420
>
files
>
50
