# 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-Actions][gh-image]][gh-url]
[![pyversion][pyversion-image]][pyversion-url]
[![pypi][pypi-image]][pypi-url]
[gh-image]: https://github.com/caarmen/pylint-json2checkstyle/actions/workflows/tests.yml/badge.svg
[gh-url]: https://github.com/caarmen/pylint-json2checkstyle/actions?query=workflow%3A%22Run+tests%22++
[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/07/e7/895edcf1fe17c8f805d4a4d46139b629838542a2563a89122db5dd2683c2/pylint_json2checkstyle-0.0.10.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-Actions][gh-image]][gh-url]\n[![pyversion][pyversion-image]][pyversion-url]\n[![pypi][pypi-image]][pypi-url]\n\n[gh-image]: https://github.com/caarmen/pylint-json2checkstyle/actions/workflows/tests.yml/badge.svg\n[gh-url]: https://github.com/caarmen/pylint-json2checkstyle/actions?query=workflow%3A%22Run+tests%22++\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.10",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "87053c63127728238a909c3ea56b0a92",
"sha256": "f9715474798a939853864cf21e5b24124eb1897be49a25388b775d6a00b1c655"
},
"downloads": -1,
"filename": "pylint_json2checkstyle-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87053c63127728238a909c3ea56b0a92",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5085,
"upload_time": "2022-05-22T12:32:37",
"upload_time_iso_8601": "2022-05-22T12:32:37.208255Z",
"url": "https://files.pythonhosted.org/packages/ab/9d/791b7d1635fad078e8e790a20a2e67f934c7824115ba64a420fd1091d5f2/pylint_json2checkstyle-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "09d58ee2915101536651caec3519b805",
"sha256": "c2741aaa96d83c918c00a561ab0daa730679a77b4eea98e90a6c597c2b82c9ae"
},
"downloads": -1,
"filename": "pylint_json2checkstyle-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "09d58ee2915101536651caec3519b805",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4482,
"upload_time": "2022-05-22T12:32:39",
"upload_time_iso_8601": "2022-05-22T12:32:39.227496Z",
"url": "https://files.pythonhosted.org/packages/07/e7/895edcf1fe17c8f805d4a4d46139b629838542a2563a89122db5dd2683c2/pylint_json2checkstyle-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-05-22 12:32:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "caarmen",
"github_project": "pylint-json2checkstyle",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pylint-json2checkstyle"
}
JSON
