# Pylint plugin for GitHub Actions annotations
This is a plugin for [Pylint](https://www.pylint.org/) that allows it to output annotations
in the format that GitHub Actions understands.
See annotations from [examples](https://github.com/skhomuti/pylint-actions/actions/workflows/example.yml) workflows.
Also these annotations will be displayed in your pull requests changes
# Installation
So simple:
```bash
pip install pylint-actions
```
# Usage
Add the following to your `pyproject.toml` file:
```toml
[tool.pylint.main]
load-plugins = "pylint_actions"
```
Or load the plugin with any available pylint configuration variants except command line arguments.
Next, run pylint with the `--output-format=actions` option, or shorted `-f actions`.
In your GitHub Actions workflow, use it like this:
```yaml
- name: Run pylint
run: poetry run pylint -f actions src
```
Raw data
{
"_id": null,
"home_page": "https://github.com/skhomuti/pylint-actions",
"name": "pylint-actions",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "pylint,github,actions,linter,static code analysis,python",
"author": "skhomuti",
"author_email": "skhomuti@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/18/9b/5760b3076b91ea2d9926cf78b10c586f15eefdf7ccbb009b2ec31af9aa59/pylint_actions-0.5.0.tar.gz",
"platform": null,
"description": "# Pylint plugin for GitHub Actions annotations\nThis is a plugin for [Pylint](https://www.pylint.org/) that allows it to output annotations \nin the format that GitHub Actions understands. \nSee annotations from [examples](https://github.com/skhomuti/pylint-actions/actions/workflows/example.yml) workflows.\nAlso these annotations will be displayed in your pull requests changes\n\n# Installation\nSo simple:\n```bash\npip install pylint-actions\n```\n\n# Usage\nAdd the following to your `pyproject.toml` file:\n```toml\n[tool.pylint.main]\nload-plugins = \"pylint_actions\"\n```\nOr load the plugin with any available pylint configuration variants except command line arguments.\n\nNext, run pylint with the `--output-format=actions` option, or shorted `-f actions`.\n\nIn your GitHub Actions workflow, use it like this:\n```yaml\n- name: Run pylint\n run: poetry run pylint -f actions src\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pylint plugin for GitHub Actions",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/skhomuti/pylint-actions",
"Repository": "https://github.com/skhomuti/pylint-actions"
},
"split_keywords": [
"pylint",
"github",
"actions",
"linter",
"static code analysis",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8cd16c93ae88bf4d2cfb210ffa5b8dd96dc765fd32f510a0956656632bea8106",
"md5": "6d947a36c289b75a054398a190e6ece8",
"sha256": "9a9922ae55c9afb56f602ef2434a6ea984c16504a159d6e4c439e71d325a0bfb"
},
"downloads": -1,
"filename": "pylint_actions-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d947a36c289b75a054398a190e6ece8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3152,
"upload_time": "2024-01-16T12:19:04",
"upload_time_iso_8601": "2024-01-16T12:19:04.034599Z",
"url": "https://files.pythonhosted.org/packages/8c/d1/6c93ae88bf4d2cfb210ffa5b8dd96dc765fd32f510a0956656632bea8106/pylint_actions-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "189b5760b3076b91ea2d9926cf78b10c586f15eefdf7ccbb009b2ec31af9aa59",
"md5": "a2a8bac54e38b346cb5b6837486fefdc",
"sha256": "0ed9c6959226a335a6d0ae85943649f0ab88f6bfd3d3ee75b4fd85eac884f1d3"
},
"downloads": -1,
"filename": "pylint_actions-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "a2a8bac54e38b346cb5b6837486fefdc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 2678,
"upload_time": "2024-01-16T12:19:05",
"upload_time_iso_8601": "2024-01-16T12:19:05.606728Z",
"url": "https://files.pythonhosted.org/packages/18/9b/5760b3076b91ea2d9926cf78b10c586f15eefdf7ccbb009b2ec31af9aa59/pylint_actions-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-16 12:19:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "skhomuti",
"github_project": "pylint-actions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pylint-actions"
}
JSON
