autohooks-plugin-pylint

An autohooks plugin for python code linting via pylint.

Installation

Install using pip

You can install the latest stable release of autohooks-plugin-pylint from the Python Package Index using pip:

pip install autohooks-plugin-pylint

Note the pip refers to the Python 3 package manager. In a environment where Python 2 is also available the correct command may be pip3.

Install using poetry

It is highly encouraged to use poetry for maintaining your project's dependencies. Normally autohooks-plugin-pylint is installed as a development dependency.

poetry install

Usage

To activate the pylint autohooks plugin please add the following setting to your pyproject.toml file.

[tool.autohooks]
pre-commit = ["autohooks.plugins.pylint"]

By default, autohooks plugin pylint checks all files with a .py ending. If only files in a sub-directory or files with different endings should be formatted, just add the following setting:

[tool.autohooks]
pre-commit = ["autohooks.plugins.pylint"]

[tool.autohooks.plugins.pylint]
include = ['foo/*.py', '*.foo']

By default, autohooks plugin pylint executes pylint without any arguments and pylint settings are loaded from the .pylintrc file in the root directory of git repository. To change specific settings or to define a different pylint rc file the following plugin configuration can be used:

[tool.autohooks]
pre-commit = ["autohooks.plugins.pylint"]

[tool.autohooks.plugins.pylint]
arguments = ["--rcfile=/path/to/pylintrc", "-s", "n"]

Maintainer

This project is maintained by Greenbone Networks GmbH.

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.

License

Copyright (C) 2019 - 2022 Greenbone Networks GmbH

Licensed under the GNU General Public License v3.0 or later.