# Nose2 HTML Report
[](https://travis-ci.org/mgrijalva/nose2-html-report)
[](https://coveralls.io/github/mgrijalva/nose2-html-report?branch=master)
### Introduction
A [nose2](https://github.com/nose-devs/nose2) plugin for generating searchable HTML reports of your test results.
- docstrings from tests are captured as test descriptions
- if a test fails, the traceback will be captured in the report
- report is searchable and filterable by passed/failed/error/etc.
### Installation
You can install the Nose2 HTML Report Plugin using `pip`:
```
pip install nose2-html-report
```
### Configuration
To get `nose2` to recognize the plugin add an entry into the `plugin` key of the `unittest` section of your `nose2.cfg` file. Configurations for the plugin should be placed into an `html-report` section of the configuration file. Below is a working example:
```
[unittest]
plugins = nose2_html_report.html_report
[html-report]
always-on = True
```
#### Additional Settings
Specify the path for the HTML report. Defaults to `report.html`
```
[unittest]
plugins = nose2_html_report.html_report
[html-report]
always-on = True
path = test_results/my_custom_report_file.html
```
### Usage
Command line flag:
```
nose2 --html-report
```
If you have `always-on=True` inside your `nose2.cfg`:
```
nose2
```
### Contributing
This is a small side project of mine. Feel free to submit any pull requests.
Raw data
{
"_id": null,
"home_page": "https://github.com/mgrijalva/nose2-html-report",
"name": "nose2-html-report",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "nose2,testing,reporting",
"author": "Michael Grijalva",
"author_email": "michaelgrij@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/47/46/fc4ecf643bd1d5452ce0fa3fd61172a1d64fea79687c6a4fe3ad567651c7/nose2_html_report-0.6.0.tar.gz",
"platform": "",
"description": "# Nose2 HTML Report\n[](https://travis-ci.org/mgrijalva/nose2-html-report)\n[](https://coveralls.io/github/mgrijalva/nose2-html-report?branch=master)\n\n### Introduction\nA [nose2](https://github.com/nose-devs/nose2) plugin for generating searchable HTML reports of your test results.\n- docstrings from tests are captured as test descriptions\n- if a test fails, the traceback will be captured in the report\n- report is searchable and filterable by passed/failed/error/etc.\n\n\n\n### Installation\nYou can install the Nose2 HTML Report Plugin using `pip`:\n```\npip install nose2-html-report\n```\n\n### Configuration\nTo get `nose2` to recognize the plugin add an entry into the `plugin` key of the `unittest` section of your `nose2.cfg` file. Configurations for the plugin should be placed into an `html-report` section of the configuration file. Below is a working example:\n```\n[unittest]\nplugins = nose2_html_report.html_report\n\n[html-report]\nalways-on = True\n```\n\n#### Additional Settings\nSpecify the path for the HTML report. Defaults to `report.html`\n```\n[unittest]\nplugins = nose2_html_report.html_report\n\n[html-report]\nalways-on = True\npath = test_results/my_custom_report_file.html\n```\n\n### Usage\nCommand line flag:\n```\nnose2 --html-report\n```\n\nIf you have `always-on=True` inside your `nose2.cfg`:\n```\nnose2\n```\n\n### Contributing\nThis is a small side project of mine. Feel free to submit any pull requests.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generate an HTML report for your unit tests",
"version": "0.6.0",
"split_keywords": [
"nose2",
"testing",
"reporting"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e6b3a3c0b453e6d9968b7660db3713fa",
"sha256": "1aa0d817655e3f86313e7113c7961e83d1da53a65a17c106a3cdc0342e989e93"
},
"downloads": -1,
"filename": "nose2_html_report-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6b3a3c0b453e6d9968b7660db3713fa",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7925,
"upload_time": "2017-12-16T21:27:59",
"upload_time_iso_8601": "2017-12-16T21:27:59.911737Z",
"url": "https://files.pythonhosted.org/packages/32/77/28881b34e3b5dd1827ea6b9d9d354df722f87db608535628a1597f8cfe6e/nose2_html_report-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "6a2fed2c0258c9113533b8b3215ca8e2",
"sha256": "2b5dfc9ab7e5d00c17a9c5fcd9afdf917dfeee125ed59ae734ce1e9494444c2f"
},
"downloads": -1,
"filename": "nose2_html_report-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "6a2fed2c0258c9113533b8b3215ca8e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6407,
"upload_time": "2017-12-16T21:28:01",
"upload_time_iso_8601": "2017-12-16T21:28:01.473890Z",
"url": "https://files.pythonhosted.org/packages/47/46/fc4ecf643bd1d5452ce0fa3fd61172a1d64fea79687c6a4fe3ad567651c7/nose2_html_report-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2017-12-16 21:28:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mgrijalva",
"github_project": "nose2-html-report",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"requirements": [
{
"name": "coverage",
"specs": [
[
"==",
"4.0.3"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"==",
"2.9.4"
]
]
},
{
"name": "MarkupSafe",
"specs": [
[
"==",
"0.23"
]
]
},
{
"name": "nose2",
"specs": [
[
"==",
"0.6.5"
]
]
},
{
"name": "python-coveralls",
"specs": [
[
"==",
"2.9.0"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.10.0"
]
]
}
],
"lcname": "nose2-html-report"
}
JSON
