Generate an HTML report for your unit tests
Project description
# 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.
[](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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size nose2_html_report-0.6.0-py2.py3-none-any.whl (7.9 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size nose2_html_report-0.6.0.tar.gz (6.4 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for nose2_html_report-0.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aa0d817655e3f86313e7113c7961e83d1da53a65a17c106a3cdc0342e989e93 |
|
MD5 | e6b3a3c0b453e6d9968b7660db3713fa |
|
BLAKE2-256 | 327728881b34e3b5dd1827ea6b9d9d354df722f87db608535628a1597f8cfe6e |