Skip to main content

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

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pylint_json2checkstyle-0.0.10.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

pylint_json2checkstyle-0.0.10-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page