summaryrefslogtreecommitdiff
path: root/doc/user_guide/installation.rst
blob: 1d3ac175b3de651637854e16aab6ed1a666d45cd (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
.. _installation:

Installation
============

Command line
------------

Pylint is installable using a package manager. Your package manager will find a version that
works with your interpreter. We recommend ``pip``:

.. code-block:: sh

   pip install pylint

Use the newest Python interpreter if you can.

It's possible to analyse code written for older interpreters by using the ``py-version``
option and setting it to the old interpreter. For example you can check that there are
no ``f-strings`` in Python 3.5 code using Python 3.8 with an up-to-date pylint even if
Python 3.5 is past end of life (EOL).

We do not guarantee that ``py-version`` will work for all EOL python interpreters indefinitely,
(for anything before python 3.5, it's probably not). If a newer version does not work for you,
the best available pylint might be an old version that works with your old interpreter but
without the bug fixes and feature of later versions.

NB: You can also use ``conda`` or your system package manager on debian based OS.
These package managers lag a little behind as they are maintained by a separate
entity on a slower release cycle.

.. code-block:: sh

   conda install pylint

.. code-block:: sh

   sudo apt-get install pylint


Editor integration
------------------

.. _ide-integration:

- Eclipse_
- Emacs_
- `Eric IDE`_ in the `Project > Check` menu,
- gedit_ (`another option for gedit`_)
- :ref:`Flymake <pylint_in_flymake>`
- `Jupyter Notebook`_
- Komodo_
- PyCharm_ :ref:`the section below <pylint_in_pycharm>`
- PyDev_
- pyscripter_ in the `Tool -> Tools` menu.
- Spyder_ in the `View -> Panes -> Static code analysis`
- TextMate_  :ref:`the section below <pylint_in_textmate>`
- Vim_
- `Visual Studio`_
- `Visual Studio Code`_ in the `Preferences -> Settings` menu (`Visual Studio Code Pylint Extension`_)
- `Visual Studio`_ in the `Python > Run PyLint` command on a project's context menu.
- WingIDE_

.. _Eclipse: https://www.pydev.org/manual_adv_pylint.html
.. _Emacs: https://www.emacswiki.org/emacs/PythonProgrammingInEmacs
.. _Eric IDE: https://eric-ide.python-projects.org/
.. _gedit: https://launchpad.net/gedit-pylint-2
.. _another option for gedit: https://wiki.gnome.org/Apps/Gedit/PylintPlugin
.. _Jupyter Notebook:  https://github.com/nbQA-dev/nbQA
.. _Komodo: https://mateusz.loskot.net/post/2006/01/15/running-pylint-from-komodo/
.. _PyCharm: https://www.jetbrains.com/pycharm/
.. _pydev: https://www.pydev.org/
.. _pyscripter: https://github.com/pyscripter/pyscripter
.. _spyder: https://docs.spyder-ide.org/current/panes/pylint.html
.. _TextMate: https://macromates.com
.. _Vim: https://www.vim.org/scripts/script.php?script_id=891
.. _Visual Studio Code: https://code.visualstudio.com/docs/python/linting
.. _Visual Studio Code Pylint Extension: https://marketplace.visualstudio.com/items?itemName=ms-python.pylint
.. _Visual Studio: https://docs.microsoft.com/visualstudio/python/code-pylint
.. _WingIDE: https://wingware.com/doc/warnings/external-checkers