search

lordmauve / flake8-html

Generate HTML reports of flake8 violations
Other
51 stars 17 forks source link
flake8-plugin linting python

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

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