pylint_junit
============
Pylint plugin that generates JUnit based report that can be consumed
by CI environments like Jenkins, Azure Devops and such.
Why ?
=====
At the time of writing, few tools existed that where able to generate
JUnit format from pylint output. Both of these projects where not
handling "empty" results scenario well, eg both cases generated an empty
file and that caused issues in ci as the resulting document was not
proper xml file. Another issue was that issues found by pylint where
marked under single testcase failure and this caused atleast Azure to
report a single item per file even thought there could have been multiple.
Thus, pylint_junit was written.
Installation
============
Install the package with
.. code-block::
pip install pylint_junit
or add it to your requirements.
Usage
=====
After the plugin has been installed there are few options to take it into use.
Add following lines into your .pylintrc:
.. code-block::
[MASTER]
load-plugins=pylint_junit
[REPORTS]
output-format=junit
This does set the default output to junit, so if still want to run pylint and get
normal output, you might want to consider omitting the "output-format=junit"
portion and only when junit format is needed, provide it via command line like this:
.. code-block::
pylint --output-format=junit src/
Or, without making any changes to your pylint configuration, you can just pass the class
as report formatter like this:
.. code-block::
pylint --output-format=pylint_junit.JUnitReporter src/
Dependencies
============
* junit_xml__
__ https://github.com/kyrus/python-junit-xml
Bugs / Feedback
===============
Use Github Issues Tracker @ https://github.com/rasjani/pylint_junit/issues
Raw data
{
"_id": null,
"home_page": "https://github.com/rasjani/pylint_junit",
"name": "pylint-junit",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Jani Mikkonen",
"author_email": "jani.mikkonen@gmail.com",
"download_url": "",
"platform": "any",
"description": "\npylint_junit\n============\n\nPylint plugin that generates JUnit based report that can be consumed\nby CI environments like Jenkins, Azure Devops and such.\n\nWhy ?\n=====\n\nAt the time of writing, few tools existed that where able to generate\nJUnit format from pylint output. Both of these projects where not\nhandling \"empty\" results scenario well, eg both cases generated an empty\nfile and that caused issues in ci as the resulting document was not\nproper xml file. Another issue was that issues found by pylint where\nmarked under single testcase failure and this caused atleast Azure to\nreport a single item per file even thought there could have been multiple.\n\nThus, pylint_junit was written.\n\nInstallation\n============\n\nInstall the package with\n\n.. code-block::\n\n pip install pylint_junit\n\nor add it to your requirements.\n\nUsage\n=====\n\nAfter the plugin has been installed there are few options to take it into use.\n\nAdd following lines into your .pylintrc:\n\n.. code-block::\n\n [MASTER]\n load-plugins=pylint_junit\n [REPORTS]\n output-format=junit\n\nThis does set the default output to junit, so if still want to run pylint and get\nnormal output, you might want to consider omitting the \"output-format=junit\"\nportion and only when junit format is needed, provide it via command line like this:\n\n.. code-block::\n\n pylint --output-format=junit src/\n\n\n\nOr, without making any changes to your pylint configuration, you can just pass the class\nas report formatter like this:\n\n.. code-block::\n\n pylint --output-format=pylint_junit.JUnitReporter src/\n\nDependencies\n============\n\n\n* junit_xml__\n\n__ https://github.com/kyrus/python-junit-xml\n\nBugs / Feedback\n===============\n\nUse Github Issues Tracker @ https://github.com/rasjani/pylint_junit/issues\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "pylint reporter for junit format.",
"version": "0.3.4",
"project_urls": {
"Homepage": "https://github.com/rasjani/pylint_junit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02523cbc1917137fbb7a57daca643eacbee85defc0a88f27ff6157f642a3924c",
"md5": "3aee67d98b6cf785d1ca91e17d3d3a34",
"sha256": "006f8e793a1b64f1e0c8a29c6ee531b8af971deddafbc605c3076270f36c88f0"
},
"downloads": -1,
"filename": "pylint_junit-0.3.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3aee67d98b6cf785d1ca91e17d3d3a34",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 3719,
"upload_time": "2023-11-03T10:27:18",
"upload_time_iso_8601": "2023-11-03T10:27:18.918197Z",
"url": "https://files.pythonhosted.org/packages/02/52/3cbc1917137fbb7a57daca643eacbee85defc0a88f27ff6157f642a3924c/pylint_junit-0.3.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 10:27:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rasjani",
"github_project": "pylint_junit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pylint-junit"
}
JSON
