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 .
Metadata
Release files for flake8-dashboard 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flake8_dashboard-0.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Release files / flake8_dashboard-0.1.4-py3-none-any.whl
| Download URL | flake8_dashboard-0.1.4-py3-none-any.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
92f38c0e25adee170202204b498a0feeb2124b791e3a78bb51eca3bdbb550374
|
|
BLAKE2b-256 checksum How to use checksums |
cfedae6c544b88e955ed90ab7caacd6c9552e826578cccefc5a7bf7cd68c3030
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.6
|