{ "info": { "author": "Florian Strzelecki", "author_email": "florian.strzelecki@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)", "Operating System :: OS Independent", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Software Development :: Quality Assurance" ], "description": "# pylint-json2html\n\nA pylint JSON report file to HTML: pylint is used to generate a JSON report,\nand this tool will transform this report into an HTML document:\n\n usage: pylint-json2html [-h] [-o FILENAME] [-f FORMAT] [FILENAME]\n\n Transform Pylint JSON report to HTML\n\n positional arguments:\n FILENAME Pylint JSON report input file (or stdin)\n\n optional arguments:\n -h, --help show this help message and exit\n -o FILENAME, --output FILENAME\n Pylint HTML report output file (or stdout)\n -f FORMAT, --input-format FORMAT\n Pylint JSON Report input type (json or jsonextended)\n\n## Why?\n\nSince its [1.7 version](https://pylint.readthedocs.io/en/latest/whatsnew/1.7.html#removed-changes),\nPylint does not provide an HTML output format. The release notes say that:\n\n> It was lately a second class citizen in Pylint, being mostly neglected.\n> Since we now have the JSON reporter, it can be used as a basis for building\n> more prettier HTML reports than what Pylint can currently generate.\n> This is part of the effort of removing cruft from Pylint, by removing less\n> used features.\n\nAnd I agree with that statements. Few people use the HTML reports, and pylint\nis getting old. Its core features are complex and they require a lot of times\nand efforts - and I am thankful for that software to exist in the first place!\n\nSo here it is: a plugin to fulfill my own needs. I share it as open-source\nbecause why not?\n\n## Installation\n\nTo install this tool, use pip:\n\n (venv) $ pip install pylint-json2html\n\nYou can always download the sources from the github repository, and use the\n`setup.py` file to `install` or `develop`, but I would not recommend that\nunless you plan to contribute to this small project of mine.\n\n##\u00a0Usage\n\nMy favorite way of using `pylint` and `pylint-json2html` is this one:\n\n (venv) $ pylint my_package | pylint-json2html -o pylint.html\n\nProvided that you configure your Pylint config file with:\n\n [REPORTS]\n output-format=json\n\nBut you can generate first a JSON file, then use `pylint-json2html` to read it:\n\n (venv) $ pylint your_package > pylint.json\n (venv) $ pylint-json2html -o pylint.html pylint.json\n\nYou can also redirect `pylint-json2html`'s stdout:\n\n (venv) $ pylint-json2html pylint.json > pylint.html\n\n##\u00a0Extended Report\n\nActually, I lied about my favorite way, it is this one:\n\n (venv) $ pylint my_package | pylint-json2html -f jsonextended -o pylint.html\n\nWith this Pylint configuration:\n\n [MASTER]\n load-plugins=pylint_json2html\n\n [REPORTS]\n output-format=jsonextended\n\nThe `pylint_json2html` is a Pylint plugin that adds a new output format:\n`jsonextended`. By default, the `json` format contains only a list of messages,\nand this new format contains also metrics, such the number of analysed\nstatements, or the list of dependencies.\n\nThe configuration above can be tested using the command line instead:\n\n (venv) $ pylint --load-plugins=pylint_json2html --output-format=jsonextended your_package > pylint.json\n\nThen, you will be able to use the JSON extended report to generate an HTML\nreport:\n\n (venv) $ pylint-json2html -f jsonextended -o pylint.html > pylint.json\n\nAnd voil\u00e0!\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Exirel/pylint-json2html", "keywords": "pylint report quality", "license": "MPL-2.0", "maintainer": "", "maintainer_email": "", "name": "pylint-json2html", "package_url": "https://pypi.org/project/pylint-json2html/", "platform": "", "project_url": "https://pypi.org/project/pylint-json2html/", "project_urls": { "Homepage": "https://github.com/Exirel/pylint-json2html" }, "release_url": "https://pypi.org/project/pylint-json2html/0.1.0/", "requires_dist": [ "pylint", "Jinja2" ], "requires_python": "", "summary": "Pylint JSON report to HTML", "version": "0.1.0" }, "last_serial": 3785166, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "0f3b66c9fe6983a76a2d724af87543c6", "sha256": "b6965ba96f5fe4981f74e70b41c0a98fa635addce3ea45d6db9a9983a0c00aa3" }, "downloads": -1, "filename": "pylint_json2html-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "0f3b66c9fe6983a76a2d724af87543c6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7329, "upload_time": "2018-04-20T16:47:31", "url": "https://files.pythonhosted.org/packages/77/14/07f8b354845663eb35287c3eaa139f2232dc6bd49a6cb48fcbf8e6ed1ee1/pylint_json2html-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e01f8a78e589a1c661a194590c746e71", "sha256": "a782422abeee0985ce4381c7e00e2621511d2eda054b133772c5d6579fc1ae5d" }, "downloads": -1, "filename": "pylint-json2html-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e01f8a78e589a1c661a194590c746e71", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11462, "upload_time": "2018-04-20T16:47:32", "url": "https://files.pythonhosted.org/packages/b0/07/94c291904fcdd8a5cb133dcf475489304d471a3e4d6fcd6d19582b8fbfb8/pylint-json2html-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0f3b66c9fe6983a76a2d724af87543c6", "sha256": "b6965ba96f5fe4981f74e70b41c0a98fa635addce3ea45d6db9a9983a0c00aa3" }, "downloads": -1, "filename": "pylint_json2html-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "0f3b66c9fe6983a76a2d724af87543c6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7329, "upload_time": "2018-04-20T16:47:31", "url": "https://files.pythonhosted.org/packages/77/14/07f8b354845663eb35287c3eaa139f2232dc6bd49a6cb48fcbf8e6ed1ee1/pylint_json2html-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e01f8a78e589a1c661a194590c746e71", "sha256": "a782422abeee0985ce4381c7e00e2621511d2eda054b133772c5d6579fc1ae5d" }, "downloads": -1, "filename": "pylint-json2html-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e01f8a78e589a1c661a194590c746e71", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11462, "upload_time": "2018-04-20T16:47:32", "url": "https://files.pythonhosted.org/packages/b0/07/94c291904fcdd8a5cb133dcf475489304d471a3e4d6fcd6d19582b8fbfb8/pylint-json2html-0.1.0.tar.gz" } ] }