pytest-reporter-html1 0.3.3

A basic HTML report template for Pytest

A basic HTML report for Pytest using Jinja2 template engine.

Features

• Overview of files, tests, and phases with expandable sections

• Fairly mobile friendly

• Complies with Jenkins default CSP policy (with --split-report)

• reStructuredText support in test function documentation

• Support for pytest-metadata and pytest-rerunfailures

• May be used as a base template for customization

Installation

You can install “pytest-reporter-html1” via pip from PyPI:

$ pip install pytest-reporter-html1

Usage

Specify the html1 template and the output path of the report:

$ pytest --template=html1/index.html --report=report.html

By default the report is self-contained, but you can separate CSS, images, and JavaScript by specifying the --split-report option.

Customization

You can inherit this template in your own to tailor parts of it to your own needs. It defines various blocks which you can override using template inheritance.

{% extends "html1/index.html" %}
{% block style %}
    {{ super() }}
    header {
        background-color: black;
    }
    body {
        font-family: Cambria, Cochin, Georgia, Times, 'Times New Roman', serif;
    }
{% endblock %}

Some additional filters are available for templates to use:

asset(path)

Takes a path to a local file and either returns a base64 encoded URL or a new relative URL to a copy depending on if the report is self-contained or not.

<img src="{{ 'temporary_path/image.png'|asset }}">

ansi(s)

Convert ANSI color codes to HTML.

strftime(value, format)

Format a Unix timestamp using datetime.strftime.

Started: {{ started|strftime('%Y-%m-%d %H:%M:%S') }}

timedelta(value)

Convert a time in seconds to a timedelta object.

cleandoc(s)

Clean docstring using inspect.cleandoc.

rst(s)

Convert reStructuredText to HTML.

Issues

If you encounter any problems, please file an issue along with a detailed description.