blob: 8cc02fb8e9d7cf247aa191435618aa253e9e54d3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
README for Pylint - http://pylint.pycqa.org/
============================================
.. image:: https://travis-ci.org/PyCQA/pylint.svg?branch=master
:target: https://travis-ci.org/PyCQA/pylint
.. image:: https://ci.appveyor.com/api/projects/status/rbvwhakyj1y09atb/branch/master?svg=true
:alt: AppVeyor Build Status
:target: https://ci.appveyor.com/project/PCManticore/pylint
.. image:: https://coveralls.io/repos/github/PyCQA/pylint/badge.svg?branch=master
:target: https://coveralls.io/github/PyCQA/pylint?branch=master
.. image:: https://img.shields.io/pypi/v/pylint.svg
:alt: Pypi Package version
:target: https://pypi.python.org/pypi/pylint
.. image:: https://readthedocs.org/projects/pylint/badge/?version=latest
:target: http://pylint.readthedocs.io/en/latest/?badge=latest
:alt: 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 code-quality@python.org 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).
* https://github.com/PyCQA/astroid
Installation should be as simple as ::
python -m pip install astroid
Pylint requires isort package (the later the better).
* https://github.com/timothycrosley/isort
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://pylint.pycqa.org/
Pylint is shipped with following additional commands:
* pyreverse: an UML diagram generator
* symilar: an independent similarities checker
* epylint: Emacs and Flymake compatible Pylint
Note
----
Python 3.7 support is currently available on the preview release: ::
pip install pylint astroid --pre -U
|
