Metadata-Version: 2.2
Name: pylint_report
Version: 2.4.2
Summary: Generates an html report summarizing the results of pylint.
Author-email: Dimitar Dimitrov <mail.mitko@gmail.com>
License: Apache 2.0
Project-URL: homepage, https://github.com/drdv/pylint-report
Project-URL: documentation, https://drdv.github.io/pylint-report
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Requires-Dist: pylint
Requires-Dist: Jinja2
Requires-Dist: pandas
Requires-Dist: argcomplete
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest-reportlog; extra == "test"
Requires-Dist: pytest-html; extra == "test"
Provides-Extra: docs
Requires-Dist: Sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: sphinxcontrib-jsmath; extra == "docs"
Requires-Dist: sphinxcontrib-websupport; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-inline-tabs; extra == "docs"
Requires-Dist: sphinx-argparse; extra == "docs"
Requires-Dist: furo; extra == "docs"
Provides-Extra: code
Requires-Dist: black; extra == "code"
Requires-Dist: isort; extra == "code"
Requires-Dist: pre-commit; extra == "code"
Provides-Extra: dev
Requires-Dist: pylint_report[code,docs,test]; extra == "dev"

pylint-report
==============

Generates an HTML report summarizing the results of `pylint <https://www.pylint.org/>`_
(see `documentation <https://drdv.github.io/pylint-report>`_).

Installation
-------------

The recommended way to install ``pylint-report`` is using

.. code-block:: bash

   pip install pylint-report

or, for a development version (with all optional dependencies):

.. code-block:: bash

   pip install pylint-report[dev]

Quickstart
===========

Place the following in ``.pylintrc``

.. code-block:: shell

   [MASTER]
   load-plugins=pylint_report

   [REPORTS]
   output-format=pylint_report.CustomJsonReporter

or place the following in ``pyproject.toml``

.. code-block:: toml

   [tool.pylint.MASTER]
   load-plugins = "pylint_report"

   [tool.pylint.REPORTS]
   output-format = "pylint_report.CustomJsonReporter"

or manually pass the ``--load-plugins`` and ``--output-format`` flags.

* A two-step approach:

  + ``pylint path/to/code > report.json``: generate a (custom) ``json`` file using ``pylint``

  + ``pylint_report.py report.json -o report.html``: generate html report

* Or alternatively ``pylint path/to/code | pylint_report > report.html``

Based on
---------

* https://github.com/Exirel/pylint-json2html
* https://stackoverflow.com/a/57511754
