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

Uploaded Source

Built Distribution

pytest_reporter_html1-0.8.4-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file pytest-reporter-html1-0.8.4.tar.gz.

File metadata

  • Download URL: pytest-reporter-html1-0.8.4.tar.gz
  • Upload date:
  • Size: 99.8 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.8.4.tar.gz
Algorithm Hash digest
SHA256 30c609a29de691e59c61bc7c9dbf8e905e69c7e467b52ca9b7a1a4b316cd989d
MD5 66a4309e9d3ae3589f3d137e61fffb08
BLAKE2b-256 5c3732f1316a2d8c62fc3bb8a8f04a776d2ae44178566226e6f6481449a230bf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pytest_reporter_html1-0.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2ff9acb07e11ec8bc245b723fc84c2ac3f4ffba8d6c6f690f3fd917258e0cd4f
MD5 bb6d8613c6f6ca0d1c1d23734b539194
BLAKE2b-256 e9eb15d5944749b04500b60fa11cbe5bf849e4da42298500fc399eefa784dcfa

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