diff options
Diffstat (limited to 'doc/user_guide/installation.rst')
| -rw-r--r-- | doc/user_guide/installation.rst | 80 |
1 files changed, 38 insertions, 42 deletions
diff --git a/doc/user_guide/installation.rst b/doc/user_guide/installation.rst index 96713ca98..1d3ac175b 100644 --- a/doc/user_guide/installation.rst +++ b/doc/user_guide/installation.rst @@ -6,8 +6,8 @@ Installation Command line ------------ -Pylint is installable using a package manager. Your package manager will -find a version that works with your interpreter. For example with pip: +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 @@ -20,10 +20,10 @@ option and setting it to the old interpreter. For example you can check that the 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 interpreter indefinitely, +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 latest pylints. +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 @@ -37,48 +37,44 @@ entity on a slower release cycle. sudo apt-get install pylint + Editor integration ------------------ .. _ide-integration: -To use Pylint with: - - - Emacs_, see https://www.emacswiki.org/emacs/PythonProgrammingInEmacs, - - Vim_, see https://www.vim.org/scripts/script.php?script_id=891, - - `Visual Studio`_, see https://docs.microsoft.com/visualstudio/python/code-pylint, - - Eclipse_ and PyDev_, see https://www.pydev.org/manual_adv_pylint.html, - - Komodo_, see https://mateusz.loskot.net/post/2006/01/15/running-pylint-from-komodo/, - - gedit_, see https://launchpad.net/gedit-pylint-2 or https://wiki.gnome.org/Apps/Gedit/PylintPlugin, - - WingIDE_, see https://wingware.com/doc/warnings/external-checkers, - - PyCharm_, see :ref:`the section below <pylint_in_pycharm>`, - - TextMate_, see :ref:`the section below <pylint_in_textmate>` - - `Visual Studio Code`_, see https://code.visualstudio.com/docs/python/linting, - - `Visual Studio Code`_ Pylint Extension see, https://marketplace.visualstudio.com/items?itemName=ms-python.pylint, - - `Visual Studio`_, see https://docs.microsoft.com/en-us/visualstudio/python/linting-python-code, - - `Jupyter Notebook`_, see https://github.com/nbQA-dev/nbQA, - -Pylint is integrated in: - - - `Visual Studio`_, see the `Python > Run PyLint` command on a project's context menu. - - Eric_ IDE, see the `Project > Check` menu, - - Spyder_, see the `View -> Panes -> Static code analysis` pane and - its `corresponding documentation <https://docs.spyder-ide.org/current/panes/pylint.html>`_. - - pyscripter_, see the `Tool -> Tools` menu. - - `Visual Studio Code`_, see the `Preferences -> Settings` menu. - -.. _Emacs: https://www.gnu.org/software/emacs/ -.. _Vim: https://www.vim.org/ -.. _Visual Studio: https://visualstudio.microsoft.com/ -.. _Eclipse: https://www.eclipse.org/ -.. _Eric: https://eric-ide.python-projects.org/ -.. _pyscripter: https://github.com/pyscripter/pyscripter -.. _pydev: https://www.pydev.org/ -.. _Komodo: https://www.activestate.com/products/komodo-ide/ -.. _gedit: https://wiki.gnome.org/Apps/Gedit -.. _WingIDE: https://www.wingware.com/ -.. _spyder: https://www.spyder-ide.org/ +- 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 -.. _Visual Studio Code: https://code.visualstudio.com/ -.. _Jupyter Notebook: https://jupyter.org/ +.. _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 |