aristanetworks/pylint

README for Pylint - [***]

.. image:: [] :target: []

.. image:: [] :alt: AppVeyor Build Status :target: []

.. image:: [] :target: []

.. image:: [] :alt: Pypi Package version :target: []

.. image:: [] :target: [] :alt: Documentation Status

.. image:: [***] :target: https://github.com/ambv/black

.. |tideliftlogo| image:: doc/media/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png :width: 75 :height: 60 :alt: Tidelift

.. list-table:: :widths: 10 100

• • |tideliftlogo|
  • Professional support for pylint is available as part of the Tidelift Subscription_. Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools.

.. _Tidelift Subscription: [***]

====== Pylint

It's not just a linter that annoys you!

Pylint is a Python static code analysis tool which looks for programming errors, helps enforcing a coding standard, sniffs for code smells and offers simple refactoring suggestions.

It's highly configurable, having special pragmas to control its errors and warnings from within your code, as well as from an extensive configuration file. It is also possible to write your own plugins for adding your own checks or for extending pylint in one way or another.

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

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

You can use the *** mailing list to discuss about Pylint. Subscribe at [] or read the archives at []

Pull requests are amazing and most welcome.

Install

Pylint can be simply installed by running::

pip install pylint

If you are using Python 3.6+, upgrade to get full support for your version::

pip install pylint --upgrade

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

python setup.py install

Do make sure to do the same for astroid, which is used internally by pylint.

For debian and rpm packages, use your usual tools according to your Linux distribution.

More information about installation and available distribution format can be found here_.

Documentation

The documentation lives at [***]

Pylint is shipped with following additional commands:

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

Testing

We use tox_ for running the test suite. You should be able to install it with::

pip install tox pytest

To run the test suite for a particular Python version, you can do::

tox -e py37

To run individual tests with tox, you can do::

tox -e py37 -- -k name_of_the_test

We use pytest_ for testing pylint, which you can use without using tox for a faster development cycle.

If you want to run tests on a specific portion of the code with pytest_, (pytest-cov_) and your local python version::

# ( pip install pytest-cov )
# Everything:
python3 -m pytest tests/
# Everything in tests/message with coverage for the relevant code:
python3 -m pytest tests/message/ --cov=pylin***ssage
coverage html
# Only the functional test "missing_kwoa_py3":
python3 -m pytest "tests/test_functional.py::test_functional[missing_kwoa_py3]"

Do not forget to clone astroid_ and install the last version::

git clone https://github.com/PyCQA/astroid.git

# From source
python3 astroid/setup.py build sdist
pip3 install astroid/dist/astroid*.tar.gz

# Using an editable installation
cd astroid
python3 -m pip install -e .

For more detailed information, check the documentation.

.. _here: [] .. _tox: [] .. _pytest: [] .. _pytest-cov: [] .. _astroid: https://github.com/PyCQA/astroid

License

pylint is, with a few exceptions listed below, GPLv2 <COPYING>_.

The icon files are licensed under the CC BY-SA 4.0 <https://creativecommons.org/licenses/by-sa/4.0/>_ license:

• doc/logo.png <doc/logo.png>_
• doc/logo.svg <doc/logo.svg>_