diff options
| author | Claudiu Popa <pcmanticore@gmail.com> | 2014-11-14 18:43:27 +0000 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2014-11-14 18:43:27 +0000 |
| commit | b9505fb7383dfda2104ab8df35c3495158193bda (patch) | |
| tree | 10a38bb53cc25f498996b0708b37d4839f3ca1bf /README | |
| parent | 277ff385e7fc63ddbb722a9ab6ceef4b56c2be4c (diff) | |
| download | pylint-b9505fb7383dfda2104ab8df35c3495158193bda.tar.gz | |
README edited online with Bitbucket
Diffstat (limited to 'README')
| -rw-r--r-- | README | 105 |
1 files changed, 55 insertions, 50 deletions
@@ -1,50 +1,55 @@ -README for Pylint - http://www.pylint.org/ -========================================== - -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 Public Licence. - -Development is hosted on bitbucket: https://bitbucket.org/logilab/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 the astroid (the later the better; formerly known as -logilab-astng) and logilab-common (version >= 0.53) packages. - -* https://bitbucket.org/logilab/astroid -* http://www.logilab.org/projects/common - -From the source distribution, extract the tarball and run :: - - 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 -* pylint-gui: a graphical interface +
+.. image:: https://drone.io/bitbucket.org/logilab/pylint/status.png
+ :alt: drone.io Build Status
+ :target: https://drone.io/bitbucket.org/logilab/pylint
+
+README for Pylint - http://www.pylint.org/
+==========================================
+
+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 Public Licence.
+
+Development is hosted on bitbucket: https://bitbucket.org/logilab/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 the astroid (the later the better; formerly known as
+logilab-astng) and logilab-common (version >= 0.53) packages.
+
+* https://bitbucket.org/logilab/astroid
+* http://www.logilab.org/projects/common
+
+From the source distribution, extract the tarball and run ::
+
+ 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
+* pylint-gui: a graphical interface
\ No newline at end of file |