# pylint-json2checkstyle
A Pylint plugin and command line tool to produce Pylint reports in checkstyle format.
This project is partially inspired from the [pylint-json2html](https://github.com/Exirel/pylint-json2html) project.
[![GitHub license][license-image]][license-url]
[![GitHub-Actions][gh-image]][gh-url]
[![pyversion][pyversion-image]][pyversion-url]
[![pypi][pypi-image]][pypi-url]
[license-image]: https://img.shields.io/badge/license-MIT-lightgrey.svg?maxAge=2592000
[license-url]: https://raw.githubusercontent.com/caarmen/pylint-json2checkstyle/main/LICENSE
[gh-image]: https://img.shields.io/github/actions/workflow/status/caarmen/pylint-json2checkstyle/tests.yml?branch=main
[gh-url]: https://github.com/caarmen/pylint-json2checkstyle/actions/workflows/tests.yml?query=branch%3Amain
[pyversion-image]: https://img.shields.io/pypi/pyversions/pylint-json2checkstyle
[pyversion-url]: https://pypi.org/project/pylint-json2checkstyle/
[pypi-image]: https://img.shields.io/pypi/v/pylint-json2checkstyle.svg?style=flat
[pypi-url]: https://pypi.org/project/pylint-json2checkstyle/
## Usage:
### As a command line tool
```
usage: pylint-json2checkstyle [-h] [-o checkstyle_output_file] [json_input_file]
Convert pylint json report to checkstyle
positional arguments:
json_input_file Pylint JSON report input file (or stdin)
optional arguments:
-h, --help show this help message and exit
-o checkstyle_output_file, --output checkstyle_output_file
Checkstyle report output file (or stdout)
```
### As a Pylint plugin:
```
pylint --load-plugins=pylint_json2checkstyle.checkstyle_reporter --output-format=checkstyle [pylint arguments ... ]
```
## Why?
Checkstyle is a widely supported report format for code issues, with integrations available in CI environments.
For example, the [Checkstyle GitHub Action](https://github.com/jwgmeligmeyling/checkstyle-github-action) reads a checkstyle report and adds
annotations to PRs.
Raw data
{
"_id": null,
"home_page": "https://github.com/caarmen/pylint-json2checkstyle",
"name": "pylint-json2checkstyle",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Carmen Alvarez",
"author_email": "carmen@rmen.ca",
"download_url": "https://files.pythonhosted.org/packages/6a/ff/523122e006d74a8e3b7aef652ab0b4906ca56614c81b3df0df3747c56831/pylint_json2checkstyle-0.0.13.tar.gz",
"platform": null,
"description": "# pylint-json2checkstyle\n\nA Pylint plugin and command line tool to produce Pylint reports in checkstyle format.\n\nThis project is partially inspired from the [pylint-json2html](https://github.com/Exirel/pylint-json2html) project.\n\n[![GitHub license][license-image]][license-url]\n[![GitHub-Actions][gh-image]][gh-url]\n[![pyversion][pyversion-image]][pyversion-url]\n[![pypi][pypi-image]][pypi-url]\n\n[license-image]: https://img.shields.io/badge/license-MIT-lightgrey.svg?maxAge=2592000\n[license-url]: https://raw.githubusercontent.com/caarmen/pylint-json2checkstyle/main/LICENSE\n[gh-image]: https://img.shields.io/github/actions/workflow/status/caarmen/pylint-json2checkstyle/tests.yml?branch=main\n[gh-url]: https://github.com/caarmen/pylint-json2checkstyle/actions/workflows/tests.yml?query=branch%3Amain\n[pyversion-image]: https://img.shields.io/pypi/pyversions/pylint-json2checkstyle\n[pyversion-url]: https://pypi.org/project/pylint-json2checkstyle/\n[pypi-image]: https://img.shields.io/pypi/v/pylint-json2checkstyle.svg?style=flat\n[pypi-url]: https://pypi.org/project/pylint-json2checkstyle/\n\n\n\n## Usage:\n### As a command line tool\n```\nusage: pylint-json2checkstyle [-h] [-o checkstyle_output_file] [json_input_file]\n\nConvert pylint json report to checkstyle\n\npositional arguments:\n json_input_file Pylint JSON report input file (or stdin)\n\noptional arguments:\n -h, --help show this help message and exit\n -o checkstyle_output_file, --output checkstyle_output_file\n Checkstyle report output file (or stdout)\n```\n\n### As a Pylint plugin:\n```\npylint --load-plugins=pylint_json2checkstyle.checkstyle_reporter --output-format=checkstyle [pylint arguments ... ]\n```\n\n## Why?\nCheckstyle is a widely supported report format for code issues, with integrations available in CI environments.\n\nFor example, the [Checkstyle GitHub Action](https://github.com/jwgmeligmeyling/checkstyle-github-action) reads a checkstyle report and adds\nannotations to PRs.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Pylint plugin and command line tool to produce Pylint reports in checkstyle format.",
"version": "0.0.13",
"project_urls": {
"Bug Tracker": "https://github.com/caarmen/pylint-json2checkstyle/issues",
"Homepage": "https://github.com/caarmen/pylint-json2checkstyle",
"Releases": "https://github.com/caarmen/pylint-json2checkstyle/releases"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9c60aa29133acf49220d02d1a33f3b21c77bfcca507ac2ab934149dc1824e6d5",
"md5": "51d0785da38b1aefbd8b3e8b231b3345",
"sha256": "b5f4e21027d2921af0f8debe3cb11b21b2c66f68a06b7677100fe8ece6ccc68b"
},
"downloads": -1,
"filename": "pylint_json2checkstyle-0.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "51d0785da38b1aefbd8b3e8b231b3345",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5175,
"upload_time": "2024-01-20T11:50:35",
"upload_time_iso_8601": "2024-01-20T11:50:35.993385Z",
"url": "https://files.pythonhosted.org/packages/9c/60/aa29133acf49220d02d1a33f3b21c77bfcca507ac2ab934149dc1824e6d5/pylint_json2checkstyle-0.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6aff523122e006d74a8e3b7aef652ab0b4906ca56614c81b3df0df3747c56831",
"md5": "ef317459ba901561965e26ae83f629f0",
"sha256": "e0fa7ee34bb9fb9e6b3ca6abe1fb095de93a6beff74f0a6ec65ac72abae286d5"
},
"downloads": -1,
"filename": "pylint_json2checkstyle-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "ef317459ba901561965e26ae83f629f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5323,
"upload_time": "2024-01-20T11:50:37",
"upload_time_iso_8601": "2024-01-20T11:50:37.571659Z",
"url": "https://files.pythonhosted.org/packages/6a/ff/523122e006d74a8e3b7aef652ab0b4906ca56614c81b3df0df3747c56831/pylint_json2checkstyle-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-20 11:50:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "caarmen",
"github_project": "pylint-json2checkstyle",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "build",
"specs": [
[
"==",
"1.0.3"
]
]
},
{
"name": "pylint",
"specs": [
[
"==",
"3.0.3"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"7.4.4"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"4.0.2"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.9.0"
]
]
}
],
"lcname": "pylint-json2checkstyle"
}
JSON
