pycodestyle (formerly called pep8) - Python style guide checker
===============================================================
.. image:: https://github.com/PyCQA/pycodestyle/actions/workflows/main.yml/badge.svg
:target: https://github.com/PyCQA/pycodestyle/actions/workflows/main.yml
:alt: Build status
.. image:: https://readthedocs.org/projects/pycodestyle/badge/?version=latest
:target: https://pycodestyle.pycqa.org
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/wheel/pycodestyle.svg
:target: https://pypi.org/project/pycodestyle/
:alt: Wheel Status
.. image:: https://badges.gitter.im/PyCQA/pycodestyle.svg
:alt: Join the chat at https://gitter.im/PyCQA/pycodestyle
:target: https://gitter.im/PyCQA/pycodestyle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
pycodestyle 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/
.. note::
This package used to be called ``pep8`` but was renamed to ``pycodestyle``
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>`_.
Features
--------
* Plugin architecture: Adding new checks is easy.
* Parseable output: Jump to error location in your editor.
* Small: Just one Python file, requires only stdlib. You can use just
the ``pycodestyle.py`` file for this purpose.
* Comes with a comprehensive test suite.
Installation
------------
You can install, upgrade, and uninstall ``pycodestyle.py`` with these commands::
$ pip install pycodestyle
$ pip install --upgrade pycodestyle
$ pip uninstall pycodestyle
There's also a package for Debian/Ubuntu, but it's not always the
latest version.
Example usage and output
------------------------
::
$ pycodestyle --first optparse.py
optparse.py:69:11: E401 multiple imports on one line
optparse.py:77:1: E302 expected 2 blank lines, found 1
optparse.py:88:5: E301 expected 1 blank line, found 0
optparse.py:347:31: E211 whitespace before '('
optparse.py:357:17: E201 whitespace after '{'
optparse.py:472:29: E221 multiple spaces before operator
You can also make ``pycodestyle.py`` show the source code for each error, and
even the relevant text from PEP 8::
$ pycodestyle --show-source --show-pep8 testing/data/E40.py
testing/data/E40.py:2:10: E401 multiple imports on one line
import os, sys
^
Imports should usually be on separate lines.
Okay: import os\nimport sys
E401: import sys, os
Or you can display how often each error was found::
$ pycodestyle --statistics -qq Python-2.5/Lib
232 E201 whitespace after '['
599 E202 whitespace before ')'
631 E203 whitespace before ','
842 E211 whitespace before '('
2531 E221 multiple spaces before operator
4473 E301 expected 1 blank line, found 0
4006 E302 expected 2 blank lines, found 1
165 E303 too many blank lines (4)
325 E401 multiple imports on one line
3615 E501 line too long (82 characters)
Links
-----
* `Read the documentation <https://pycodestyle.pycqa.org/>`_
* `Fork me on GitHub <http://github.com/PyCQA/pycodestyle>`_
Raw data
{
"_id": null,
"home_page": "https://pycodestyle.pycqa.org/",
"name": "pycodestyle",
"maintainer": "Ian Lee",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "IanLee1521@gmail.com",
"keywords": "pycodestyle, pep8, PEP 8, PEP-8, PEP8",
"author": "Johann C. Rocholl",
"author_email": "johann@rocholl.net",
"download_url": "https://files.pythonhosted.org/packages/43/aa/210b2c9aedd8c1cbeea31a50e42050ad56187754b34eb214c46709445801/pycodestyle-2.12.1.tar.gz",
"platform": null,
"description": "pycodestyle (formerly called pep8) - Python style guide checker\n===============================================================\n\n.. image:: https://github.com/PyCQA/pycodestyle/actions/workflows/main.yml/badge.svg\n :target: https://github.com/PyCQA/pycodestyle/actions/workflows/main.yml\n :alt: Build status\n\n.. image:: https://readthedocs.org/projects/pycodestyle/badge/?version=latest\n :target: https://pycodestyle.pycqa.org\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/wheel/pycodestyle.svg\n :target: https://pypi.org/project/pycodestyle/\n :alt: Wheel Status\n\n.. image:: https://badges.gitter.im/PyCQA/pycodestyle.svg\n :alt: Join the chat at https://gitter.im/PyCQA/pycodestyle\n :target: https://gitter.im/PyCQA/pycodestyle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n\npycodestyle is a tool to check your Python code against some of the style\nconventions in `PEP 8`_.\n\n.. _PEP 8: http://www.python.org/dev/peps/pep-0008/\n\n.. note::\n\n This package used to be called ``pep8`` but was renamed to ``pycodestyle``\n to reduce confusion. Further discussion can be found `in the issue where\n Guido requested this\n change <https://github.com/PyCQA/pycodestyle/issues/466>`_, or in the\n lightning talk at PyCon 2016 by @IanLee1521:\n `slides <https://speakerdeck.com/ianlee1521/pep8-vs-pep-8>`_\n `video <https://youtu.be/PulzIT8KYLk?t=36m>`_.\n\nFeatures\n--------\n\n* Plugin architecture: Adding new checks is easy.\n\n* Parseable output: Jump to error location in your editor.\n\n* Small: Just one Python file, requires only stdlib. You can use just\n the ``pycodestyle.py`` file for this purpose.\n\n* Comes with a comprehensive test suite.\n\nInstallation\n------------\n\nYou can install, upgrade, and uninstall ``pycodestyle.py`` with these commands::\n\n $ pip install pycodestyle\n $ pip install --upgrade pycodestyle\n $ pip uninstall pycodestyle\n\nThere's also a package for Debian/Ubuntu, but it's not always the\nlatest version.\n\nExample usage and output\n------------------------\n\n::\n\n $ pycodestyle --first optparse.py\n optparse.py:69:11: E401 multiple imports on one line\n optparse.py:77:1: E302 expected 2 blank lines, found 1\n optparse.py:88:5: E301 expected 1 blank line, found 0\n optparse.py:347:31: E211 whitespace before '('\n optparse.py:357:17: E201 whitespace after '{'\n optparse.py:472:29: E221 multiple spaces before operator\n\nYou can also make ``pycodestyle.py`` show the source code for each error, and\neven the relevant text from PEP 8::\n\n $ pycodestyle --show-source --show-pep8 testing/data/E40.py\n testing/data/E40.py:2:10: E401 multiple imports on one line\n import os, sys\n ^\n Imports should usually be on separate lines.\n\n Okay: import os\\nimport sys\n E401: import sys, os\n\n\nOr you can display how often each error was found::\n\n $ pycodestyle --statistics -qq Python-2.5/Lib\n 232 E201 whitespace after '['\n 599 E202 whitespace before ')'\n 631 E203 whitespace before ','\n 842 E211 whitespace before '('\n 2531 E221 multiple spaces before operator\n 4473 E301 expected 1 blank line, found 0\n 4006 E302 expected 2 blank lines, found 1\n 165 E303 too many blank lines (4)\n 325 E401 multiple imports on one line\n 3615 E501 line too long (82 characters)\n\nLinks\n-----\n\n* `Read the documentation <https://pycodestyle.pycqa.org/>`_\n\n* `Fork me on GitHub <http://github.com/PyCQA/pycodestyle>`_\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python style guide checker",
"version": "2.12.1",
"project_urls": {
"Changes": "https://pycodestyle.pycqa.org/en/latest/developer.html#changes",
"Homepage": "https://pycodestyle.pycqa.org/"
},
"split_keywords": [
"pycodestyle",
" pep8",
" pep 8",
" pep-8",
" pep8"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ad8a211b3f85e99a0daa2ddec96c949cac6824bd305b040571b82a03dd62636",
"md5": "d74dba95f99df50053f76c03b71ad270",
"sha256": "46f0fb92069a7c28ab7bb558f05bfc0110dac69a0cd23c61ea0040283a9d78b3"
},
"downloads": -1,
"filename": "pycodestyle-2.12.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d74dba95f99df50053f76c03b71ad270",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 31284,
"upload_time": "2024-08-04T20:26:53",
"upload_time_iso_8601": "2024-08-04T20:26:53.173027Z",
"url": "https://files.pythonhosted.org/packages/3a/d8/a211b3f85e99a0daa2ddec96c949cac6824bd305b040571b82a03dd62636/pycodestyle-2.12.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "43aa210b2c9aedd8c1cbeea31a50e42050ad56187754b34eb214c46709445801",
"md5": "a116089dc7267cfd082c779680b8cab2",
"sha256": "6838eae08bbce4f6accd5d5572075c63626a15ee3e6f842df996bf62f6d73521"
},
"downloads": -1,
"filename": "pycodestyle-2.12.1.tar.gz",
"has_sig": false,
"md5_digest": "a116089dc7267cfd082c779680b8cab2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 39232,
"upload_time": "2024-08-04T20:26:54",
"upload_time_iso_8601": "2024-08-04T20:26:54.576097Z",
"url": "https://files.pythonhosted.org/packages/43/aa/210b2c9aedd8c1cbeea31a50e42050ad56187754b34eb214c46709445801/pycodestyle-2.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-04 20:26:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pycodestyle"
}
JSON