pylint-json2checkstyle

A Pylint plugin and command line tool to produce Pylint reports in checkstyle format.


Keywords
pylint-plugin, python
License
MIT
Install
pip install pylint-json2checkstyle==0.0.13

Documentation

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 project.

GitHub license GitHub-Actions pyversion pypi

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 reads a checkstyle report and adds annotations to PRs.