https://github.com/aperezhortal/flake8-dashboard

A flake8 plugin to generate an HTML dashboard with a report of the flake8 violations found.
https://github.com/aperezhortal/flake8-dashboard

dashboard flake8 html plugin

Last synced: 3 months ago
JSON representation

A flake8 plugin to generate an HTML dashboard with a report of the flake8 violations found.

• Host: GitHub
• URL: https://github.com/aperezhortal/flake8-dashboard
• Owner: aperezhortal
• License: other
• Created: 2019-09-10T17:53:07.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-05T17:27:22.000Z (10 months ago)
• Last Synced: 2024-07-12T11:10:43.002Z (4 months ago)
• Topics: dashboard, flake8, html, plugin
• Language: CSS
• Homepage:
• Size: 1.1 MB
• Stars: 13
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

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

README

        
================

flake8-dashboard

================

A flake8 plugin to generate a responsive HTML dashboard summarizing all the flake8 violations.

The resulting dashboard has an easy-to-read format across a variety of devices and web

browsers.

Installation

============

If flake8 is not installed, run:

.. code-block:: bash

   $ pip install flake8

Finally, to install the latest release of the plugin from the

Python Package Index, run:

.. code-block:: bash

   $ pip install flake8-dashboard

Alternatively, to install the latest development version (master branch), run:

.. code-block:: bash

   $ pip install git+https://github.com/aperezhortal/flake8-dashboard

Usage

=====

Run flake8 with the ``--format=dashboard`` option to create a nice-looking

dashboard.

Options:

- ``--outputdir=``: Directory to save the HTML output

  ("./flake8_dashboard" by default).

- ``--debug``: Write additional debugging information as csv format

  (flake8 violations and aggregations).

- ``--title=``: Set the dashboard's title. No title by default.

Simple usage example:

.. code-block:: bash

   $ flake8 --format=dashboard --outputdir=flake-report --title="My dashboard"

Demo

~~~~

`Check a demo here! `_

Credits

=======

- This package was created using the `flake8-html`_ package as a template.

- The dashboard html page was created using the

  `light-bootstrap-dashboard`_ template by `Creative Tim`_.

- The interactive plots are created using `Plotly Python`_ .

.. _light-bootstrap-dashboard: https://demos.creative-tim.com/light-bootstrap-dashboard/

.. _`Creative Tim`: https://www.creative-tim.com/

.. _`Plotly Python`: https://plot.ly/python/

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