diff options
| author | Roberto Leinardi <leinardi@gmail.com> | 2018-08-22 11:07:12 +0200 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2018-08-23 09:25:50 +0200 |
| commit | b3dc683b83fef78bef9774ad26bc44647beb2457 (patch) | |
| tree | 36b2fee2bada1d8749ac5344f74f485df7462c77 | |
| parent | 064f3788bba2ceff202a7efabb9516b52730cb03 (diff) | |
| download | pylint-git-b3dc683b83fef78bef9774ad26bc44647beb2457.tar.gz | |
added pylint-PyCharm-plugin to the ide integration docs
| -rw-r--r-- | CONTRIBUTORS.txt | 2 | ||||
| -rw-r--r-- | doc/user_guide/ide-integration.rst | 16 |
2 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 7cd2de4a7..5d0b6992c 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -221,3 +221,5 @@ contributors: * Natalie Serebryakova: contributor * Caio Carrara: contributor + +* Roberto Leinardi: PyCharm plugin maintainer
\ No newline at end of file diff --git a/doc/user_guide/ide-integration.rst b/doc/user_guide/ide-integration.rst index 809eaef89..80a899224 100644 --- a/doc/user_guide/ide-integration.rst +++ b/doc/user_guide/ide-integration.rst @@ -125,6 +125,22 @@ Remember the path at which it's installed:: which pylint +Using pylint-PyCharm-plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. Download the latest version of the `pylint-plugin.jar <https://github.com/leinardi/pylint-PyCharm-plugin/releases>`_ +#. In PyCharm go to *Preferences* -> *Plugins* > *Install plugins from disc...*, select downloaded file and restart PyCharm when prompted +#. After restart you should find the plugin in *View* > *Tool windows* > *Pylint terminal* + +By default the plugin runs Pylint on the root directory of your PyCharm project. If you want to specify a different directory: + +#. Right click on the Pylint terminal window +#. Select "Configure plugin..." +#. Replace the '.' at the end of the "Pylint command" with the modules or packages you want to check (e.g. "``pylint --msg-template='{path}:{line:d}: {C}: {category}: {msg} ({symbol})' my_module``") + +Using External Tools +~~~~~~~~~~~~~~~~~~~~ + Within PyCharm: #. Navigate to the preferences window |