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

  • 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

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

Uploaded Source

Built Distribution

pytest_reporter_html1-0.7.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytest-reporter-html1-0.7.0.tar.gz
  • Upload date:
  • Size: 99.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for pytest-reporter-html1-0.7.0.tar.gz
Algorithm Hash digest
SHA256 8d660d33913cb451340b5740d42b0e7fefda09de0c10bce3e96bcdc2c8f32388
MD5 f2e138bb201f5c73f2c91a5d7ee1ad29
BLAKE2b-256 32141d7e4c9c4a39fb4cad39bfd111476b82c4c8bbc076241eb603a4d99cbf6a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pytest_reporter_html1-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for pytest_reporter_html1-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be98fa866342eefe0458bd6b5b9819c78390c917e0b707ba9d8da6bc9053ca09
MD5 1d9964da8a4b7606e38869665034fb68
BLAKE2b-256 bd2d0b30cef23fa5b34b306bc4d670f902aeb0b5320142f57098bcc202e1c366

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