Skip to main content
# 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.


Metadata

Release files for nose2-html-report 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nose2-html-report 0.6.0
File Size Uploaded Provenance
nose2_html_report-0.6.0.tar.gz 6.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for nose2-html-report 0.6.0
File Interpreter ABI Platform
nose2_html_report-0.6.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 14.3 kB

Release files / nose2_html_report-0.6.0.tar.gz

Download URL nose2_html_report-0.6.0.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2b5dfc9ab7e5d00c17a9c5fcd9afdf917dfeee125ed59ae734ce1e9494444c2f
BLAKE2b-256 checksum
How to use checksums
4746fc4ecf643bd1d5452ce0fa3fd61172a1d64fea79687c6a4fe3ad567651c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / nose2_html_report-0.6.0-py2.py3-none-any.whl

Download URL nose2_html_report-0.6.0-py2.py3-none-any.whl
Size 7.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
1aa0d817655e3f86313e7113c7961e83d1da53a65a17c106a3cdc0342e989e93
BLAKE2b-256 checksum
How to use checksums
327728881b34e3b5dd1827ea6b9d9d354df722f87db608535628a1597f8cfe6e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for nose2-html-report 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page