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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytest_reporter_html1-0.9.2.tar.gz
  • Upload date:
  • Size: 100.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pytest_reporter_html1-0.9.2.tar.gz
Algorithm Hash digest
SHA256 7aca7adb85ec2dd5bcf6b26cc46bda9887b970773f3af65752ee40b0b6d6cb14
MD5 0f93c54a57e4d4ed2c75e82ab10783ff
BLAKE2b-256 44c9eda36ab2d7bd20acc9c8ce7a02ae188e3ac9f48971de84106d9f8df30ca6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pytest_reporter_html1-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e355e1af547b5345368d1dd025395751e5a8e9be0df5be7ae9403b692bf14053
MD5 21b63904804912ce9ea5de4be0a8635f
BLAKE2b-256 eb26d9d1661b425a8d7c84f693aeb53a8de5416798b452e62de271e123bfad6b

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