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.
If flake8 is not installed, run:
$ pip install flake8
Finally, to install the latest release of the plugin from the Python Package Index, run:
$ pip install flake8-dashboard
Alternatively, to install the latest development version (master branch), run:
$ pip install git+https://github.com/aperezhortal/flake8-dashboard
Run flake8 with the --format=dashboard
option to create a nice-looking
dashboard.
Options:
--outputdir=<output_dir>
: Directory to save the HTML output ("./flake8_dashboard" by default).--debug
: Write additional debugging information as csv format (flake8 violations and aggregations).--title=<title>
: Set the dashboard's title. No title by default.
Simple usage example:
$ flake8 --format=dashboard --outputdir=flake-report --title="My dashboard"
- 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 .