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.

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;
    }
    body {
        font-family: Cambria, Cochin, Georgia, Times, 'Times New Roman', serif;
    }
{% endblock %}

Some additional filters are available for templates to use:

asset(path)

Takes a path to a local file 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="{{ 'temporary_path/image.png'|asset }}">
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.

cleandoc(s)

Clean docstring using inspect.cleandoc.

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

Uploaded Source

Built Distribution

pytest_reporter_html1-0.6.0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytest-reporter-html1-0.6.0.tar.gz
  • Upload date:
  • Size: 99.3 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.0 CPython/3.8.5

File hashes

Hashes for pytest-reporter-html1-0.6.0.tar.gz
Algorithm Hash digest
SHA256 0355c3823af3d6a030a698634ece5f6035392f9869dc07ed04d578a34bc4448b
MD5 5284207e3e3918be6975d711b486f0c1
BLAKE2b-256 877b9cdd24f126de618b7a30df186f14e347998f23a4ad0cdb1acfd40aa624cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pytest_reporter_html1-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 15.9 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.0 CPython/3.8.5

File hashes

Hashes for pytest_reporter_html1-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2b194b8c94a8ae63425993458b6fd105c4027be28a84e0bdaf3dfb1886df91ea
MD5 a6218d8d2b883ae9c3f21da3dc1af751
BLAKE2b-256 a60cbf742bea530665c6e61ab03859c04b8a59c13c024d0fd0e965eb77d63271

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