1- pep8 - Python style guide checker
2- =================================
1+ pycodestyle (formerly called pep8) - Python style guide checker
2+ ===============================================================
33
4- pep8 is a tool to check your Python code against some of the style
4+ pycodestyle is a tool to check your Python code against some of the style
55conventions in `PEP 8 `_.
66
77.. _PEP 8 : http://www.python.org/dev/peps/pep-0008/
88
9+ .. note ::
10+
11+ This package used to be called ``pep8 `` but was renamed to ``pycodestyle ``
12+ to reduce confusion. Further discussion `here
13+ <https://github.com/PyCQA/pycodestyle/issues/466> `_.
914
1015Features
1116--------
@@ -15,18 +20,18 @@ Features
1520* Parseable output: Jump to error location in your editor.
1621
1722* Small: Just one Python file, requires only stdlib. You can use just
18- the pep8 .py file for this purpose.
23+ the `` pycodestyle .py`` file for this purpose.
1924
2025* Comes with a comprehensive test suite.
2126
2227Installation
2328------------
2429
25- You can install, upgrade, uninstall pep8 .py with these commands::
30+ You can install, upgrade, uninstall `` pycodestyle .py`` with these commands::
2631
27- $ pip install pep8
28- $ pip install --upgrade pep8
29- $ pip uninstall pep8
32+ $ pip install pycodestyle
33+ $ pip install --upgrade pycodestyle
34+ $ pip uninstall pycodestyle
3035
3136There's also a package for Debian/Ubuntu, but it's not always the
3237latest version.
@@ -36,7 +41,7 @@ Example usage and output
3641
3742::
3843
39- $ pep8 --first optparse.py
44+ $ pycodestyle --first optparse.py
4045 optparse.py:69:11: E401 multiple imports on one line
4146 optparse.py:77:1: E302 expected 2 blank lines, found 1
4247 optparse.py:88:5: E301 expected 1 blank line, found 0
@@ -46,10 +51,10 @@ Example usage and output
4651 optparse.py:472:29: E221 multiple spaces before operator
4752 optparse.py:544:21: W601 .has_key() is deprecated, use 'in'
4853
49- You can also make pep8 .py show the source code for each error, and
54+ You can also make `` pycodestyle .py`` show the source code for each error, and
5055even the relevant text from PEP 8::
5156
52- $ pep8 --show-source --show-pep8 testsuite/E40.py
57+ $ pycodestyle --show-source --show-pep8 testsuite/E40.py
5358 testsuite/E40.py:2:10: E401 multiple imports on one line
5459 import os, sys
5560 ^
@@ -61,7 +66,7 @@ even the relevant text from PEP 8::
6166
6267Or you can display how often each error was found::
6368
64- $ pep8 --statistics -qq Python-2.5/Lib
69+ $ pycodestyle --statistics -qq Python-2.5/Lib
6570 232 E201 whitespace after '['
6671 599 E202 whitespace before ')'
6772 631 E203 whitespace before ','
@@ -78,14 +83,14 @@ Or you can display how often each error was found::
7883Links
7984-----
8085
81- .. image :: https://api.travis-ci.org/jcrocholl/pep8 .png?branch=master
82- :target: https://travis-ci.org/jcrocholl/pep8
86+ .. image :: https://api.travis-ci.org/PyCQA/pycodestyle .png?branch=master
87+ :target: https://travis-ci.org/PyCQA/pycodestyle
8388 :alt: Build status
8489
85- .. image :: https://pypip.in/wheel/pep8 /badge.png?branch=master
86- :target: https://pypi.python.org/pypi/pep8
90+ .. image :: https://pypip.in/wheel/pycodestyle /badge.png?branch=master
91+ :target: https://pypi.python.org/pypi/pycodestyle
8792 :alt: Wheel Status
8893
89- * `Read the documentation <http ://pep8 .readthedocs.org / >`_
94+ * `Read the documentation <https ://pycodestyle .readthedocs.io / >`_
9095
91- * `Fork me on GitHub <http://github.com/jcrocholl/pep8 >`_
96+ * `Fork me on GitHub <http://github.com/PyCQA/pycodestyle >`_
0 commit comments