flake8-html


Nameflake8-html JSON
Version 0.4.3 PyPI version JSON
download
home_pagehttps://github.com/lordmauve/flake8-html
SummaryGenerate HTML reports of flake8 violations
upload_time2022-12-06 19:06:20
maintainer
docs_urlNone
authorDaniel Pope
requires_python
licenseApache Software License 2.0
keywords flake8 html
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===========
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
-------

* Free software: Apache Software License 2.0

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



=======
History
=======

0.4.2 (2022-04-13)
------------------

* Fix compatibility with Python 3.9+


0.4.1 (2020-05-13)
------------------

* Fix: add compatibility with flake8 3.8.*

0.4.0 (2017-07-06)
------------------

* New: Add ``--htmlpep8`` option to produce normal flake8 console output
* Fix: Allow all ``flake8-html`` settings to be read from flake8 config


0.3.0 (2017-05-24)
------------------

* New: Add ``--htmltitle`` option to set page title


0.2.0 (2017-03-06)
------------------

* New: use SVG icons instead of Unicode characters
* New: deduplicate the same error on the same line


0.1.1 (2017-03-02)
------------------

* Fix: missing templates in sdist.


0.1.0 (2017-03-01)
------------------

* First release on PyPI.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/lordmauve/flake8-html",
    "name": "flake8-html",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "flake8 html",
    "author": "Daniel Pope",
    "author_email": "mauve@mauveweb.co.uk",
    "download_url": "https://files.pythonhosted.org/packages/3e/44/faae17d4b4e00c8c041e9b90b0ea546f3aef8b799212e71a7bb835ff51e1/flake8-html-0.4.3.tar.gz",
    "platform": null,
    "description": "===========\nflake8-html\n===========\n\n\n.. image:: https://img.shields.io/pypi/v/flake8-html.svg\n        :target: https://pypi.python.org/pypi/flake8-html\n\n.. image:: https://img.shields.io/travis/lordmauve/flake8-html.svg\n        :target: https://travis-ci.org/lordmauve/flake8-html\n\n.. image:: https://pyup.io/repos/github/lordmauve/flake8-html/shield.svg\n     :target: https://pyup.io/repos/github/lordmauve/flake8-html/\n     :alt: Updates\n\n\nA flake8 plugin to generate HTML reports of flake8 violations.\n\nSimply\n\n.. code-block:: bash\n\n   $ pip install flake8-html\n\nThen run flake8 passing the ``--format=html`` option and a ``--htmldir``:\n\n.. code-block:: bash\n\n   $ flake8 --format=html --htmldir=flake-report\n\n\nScreenshots\n-----------\n\nReport index page:\n\n.. image:: https://github.com/lordmauve/flake8-html\n           /raw/master/screenshots/report-index.png\n\nPer-file report, grouped by error code:\n\n.. image:: https://github.com/lordmauve/flake8-html\n           /raw/master/screenshots/file-report.png\n\nAnnotated, syntax-highlighed source code:\n\n.. image:: https://github.com/lordmauve/flake8-html\n           /raw/master/screenshots/annotated-source.png\n\n\nLicense\n-------\n\n* Free software: Apache Software License 2.0\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n\n=======\nHistory\n=======\n\n0.4.2 (2022-04-13)\n------------------\n\n* Fix compatibility with Python 3.9+\n\n\n0.4.1 (2020-05-13)\n------------------\n\n* Fix: add compatibility with flake8 3.8.*\n\n0.4.0 (2017-07-06)\n------------------\n\n* New: Add ``--htmlpep8`` option to produce normal flake8 console output\n* Fix: Allow all ``flake8-html`` settings to be read from flake8 config\n\n\n0.3.0 (2017-05-24)\n------------------\n\n* New: Add ``--htmltitle`` option to set page title\n\n\n0.2.0 (2017-03-06)\n------------------\n\n* New: use SVG icons instead of Unicode characters\n* New: deduplicate the same error on the same line\n\n\n0.1.1 (2017-03-02)\n------------------\n\n* Fix: missing templates in sdist.\n\n\n0.1.0 (2017-03-01)\n------------------\n\n* First release on PyPI.\n\n\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "Generate HTML reports of flake8 violations",
    "version": "0.4.3",
    "split_keywords": [
        "flake8",
        "html"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "08b28489e1491261d5945d73fbd15762",
                "sha256": "8f126748b1b0edd6cd39e87c6192df56e2f8655b0aa2bb00ffeac8cf27be4325"
            },
            "downloads": -1,
            "filename": "flake8_html-0.4.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "08b28489e1491261d5945d73fbd15762",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 13120,
            "upload_time": "2022-12-06T19:06:18",
            "upload_time_iso_8601": "2022-12-06T19:06:18.917797Z",
            "url": "https://files.pythonhosted.org/packages/c3/b0/bfd58118e2b9c1d0c5ac156c458c9a33cb599925b658df3ab038b55d30d7/flake8_html-0.4.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d8286e8c7706275b78e68fa76b023a2c",
                "sha256": "8b870299620cc4a06f73644a1b4d457799abeca1cc914c62ae71ec5bf65c79a5"
            },
            "downloads": -1,
            "filename": "flake8-html-0.4.3.tar.gz",
            "has_sig": false,
            "md5_digest": "d8286e8c7706275b78e68fa76b023a2c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13670,
            "upload_time": "2022-12-06T19:06:20",
            "upload_time_iso_8601": "2022-12-06T19:06:20.505797Z",
            "url": "https://files.pythonhosted.org/packages/3e/44/faae17d4b4e00c8c041e9b90b0ea546f3aef8b799212e71a7bb835ff51e1/flake8-html-0.4.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-06 19:06:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "lordmauve",
    "github_project": "flake8-html",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "flake8-html"
}
        
Elapsed time: 0.04600s