Metadata-Version: 1.2
Name: pytest-reporter-html1
Version: 0.5.1
Summary: A basic HTML report template for Pytest
Home-page: https://github.com/christiansandberg/pytest-reporter-html1
Author: Christian Sandberg
Author-email: christiansandberg@me.com
Maintainer: Christian Sandberg
Maintainer-email: christiansandberg@me.com
License: MIT
Description: =====================
        pytest-reporter-html1
        =====================
        
        .. image:: https://img.shields.io/pypi/v/pytest-reporter-html1.svg
            :target: https://pypi.org/project/pytest-reporter-html1
            :alt: 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
        
        .. image:: https://raw.githubusercontent.com/christiansandberg/pytest-reporter-html1/master/screenshot.png
            :alt: 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`_.
        
        .. code:: html
        
            {% 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.
        
            .. code:: html
        
                <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`_.
        
            .. code:: html
        
                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.
        
        .. _`Jinja2`: https://jinja.palletsprojects.com/
        .. _`template inheritance`: https://jinja.palletsprojects.com/en/master/templates/#template-inheritance
        .. _`file an issue`: https://github.com/christiansandberg/pytest-reporter/issues
        .. _`pytest`: https://github.com/pytest-dev/pytest
        .. _`pip`: https://pypi.org/project/pip/
        .. _`PyPI`: https://pypi.org/project
        .. _`datetime.strftime`: https://docs.python.org/3/library/datetime.html#datetime.datetime.strftime
        .. _`timedelta`: https://docs.python.org/3/library/datetime.html#timedelta-objects
        .. _`inspect.cleandoc`: https://docs.python.org/3/library/inspect.html#inspect.cleandoc
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Programming Language :: Python
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.5
