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.0.tar.gz (100.0 kB view details)

Uploaded Source

Built Distribution

pytest_reporter_html1-0.9.0-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytest_reporter_html1-0.9.0.tar.gz
  • Upload date:
  • Size: 100.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for pytest_reporter_html1-0.9.0.tar.gz
Algorithm Hash digest
SHA256 587bb31ba1ab1cc3c9b1e50556da0213d2fc47d6a18fa63b457523088877110a
MD5 0c00b18e3deb685ebd0f3f49cacd4fde
BLAKE2b-256 19c4bcfe7fbcd9f6300b000cd1abc2277479cae94f4d0807e34235462091e605

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pytest_reporter_html1-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bea469c9c5645c8e78fe561acc8f3769523791b64e8356699bcf00ee09fbd2a1
MD5 8056ea7fdee6ef55c5cd267344e96b0f
BLAKE2b-256 d9b1c40d2defa0aa5bb3f19ca6d42e530f43ff778e1c7cc871b95a77723a5fb9

See more details on using hashes here.

Supported by

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