Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 2.71 KB

README.rst

File metadata and controls

80 lines (51 loc) · 2.71 KB

README for Pylint - http://www.pylint.org/

https://travis-ci.org/PyCQA/pylint.svg?branch=master AppVeyor Build Status https://coveralls.io/repos/github/PyCQA/pylint/badge.svg?branch=master Pypi Package version Documentation Status

Pylint is a Python source code analyzer which looks for programming errors, helps enforcing a coding standard and sniffs for some code smells (as defined in Martin Fowler's Refactoring book).

Pylint has many rules enabled by default, way too much to silence them all on a minimally sized program. It's highly configurable and handle pragmas to control it from within your code. Additionally, it is possible to write plugins to add your own checks.

It's a free software distributed under the GNU General Public Licence.

Development is hosted on GitHub: https://github.com/PyCQA/pylint/

You can use the [email protected] mailing list to discuss about Pylint. Subscribe at https://mail.python.org/mailman/listinfo/code-quality/ or read the archives at https://mail.python.org/pipermail/code-quality/

Install

Pylint requires astroid package (the later the better).

Installation should be as simple as

python -m pip install astroid

Pylint requires isort package (the later the better).

Installation should be as simple as

python -m pip install isort

If you want to install from a source distribution, extract the tarball and run the following commands

python setup.py install

You'll have to install dependencies in a similar way. For debian and rpm packages, use your usual tools according to your Linux distribution.

More information about installation and available distribution format may be found in the user manual in the doc subdirectory.

Documentation

Look in the doc/ subdirectory or at http://docs.pylint.org

Pylint is shipped with following additional commands:

  • pyreverse: an UML diagram generator
  • symilar: an independent similarities checker
  • epylint: Emacs and Flymake compatible Pylint