Skip to main content

A basic HTML report template for Pytest

Project description

PyPI version

A basic HTML report for pytest using Jinja2 template engine. Based on pytest-reporter which provides the data to the template.

Features

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

  • Includes information about tests such as documentation, markers, and fixtures

  • Fairly mobile friendly

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

  • Support for pytest-metadata and pytest-rerunfailures

  • May be used as a base template for customization

Screenshot

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;
    }
{% endblock %}

Some additional filters are available for templates to use:

asset(path_or_content, extension)

Takes a path to a local file or a raw bytes object 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="{{ 'path/to/image.png'|asset }}">
<img src="{{ raw_byte_data|asset('png') }}">
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.

rst(s)

Convert reStructuredText to HTML.

Issues

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

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

pytest_reporter_html1-0.9.5.tar.gz (99.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytest_reporter_html1-0.9.5-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file pytest_reporter_html1-0.9.5.tar.gz.

File metadata

  • Download URL: pytest_reporter_html1-0.9.5.tar.gz
  • Upload date:
  • Size: 99.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pytest_reporter_html1-0.9.5.tar.gz
Algorithm Hash digest
SHA256 8f80a123cf292a1fefc75ea86af7818719394e300ccbc1c8313789f00ee1b015
MD5 b506c336b4c3d01a3d4609d2bec5eed6
BLAKE2b-256 6a3d59176bdcbadbd051d9229a51db71bbc404aa343e89391c4178d208cb7fe7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_reporter_html1-0.9.5.tar.gz:

Publisher: pythonpublish.yml on christiansandberg/pytest-reporter-html1

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pytest_reporter_html1-0.9.5-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_reporter_html1-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fe61d517343443f24849d2ec6753d46f61c39615a726e2e53f98e1c967c17d9b
MD5 376824c529c8ec9883d6f48b009657ee
BLAKE2b-256 44e40a924045eb69ac0ca75fcfd9822539adb0f059ebf72d1563c6a53ca340dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_reporter_html1-0.9.5-py3-none-any.whl:

Publisher: pythonpublish.yml on christiansandberg/pytest-reporter-html1

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page