pep8 is a tool to check your Python code against some of the style
conventions in `PEP 8`_.
-.. image:: https://secure.travis-ci.org/jcrocholl/pep8.png?branch=master
-
.. _PEP 8: http://www.python.org/dev/peps/pep-0008/
-Mailing List
-------------
-http://groups.google.com/group/pep8
-
-
Features
--------
You can install, upgrade, uninstall pep8.py with these commands::
- $ sudo pip install pep8
- $ sudo pip install --upgrade pep8
- $ sudo pip uninstall pep8
-
-Or if you don't have `pip`::
-
- $ sudo easy_install pep8
+ $ pip install pep8
+ $ pip install --upgrade pep8
+ $ pip uninstall pep8
There's also a package for Debian/Ubuntu, but it's not always the
-latest version::
-
- $ sudo apt-get install pep8
+latest version.
Example usage and output
------------------------
612 W601 .has_key() is deprecated, use 'in'
1188 W602 deprecated form of raising exception
-Quick help is available on the command line::
-
- $ pep8 -h
- Usage: pep8.py [options] input ...
-
- Options:
- --version show program's version number and exit
- -h, --help show this help message and exit
- -v, --verbose print status messages, or debug with -vv
- -q, --quiet report only file names, or nothing with -qq
- -r, --repeat (obsolete) show all occurrences of the same error
- --first show first occurrence of each error
- --exclude=patterns exclude files or directories which match these comma
- separated patterns (default: .svn,CVS,.bzr,.hg,.git)
- --filename=patterns when parsing directories, only check filenames matching
- these comma separated patterns (default: *.py)
- --select=errors select errors and warnings (e.g. E,W6)
- --ignore=errors skip errors and warnings (e.g. E4,W)
- --show-source show source code for each error
- --show-pep8 show text of PEP 8 for each error (implies --first)
- --statistics count errors and warnings
- --count print total number of errors and warnings to standard
- error and set exit code to 1 if total is not null
- --benchmark measure processing speed
- --testsuite=dir run regression tests from dir
- --max-line-length=n set maximum allowed line length (default: 79)
- --doctest run doctest on myself
-
-Feedback
---------
-
-Your feedback is more than welcome. Write email to
-johann@rocholl.net or post bugs and feature requests on github:
+Links
+-----
-http://github.com/jcrocholl/pep8/issues
+.. image:: https://api.travis-ci.org/jcrocholl/pep8.png?branch=master
+ :target: https://travis-ci.org/jcrocholl/pep8
+ :alt: Build status
-Source download
----------------
+.. image:: https://pypip.in/wheel/pep8/badge.png?branch=master
+ :target: https://pypi.python.org/pypi/pep8
+ :alt: Wheel Status
-The source code is currently available on github. Fork away!
+* `Read the documentation <http://pep8.readthedocs.org/>`_
-http://github.com/jcrocholl/pep8/
+* `Fork me on GitHub <http://github.com/jcrocholl/pep8>`_