invoke-plugin-for-pylint


Nameinvoke-plugin-for-pylint JSON
Version 3.0.0 PyPI version JSON
download
home_page
SummaryPylint plugin which disables checks for proper integration with invoke
upload_time2023-10-17 08:12:09
maintainer
docs_urlNone
author
requires_python<4,>=3.8
licenseApache-2.0
keywords pylint invoke plugin inv linter
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![REUSE status](https://api.reuse.software/badge/github.com/SAP/invoke-plugin-for-pylint)](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-pylint)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![PyPI version](https://badge.fury.io/py/invoke-plugin-for-pylint.svg)](https://badge.fury.io/py/invoke-plugin-for-pylint)

# Invoke Plugin for Pylint
This is a plugin for pylint which disables certain checks when using invoke.

## Installation
`pip install invoke-plugin-for-pylint`, that's it.

## Usage
Add `invoke_plugin_for_pylint` to the list of pylint plugins.

## Disabled check

* unused-argument: Each invoke task needs a context argument even if not needed.
  Therefore this plugin will find all tasks and suppress all `unused-argument` errors when related to the context argument


## Configuration

If custom decorators for invoke tasks are used which wrap `invoke.task` the
`additional-invoke-task-decorators` option by checker `invoke-plugin-for-pylint` can be used.
It's a csv list of names which indicate an invoke task.

Please note, that the names must be full qualified and reflect the name of the final function.
For example, a decorator factory called "foo" in package "bar" which returns a function called
"_inner", will result in the name "bar.foo._inner".

Example for the pyproject.toml:

```toml
[tool.pylint.invoke-plugin-for-pylint]
additional-invoke-task-decorators = [
    "my_package.foo.make_task._inner",
    "my_package.foo.make_other_task",
]
```

## Build and Publish

This project uses `setuptools` as the dependency management and build tool.
To publish a new release, follow these steps:
* Update the version in the `pyproject.toml`
* Add an entry in the changelog
* Push a new tag like `vX.X.X` to trigger the release

## Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/invoke-plugin-for-pylint/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).

## Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.

## Licensing

Copyright 2023 SAP SE or an SAP affiliate company and invoke-plugin-for-pylint contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-pylint).

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "invoke-plugin-for-pylint",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<4,>=3.8",
    "maintainer_email": "",
    "keywords": "pylint,invoke,plugin,inv,linter",
    "author": "",
    "author_email": "Kai Mueller <kai.mueller01@sap.com>",
    "download_url": "https://files.pythonhosted.org/packages/b6/39/1896921833d4734f4008173e8da0354f5637dea226533790659397737d90/invoke-plugin-for-pylint-3.0.0.tar.gz",
    "platform": null,
    "description": "[![REUSE status](https://api.reuse.software/badge/github.com/SAP/invoke-plugin-for-pylint)](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-pylint)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![PyPI version](https://badge.fury.io/py/invoke-plugin-for-pylint.svg)](https://badge.fury.io/py/invoke-plugin-for-pylint)\n\n# Invoke Plugin for Pylint\nThis is a plugin for pylint which disables certain checks when using invoke.\n\n## Installation\n`pip install invoke-plugin-for-pylint`, that's it.\n\n## Usage\nAdd `invoke_plugin_for_pylint` to the list of pylint plugins.\n\n## Disabled check\n\n* unused-argument: Each invoke task needs a context argument even if not needed.\n  Therefore this plugin will find all tasks and suppress all `unused-argument` errors when related to the context argument\n\n\n## Configuration\n\nIf custom decorators for invoke tasks are used which wrap `invoke.task` the\n`additional-invoke-task-decorators` option by checker `invoke-plugin-for-pylint` can be used.\nIt's a csv list of names which indicate an invoke task.\n\nPlease note, that the names must be full qualified and reflect the name of the final function.\nFor example, a decorator factory called \"foo\" in package \"bar\" which returns a function called\n\"_inner\", will result in the name \"bar.foo._inner\".\n\nExample for the pyproject.toml:\n\n```toml\n[tool.pylint.invoke-plugin-for-pylint]\nadditional-invoke-task-decorators = [\n    \"my_package.foo.make_task._inner\",\n    \"my_package.foo.make_other_task\",\n]\n```\n\n## Build and Publish\n\nThis project uses `setuptools` as the dependency management and build tool.\nTo publish a new release, follow these steps:\n* Update the version in the `pyproject.toml`\n* Add an entry in the changelog\n* Push a new tag like `vX.X.X` to trigger the release\n\n## Support, Feedback, Contributing\n\nThis project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/invoke-plugin-for-pylint/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).\n\n## Code of Conduct\n\nWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.\n\n## Licensing\n\nCopyright 2023 SAP SE or an SAP affiliate company and invoke-plugin-for-pylint contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-pylint).\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Pylint plugin which disables checks for proper integration with invoke",
    "version": "3.0.0",
    "project_urls": {
        "Changelog": "https://github.com/SAP/invoke-plugin-for-pylint/blob/main/CHANGELOG.md",
        "Issue Tracker": "https://github.com/SAP/invoke-plugin-for-pylint/issues"
    },
    "split_keywords": [
        "pylint",
        "invoke",
        "plugin",
        "inv",
        "linter"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "406b6bf24f653a4e262e2d484a9d6e0ebe4793957c32b4c8dbc34469e621cd8f",
                "md5": "ab8eaf7d8babf52f2dc5727f2eca4c85",
                "sha256": "0e38c22a0a0f44166b7d126c6c8a61f45b1839c669f0e1882d38f357245295a7"
            },
            "downloads": -1,
            "filename": "invoke_plugin_for_pylint-3.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ab8eaf7d8babf52f2dc5727f2eca4c85",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 8530,
            "upload_time": "2023-10-17T08:12:08",
            "upload_time_iso_8601": "2023-10-17T08:12:08.416224Z",
            "url": "https://files.pythonhosted.org/packages/40/6b/6bf24f653a4e262e2d484a9d6e0ebe4793957c32b4c8dbc34469e621cd8f/invoke_plugin_for_pylint-3.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b6391896921833d4734f4008173e8da0354f5637dea226533790659397737d90",
                "md5": "2054e59deabf7a0c230a18fb2701fda3",
                "sha256": "32ff30874dac01b8c1c31daf3eb10d2ce64eb0ba042b3de1b20bd0059d626613"
            },
            "downloads": -1,
            "filename": "invoke-plugin-for-pylint-3.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2054e59deabf7a0c230a18fb2701fda3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 9360,
            "upload_time": "2023-10-17T08:12:09",
            "upload_time_iso_8601": "2023-10-17T08:12:09.910654Z",
            "url": "https://files.pythonhosted.org/packages/b6/39/1896921833d4734f4008173e8da0354f5637dea226533790659397737d90/invoke-plugin-for-pylint-3.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-17 08:12:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SAP",
    "github_project": "invoke-plugin-for-pylint",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "invoke-plugin-for-pylint"
}
Elapsed time: 0.12178s