https://github.com/greenbone/autohooks-plugin-pylint
Autohooks plugin for code linting via pylint
https://github.com/greenbone/autohooks-plugin-pylint
automation base devops hooks python
Last synced: about 1 year ago
JSON representation
Autohooks plugin for code linting via pylint
- Host: GitHub
- URL: https://github.com/greenbone/autohooks-plugin-pylint
- Owner: greenbone
- License: gpl-3.0
- Created: 2019-02-20T11:15:36.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T07:03:34.000Z (about 2 years ago)
- Last Synced: 2024-04-17T16:11:16.419Z (about 2 years ago)
- Topics: automation, base, devops, hooks, python
- Language: Python
- Homepage:
- Size: 1.05 MB
- Stars: 3
- Watchers: 9
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# autohooks-plugin-pylint
[](https://pypi.org/project/autohooks-plugin-pylint/)
An [autohooks](https://github.com/greenbone/autohooks) plugin for python code
linting via [pylint](https://github.com/PyCQA/pylint).
## Installation
### Install using pip
You can install the latest stable release of autohooks-plugin-pylint from the
Python Package Index using [pip](https://pip.pypa.io/):
python3 -m pip install autohooks-plugin-pylint
### Install using poetry
It is highly encouraged to use [poetry](https://python-poetry.org) 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.
```toml
[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:
```toml
[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:
```toml
[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 AG](https://www.greenbone.net/).
## Contributing
Your contributions are highly appreciated. Please
[create a pull request](https://github.com/greenbone/autohooks-plugin-pylint/pulls)
on GitHub. Bigger changes need to be discussed with the development team via the
[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-pylint/issues)
first.
## License
Copyright (C) 2019 - 2023 [Greenbone AG](https://www.greenbone.net/)
Licensed under the [GNU General Public License v3.0 or later](LICENSE).