2013-04-29 13:31:03 +00:00
|
|
|
README for Pylint - http://www.pylint.org/
|
|
|
|
|
==========================================
|
2006-04-26 10:48:09 +00:00
|
|
|
|
2013-04-16 13:05:58 +00:00
|
|
|
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).
|
|
|
|
|
|
2013-04-29 13:31:03 +00:00
|
|
|
Pylint has many rules enabled by default, way too much to silence them all on a
|
2013-04-16 13:05:58 +00:00
|
|
|
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 Public Licence.
|
|
|
|
|
|
2013-04-29 13:31:03 +00:00
|
|
|
Development is hosted on bitbucket: https://bitbucket.org/logilab/pylint/
|
2006-04-26 10:48:09 +00:00
|
|
|
|
2013-04-29 13:31:03 +00:00
|
|
|
You can use the code-quality@python.org mailing list to discuss about
|
|
|
|
|
Pylint. Subscribe at http://lists.python.org/mailman/listinfo/code-quality
|
|
|
|
|
or read the archives at http://lists.python.org/pipermail/code-quality/
|
2006-04-26 10:48:09 +00:00
|
|
|
|
|
|
|
|
Install
|
|
|
|
|
-------
|
2013-04-16 13:05:58 +00:00
|
|
|
|
2013-06-17 13:06:48 +00:00
|
|
|
Pylint requires the astroid (the later the better; used to be called
|
|
|
|
|
logilab-astng) and logilab-common (version >= 0.53) packages.
|
2013-04-16 13:05:58 +00:00
|
|
|
|
2013-06-17 13:06:48 +00:00
|
|
|
* https://bitbucket.org/logilab/astroid
|
2013-04-16 13:05:58 +00:00
|
|
|
* http://www.logilab.org/projects/common
|
|
|
|
|
|
2006-04-26 10:48:09 +00:00
|
|
|
From the source distribution, extract the tarball and run ::
|
|
|
|
|
|
|
|
|
|
python setup.py install
|
|
|
|
|
|
2009-11-23 14:15:26 +00:00
|
|
|
You'll have to install dependencies in a similar way. For debian and
|
2012-07-17 15:07:05 +00:00
|
|
|
rpm packages, use your usual tools according to your Linux distribution.
|
2006-04-26 10:48:09 +00:00
|
|
|
|
2006-05-05 14:20:44 +00:00
|
|
|
More information about installation and available distribution format
|
|
|
|
|
may be found in the user manual in the *doc* subdirectory.
|
2006-04-26 10:48:09 +00:00
|
|
|
|
|
|
|
|
Documentation
|
|
|
|
|
-------------
|
2013-04-16 13:05:58 +00:00
|
|
|
|
|
|
|
|
Look in the doc/ subdirectory or at http://docs.pylint.org
|
2010-12-15 18:14:21 +00:00
|
|
|
|
|
|
|
|
Pylint is shipped with following additional commands:
|
|
|
|
|
|
|
|
|
|
* pyreverse: an UML diagram generator
|
|
|
|
|
* symilar: an independent similarities checker
|
|
|
|
|
* epylint: Emacs and Flymake compatible Pylint
|
|
|
|
|
* pylint-gui: a graphical interface
|
2006-04-26 10:48:09 +00:00
|
|
|
|
|
|
|
|
Contributors
|
|
|
|
|
------------
|
2012-07-17 15:07:05 +00:00
|
|
|
|
|
|
|
|
order doesn't matter...
|
|
|
|
|
|
2010-11-10 10:12:55 +00:00
|
|
|
* Sylvain Thenault: main author / maintainer
|
2006-04-26 10:48:09 +00:00
|
|
|
* Alexandre Fayolle: TkInter gui, documentation, debian support
|
2012-07-17 15:07:05 +00:00
|
|
|
* Emile Anclin: used to maintain, py3k support
|
2009-01-28 11:15:51 +00:00
|
|
|
* Mads Kiilerich: various patches
|
2012-07-17 15:07:05 +00:00
|
|
|
* Torsten Marek, various patches
|
|
|
|
|
* Boris Feld, various patches
|
2006-04-26 10:48:09 +00:00
|
|
|
* Brian van den Broek: windows installation documentation
|
|
|
|
|
* Amaury Forgeot d'Arc: patch to check names imported from a module
|
|
|
|
|
exists in the module
|
|
|
|
|
* Benjamin Niemann: patch to allow block level enabling/disabling of messages
|
2009-11-23 14:15:26 +00:00
|
|
|
* Nathaniel Manista: suspicious lambda checking
|
2012-07-17 15:07:05 +00:00
|
|
|
* Wolfgang Grafen, Axel Muller, Fabio Zadrozny, Pierre Rouleau,
|
|
|
|
|
Maarten ter Huurne, Mirko Friedenhagen (among others):
|
2006-04-26 10:48:09 +00:00
|
|
|
bug reports, feedback, feature requests...
|
2012-09-19 15:15:43 +00:00
|
|
|
* Martin Pool (Google): warnings for anomalous backslashes, symbolic names
|
|
|
|
|
for messages (like 'unused')
|
2006-04-26 10:48:09 +00:00
|
|
|
* All the Logilab's team: daily use, bug reports, feature requests
|
|
|
|
|
* Other people have contributed by their feedback, if I've forgotten
|
|
|
|
|
you, send me a note !
|
