https://github.com/lordmauve/flake8-html

Generate HTML reports of flake8 violations
https://github.com/lordmauve/flake8-html

flake8-plugin linting python

Last synced: 1 day ago
JSON representation

Generate HTML reports of flake8 violations

• Host: GitHub
• URL: https://github.com/lordmauve/flake8-html
• Owner: lordmauve
• License: other
• Created: 2017-03-01T19:23:04.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T20:32:02.000Z (11 days ago)
• Last Synced: 2024-10-28T21:29:05.966Z (11 days ago)
• Topics: flake8-plugin, linting, python
• Language: Python
• Size: 175 KB
• Stars: 52
• Watchers: 4
• Forks: 17
• Open Issues: 11
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• awesome-flake8-extensions - flake8-html - Generates an HTML report. (Formatters)

README

        
===========

flake8-html

===========

.. image:: https://img.shields.io/pypi/v/flake8-html.svg

        :target: https://pypi.python.org/pypi/flake8-html

.. image:: https://img.shields.io/travis/lordmauve/flake8-html.svg

        :target: https://travis-ci.org/lordmauve/flake8-html

.. image:: https://pyup.io/repos/github/lordmauve/flake8-html/shield.svg

     :target: https://pyup.io/repos/github/lordmauve/flake8-html/

     :alt: Updates

A flake8 plugin to generate HTML reports of flake8 violations.

Simply

.. code-block:: bash

   $ pip install flake8-html

Then run flake8 passing the ``--format=html`` option and a ``--htmldir``:

.. code-block:: bash

   $ flake8 --format=html --htmldir=flake-report

Screenshots

-----------

Report index page:

.. image:: https://github.com/lordmauve/flake8-html

           /raw/master/screenshots/report-index.png

Per-file report, grouped by error code:

.. image:: https://github.com/lordmauve/flake8-html

           /raw/master/screenshots/file-report.png

Annotated, syntax-highlighed source code:

.. image:: https://github.com/lordmauve/flake8-html

           /raw/master/screenshots/annotated-source.png

License

-------

* Free software: Apache Software License 2.0

Credits

-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage