{ "info": { "author": "Dorian Lefeuvre", "author_email": "contact@dloeuf.fr", "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================\n\nA pylint JSON report file to HTML: pylint is used to generate a JSON\nreport, and this tool will transform this report into an HTML document:\n\n::\n\n usage: pylint-json2html [-h] [-o FILENAME] [-f FORMAT] [-t FILENAME] [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 Pylint HTML report output file (or stdout)\n -f FORMAT, --input-format FORMAT Pylint JSON Report input type (json or jsonextended)\n -t FILENAME, --template FILENAME Custom Template to use to generate report \n\nWhy?\n----\n\nSince its `1.7\nversion `__,\nPylint does not provide an HTML output format. The release notes say\nthat:\n\n It was lately a second class citizen in Pylint, being mostly\n neglected. Since we now have the JSON reporter, it can be used as a\n basis for building more prettier HTML reports than what Pylint can\n currently generate. This is part of the effort of removing cruft\n from Pylint, by removing less used features.\n\nAnd I agree with that statements. Few people use the HTML reports, and\npylint is getting old. Its core features are complex and they require a\nlot of times and efforts - and I am thankful for that software to exist\nin the first place!\n\nSo here it is: a plugin to fulfill my own needs. I share it as\nopen-source because why not?\n\nInstallation\n------------\n\nTo install this tool, use pip:\n\n::\n\n (venv) $ pip install pylint-json2html\n\nYou can always download the sources from the github repository, and use\nthe ``setup.py`` file to ``install`` or ``develop``, but I would not\nrecommend that unless you plan to contribute to this small project of\nmine.\n\nUsage\n-----\n\nMy favorite way of using ``pylint`` and ``pylint-json2html`` is this\none:\n\n::\n\n (venv) $ pylint my_package | pylint-json2html -o pylint.html\n\nProvided that you configure your Pylint config file with:\n\n::\n\n [REPORTS]\n output-format=json\n\nBut you can generate first a JSON file, then use ``pylint-json2html`` to\nread it:\n\n::\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::\n\n (venv) $ pylint-json2html pylint.json > pylint.html\n\nExtended Report\n---------------\n\nActually, I lied about my favorite way, it is this one:\n\n::\n\n (venv) $ pylint my_package | pylint-json2html -f jsonextended -o pylint.html\n\nWith this Pylint configuration:\n\n::\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\nformat: ``jsonextended``. By default, the ``json`` format contains only\na list of messages, and this new format contains also metrics, such the\nnumber of analysed statements, or the list of dependencies.\n\nThe configuration above can be tested using the command line instead:\n\n::\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\nHTML report:\n\n::\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/Dorian-LEFEUVRE/pylint-json2html", "keywords": "pylint report quality", "license": "MPL-2.0", "maintainer": "", "maintainer_email": "", "name": "pylint-json2html-v2", "package_url": "https://pypi.org/project/pylint-json2html-v2/", "platform": "", "project_url": "https://pypi.org/project/pylint-json2html-v2/", "project_urls": { "Homepage": "https://github.com/Dorian-LEFEUVRE/pylint-json2html" }, "release_url": "https://pypi.org/project/pylint-json2html-v2/0.2.2/", "requires_dist": [ "pylint", "Jinja2" ], "requires_python": "", "summary": "Pylint JSON report to HTML", "version": "0.2.2" }, "last_serial": 5670890, "releases": { "0.2.2": [ { "comment_text": "", "digests": { "md5": "14e9753037a63691c13cd8f5c3c0576a", "sha256": "91e1d66733afb263c22437ba5766f288d54059645041db4de099dc6442c0f5d9" }, "downloads": -1, "filename": "pylint_json2html_v2-0.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "14e9753037a63691c13cd8f5c3c0576a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13031, "upload_time": "2019-08-13T09:04:05", "url": "https://files.pythonhosted.org/packages/0a/0f/e962ee0f2e1010c70f11ca6d9b852183c4af2d67c53a4cb549b649c685e0/pylint_json2html_v2-0.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "34e2f8d0779279b942be3939b8d3ffb0", "sha256": "d5373ebaf5fb3fc23e6e0b3336d0f7e3596dfd0fc062cf6e3cad50d134fcbea1" }, "downloads": -1, "filename": "pylint-json2html-v2-0.2.2.tar.gz", "has_sig": false, "md5_digest": "34e2f8d0779279b942be3939b8d3ffb0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11551, "upload_time": "2019-08-13T09:04:08", "url": "https://files.pythonhosted.org/packages/32/69/117f3edc01dad7eb78490f07d3e162438f9a2314b9b80419fe32e9724444/pylint-json2html-v2-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "14e9753037a63691c13cd8f5c3c0576a", "sha256": "91e1d66733afb263c22437ba5766f288d54059645041db4de099dc6442c0f5d9" }, "downloads": -1, "filename": "pylint_json2html_v2-0.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "14e9753037a63691c13cd8f5c3c0576a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13031, "upload_time": "2019-08-13T09:04:05", "url": "https://files.pythonhosted.org/packages/0a/0f/e962ee0f2e1010c70f11ca6d9b852183c4af2d67c53a4cb549b649c685e0/pylint_json2html_v2-0.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "34e2f8d0779279b942be3939b8d3ffb0", "sha256": "d5373ebaf5fb3fc23e6e0b3336d0f7e3596dfd0fc062cf6e3cad50d134fcbea1" }, "downloads": -1, "filename": "pylint-json2html-v2-0.2.2.tar.gz", "has_sig": false, "md5_digest": "34e2f8d0779279b942be3939b8d3ffb0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11551, "upload_time": "2019-08-13T09:04:08", "url": "https://files.pythonhosted.org/packages/32/69/117f3edc01dad7eb78490f07d3e162438f9a2314b9b80419fe32e9724444/pylint-json2html-v2-0.2.2.tar.gz" } ] }