<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>pep8’s documentation — pep8 1.7.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="intro.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="#" class="icon icon-home"> pep8
</a>
<div class="version">
1.7
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">Developer’s notes</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">pep8</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>pep8’s documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<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>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This package used to be called <a class="reference external" href="https://pypi.python.org/pypi/pep8/1.7.0">pep8</a>
but was renamed to <a class="reference external" href="https://pypi.python.org/pypi/pycodestyle/2.2.0">pycodestyle</a>
to reduce confusion. Further discussion can be found <a class="reference external" href="https://github.com/PyCQA/pycodestyle/issues/466">in the issue where
Guido requested this
change</a>, or in the
lightning talk at PyCon 2016 by @IanLee1521:
<a class="reference external" href="https://speakerdeck.com/ianlee1521/pep8-vs-pep-8">slides</a>
<a class="reference external" href="https://youtu.be/PulzIT8KYLk?t=36m">video</a>.</p>
</div>
<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#direction">Direction</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/pycqa/pep8">https://github.com/pycqa/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"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></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 and Ian Lee.</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 <code class="docutils literal notranslate"><span class="pre">pep8</span></code> library is provided under the terms and conditions of the
Expat license:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Permission is hereby granted, free of charge, to any person</span>
<span class="c1"># obtaining a copy of this software and associated documentation files</span>
<span class="c1"># (the "Software"), to deal in the Software without restriction,</span>
<span class="c1"># including without limitation the rights to use, copy, modify, merge,</span>
<span class="c1"># publish, distribute, sublicense, and/or sell copies of the Software,</span>
<span class="c1"># and to permit persons to whom the Software is furnished to do so,</span>
<span class="c1"># subject to the following conditions:</span>
<span class="c1">#</span>
<span class="c1"># The above copyright notice and this permission notice shall be</span>
<span class="c1"># included in all copies or substantial portions of the Software.</span>
<span class="c1">#</span>
<span class="c1"># THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<span class="c1"># EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<span class="c1"># MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
<span class="c1"># NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS</span>
<span class="c1"># BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN</span>
<span class="c1"># ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span>
<span class="c1"># CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
<span class="c1"># SOFTWARE.</span>
</pre></div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="intro.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2006-2016, Johann C. Rocholl, Florent Xicluna, Ian Lee
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
a6254888eefb55523214963a0e59d4d0
>
files
>
90
