autohooks-plugin-pylint


Nameautohooks-plugin-pylint JSON
Version 23.10.0 PyPI version JSON
download
home_pagehttps://github.com/greenbone/autohooks-plugin-pylint
SummaryAn autohooks plugin for python code linting via pylint
upload_time2023-10-18 11:33:15
maintainer
docs_urlNone
authorGreenbone AG
requires_python>=3.9,<4.0
licenseGPL-3.0-or-later
keywords git formatting linting hooks pylint
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)

# autohooks-plugin-pylint

[![PyPI release](https://img.shields.io/pypi/v/autohooks-plugin-pylint.svg)](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).

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/greenbone/autohooks-plugin-pylint",
    "name": "autohooks-plugin-pylint",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "git,formatting,linting,hooks,pylint",
    "author": "Greenbone AG",
    "author_email": "info@greenbone.net",
    "download_url": "https://files.pythonhosted.org/packages/76/7a/3cb38e68fd05a8183b3538513fd3c2252465bc21069e69ba6da5694f3860/autohooks_plugin_pylint-23.10.0.tar.gz",
    "platform": null,
    "description": "![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)\n\n# autohooks-plugin-pylint\n\n[![PyPI release](https://img.shields.io/pypi/v/autohooks-plugin-pylint.svg)](https://pypi.org/project/autohooks-plugin-pylint/)\n\nAn [autohooks](https://github.com/greenbone/autohooks) plugin for python code\nlinting via [pylint](https://github.com/PyCQA/pylint).\n\n## Installation\n\n### Install using pip\n\nYou can install the latest stable release of autohooks-plugin-pylint from the\nPython Package Index using [pip](https://pip.pypa.io/):\n\n    python3 -m pip install autohooks-plugin-pylint\n\n### Install using poetry\n\nIt is highly encouraged to use [poetry](https://python-poetry.org) for\nmaintaining your project's dependencies. Normally autohooks-plugin-pylint is\ninstalled as a development dependency.\n\n    poetry install\n\n## Usage\n\nTo activate the pylint autohooks plugin please add the following setting to your\n*pyproject.toml* file.\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.pylint\"]\n```\n\nBy default, autohooks plugin pylint checks all files with a *.py* ending. If\nonly files in a sub-directory or files with different endings should be\nformatted, just add the following setting:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.pylint\"]\n\n[tool.autohooks.plugins.pylint]\ninclude = ['foo/*.py', '*.foo']\n```\n\nBy default, autohooks plugin pylint executes pylint without any arguments and\npylint settings are loaded from the *.pylintrc* file in the root directory of\ngit repository. To change specific settings or to define a different pylint rc\nfile the following plugin configuration can be used:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.pylint\"]\n\n[tool.autohooks.plugins.pylint]\narguments = [\"--rcfile=/path/to/pylintrc\", \"-s\", \"n\"]\n```\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/autohooks-plugin-pylint/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-pylint/issues)\nfirst.\n\n## License\n\nCopyright (C) 2019 - 2023 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "An autohooks plugin for python code linting via pylint",
    "version": "23.10.0",
    "project_urls": {
        "Homepage": "https://github.com/greenbone/autohooks-plugin-pylint",
        "Repository": "https://github.com/greenbone/autohooks-plugin-pylint"
    },
    "split_keywords": [
        "git",
        "formatting",
        "linting",
        "hooks",
        "pylint"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "494874693c84d9d01296854c5e2c8ce5815eb23f44c361d2977ff45290b7b3b3",
                "md5": "3b8a00fa67da0b28116fc3fec414d8e8",
                "sha256": "49e1e60b81f48ca17d55a6660bff9aae0e9bd8cda2ec6f4ef1237b2f86475682"
            },
            "downloads": -1,
            "filename": "autohooks_plugin_pylint-23.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3b8a00fa67da0b28116fc3fec414d8e8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 17205,
            "upload_time": "2023-10-18T11:33:12",
            "upload_time_iso_8601": "2023-10-18T11:33:12.250944Z",
            "url": "https://files.pythonhosted.org/packages/49/48/74693c84d9d01296854c5e2c8ce5815eb23f44c361d2977ff45290b7b3b3/autohooks_plugin_pylint-23.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "767a3cb38e68fd05a8183b3538513fd3c2252465bc21069e69ba6da5694f3860",
                "md5": "4d3924fa08447cc14e9d3b4badd14965",
                "sha256": "ed2f82ba89d28f772562794734eb37ae630b7a3011526e9cdfc13240865b0359"
            },
            "downloads": -1,
            "filename": "autohooks_plugin_pylint-23.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4d3924fa08447cc14e9d3b4badd14965",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 33451,
            "upload_time": "2023-10-18T11:33:15",
            "upload_time_iso_8601": "2023-10-18T11:33:15.199780Z",
            "url": "https://files.pythonhosted.org/packages/76/7a/3cb38e68fd05a8183b3538513fd3c2252465bc21069e69ba6da5694f3860/autohooks_plugin_pylint-23.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-18 11:33:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "greenbone",
    "github_project": "autohooks-plugin-pylint",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "autohooks-plugin-pylint"
}
Greenbone AG
Elapsed time: 0.18033s