| Name | invoke-plugin-for-pylint JSON |
| Version |
5.0.0
JSON |
| download |
| home_page | None |
| Summary | Pylint plugin which disables checks for proper integration with invoke |
| upload_time | 2025-10-13 08:32:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.10 |
| license | None |
| keywords |
pylint
invoke
plugin
inv
linter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-pylint)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://badge.fury.io/py/invoke-plugin-for-pylint)
[](https://coveralls.io/github/SAP/invoke-plugin-for-pylint?branch=coveralls)
# 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",
]
```
## Development
This project uses `uv`.
To setup a venv for development use
`python3.14 -m venv venv && pip install uv && uv sync --all-groups && rm -rf venv/`.
Then use `source .venv/bin/activate` to activate your venv.
## 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 2025 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": null,
"name": "invoke-plugin-for-pylint",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": null,
"keywords": "pylint, invoke, plugin, inv, linter",
"author": null,
"author_email": "Kai Harder <kai.harder@sap.com>",
"download_url": "https://files.pythonhosted.org/packages/28/2a/3418f3938fd3f7938897ee3a2b07eb67130c98dec84dc19ef2a082c8ecff/invoke_plugin_for_pylint-5.0.0.tar.gz",
"platform": null,
"description": "[](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-pylint)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n[](https://badge.fury.io/py/invoke-plugin-for-pylint)\n[](https://coveralls.io/github/SAP/invoke-plugin-for-pylint?branch=coveralls)\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## Development\nThis project uses `uv`.\nTo setup a venv for development use\n`python3.14 -m venv venv && pip install uv && uv sync --all-groups && rm -rf venv/`.\nThen use `source .venv/bin/activate` to activate your venv.\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 2025 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": null,
"summary": "Pylint plugin which disables checks for proper integration with invoke",
"version": "5.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": null,
"digests": {
"blake2b_256": "ff5371ed48a11baac77674ac32997186d4c540549ff4f4ca15c01323862526a2",
"md5": "71cfb04309b5bb77ccd47203fd1058ff",
"sha256": "10c6749750c968ee3de21a4c944b00c56cec07957a857d68dfc52ed78ee33580"
},
"downloads": -1,
"filename": "invoke_plugin_for_pylint-5.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71cfb04309b5bb77ccd47203fd1058ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 8508,
"upload_time": "2025-10-13T08:32:08",
"upload_time_iso_8601": "2025-10-13T08:32:08.331724Z",
"url": "https://files.pythonhosted.org/packages/ff/53/71ed48a11baac77674ac32997186d4c540549ff4f4ca15c01323862526a2/invoke_plugin_for_pylint-5.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "282a3418f3938fd3f7938897ee3a2b07eb67130c98dec84dc19ef2a082c8ecff",
"md5": "d324b6723f9c00ed8b1658c88a881c2a",
"sha256": "b53a2a1971ce988448a3d1e16c6beac3208fcd85e697761af5834d848e782740"
},
"downloads": -1,
"filename": "invoke_plugin_for_pylint-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d324b6723f9c00ed8b1658c88a881c2a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 9742,
"upload_time": "2025-10-13T08:32:09",
"upload_time_iso_8601": "2025-10-13T08:32:09.598252Z",
"url": "https://files.pythonhosted.org/packages/28/2a/3418f3938fd3f7938897ee3a2b07eb67130c98dec84dc19ef2a082c8ecff/invoke_plugin_for_pylint-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-13 08:32: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"
}
