.. pep8 documentation master file

pep8's documentation
====================

.. note::

    This package used to be called `pep8 <https://pypi.python.org/pypi/pep8/1.7.0>`_ 
    but was renamed to `pycodestyle <https://pypi.python.org/pypi/pycodestyle/2.2.0>`_
    to reduce confusion. Further discussion can be found `in the issue where
    Guido requested this
    change <https://github.com/PyCQA/pycodestyle/issues/466>`_, or in the
    lightning talk at PyCon 2016 by @IanLee1521:
    `slides <https://speakerdeck.com/ianlee1521/pep8-vs-pep-8>`_
    `video <https://youtu.be/PulzIT8KYLk?t=36m>`_.

*Python style guide checker*

pep8 is a tool to check your Python code against some of the style
conventions in `PEP 8`_.

.. _PEP 8: http://www.python.org/dev/peps/pep-0008/


Contents:

.. toctree::
   :maxdepth: 2

   intro
   advanced
   API <api>
   developer

* Online documentation: http://pep8.readthedocs.org/
* Source code and issue tracker: https://github.com/pycqa/pep8


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`


Credits
=======

Created by Johann C. Rocholl.

Maintained by Florent Xicluna and Ian Lee.


.. _license:

License
=======

The ``pep8`` library is provided under the terms and conditions of the
Expat license::

  # Permission is hereby granted, free of charge, to any person
  # obtaining a copy of this software and associated documentation files
  # (the "Software"), to deal in the Software without restriction,
  # including without limitation the rights to use, copy, modify, merge,
  # publish, distribute, sublicense, and/or sell copies of the Software,
  # and to permit persons to whom the Software is furnished to do so,
  # subject to the following conditions:
  #
  # The above copyright notice and this permission notice shall be
  # included in all copies or substantial portions of the Software.
  #
  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  # SOFTWARE.