Generate different reports of flake8 violations
Project description
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:
$ 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
Usage
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"
Demo
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 .
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for flake8_dashboard-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92f38c0e25adee170202204b498a0feeb2124b791e3a78bb51eca3bdbb550374 |
|
MD5 | e923935efc97be54cf2f96f1cb588b3d |
|
BLAKE2b-256 | cfedae6c544b88e955ed90ab7caacd6c9552e826578cccefc5a7bf7cd68c3030 |