Generate an HTML report for your unit tests
Project description
# Nose2 HTML Report
[![Build Status](https://travis-ci.org/mgrijalva/nose2-html-report.svg?branch=master)](https://travis-ci.org/mgrijalva/nose2-html-report)
[![Coverage Status](https://coveralls.io/repos/github/mgrijalva/nose2-html-report/badge.svg?branch=master)](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.
![Report Screenshot](https://raw.githubusercontent.com/mgrijalva/nose2-html-report/master/docs/images/report.png)
### 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.
[![Build Status](https://travis-ci.org/mgrijalva/nose2-html-report.svg?branch=master)](https://travis-ci.org/mgrijalva/nose2-html-report)
[![Coverage Status](https://coveralls.io/repos/github/mgrijalva/nose2-html-report/badge.svg?branch=master)](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.
![Report Screenshot](https://raw.githubusercontent.com/mgrijalva/nose2-html-report/master/docs/images/report.png)
### 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.
Source Distribution
Built Distribution
File details
Details for the file nose2_html_report-0.6.0.tar.gz
.
File metadata
- Download URL: nose2_html_report-0.6.0.tar.gz
- Upload date:
- Size: 6.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b5dfc9ab7e5d00c17a9c5fcd9afdf917dfeee125ed59ae734ce1e9494444c2f |
|
MD5 | 6a2fed2c0258c9113533b8b3215ca8e2 |
|
BLAKE2b-256 | 4746fc4ecf643bd1d5452ce0fa3fd61172a1d64fea79687c6a4fe3ad567651c7 |
File details
Details for the file nose2_html_report-0.6.0-py2.py3-none-any.whl
.
File metadata
- Download URL: nose2_html_report-0.6.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aa0d817655e3f86313e7113c7961e83d1da53a65a17c106a3cdc0342e989e93 |
|
MD5 | e6b3a3c0b453e6d9968b7660db3713fa |
|
BLAKE2b-256 | 327728881b34e3b5dd1827ea6b9d9d354df722f87db608535628a1597f8cfe6e |