ReportPortal python client

Library used only for implementors of custom listeners for ReportPortal

Already implemented listeners:

Installation

The latest stable version is available on PyPI:

pip install reportportal-client

Usage

Basic usage example:

import os
import subprocess
from mimetypes import guess_type

from reportportal_client import RPClient
from reportportal_client.helpers import timestamp

endpoint = "http://docker.local:8080"
project = "default"
# You can get UUID from user profile page in the ReportPortal.
api_key = "1adf271d-505f-44a8-ad71-0afbdf8c83bd"
launch_name = "Test launch"
launch_doc = "Testing logging with attachment."


client = RPClient(endpoint=endpoint, project=project,
                  api_key=api_key)

# Start log upload thread
client.start()

# Start launch.
launch = client.start_launch(name=launch_name,
                             start_time=timestamp(),
                             description=launch_doc)

item_id = client.start_test_item(name="Test Case",
                                 description="First Test Case",
                                 start_time=timestamp(),
                                 attributes=[{"key": "key", "value": "value"},
                                             {"value", "tag"}],
                                 item_type="STEP",
                                 parameters={"key1": "val1",
                                             "key2": "val2"})

# Create text log message with INFO level.
client.log(time=timestamp(),
           message="Hello World!",
           level="INFO")

# Create log message with attached text output and WARN level.
client.log(time=timestamp(),
           message="Too high memory usage!",
           level="WARN",
           attachment={
               "name": "free_memory.txt",
               "data": subprocess.check_output("free -h".split()),
               "mime": "text/plain"
           })

# Create log message with binary file, INFO level and custom mimetype.
image = "/tmp/image.png"
with open(image, "rb") as fh:
    attachment = {
        "name": os.path.basename(image),
        "data": fh.read(),
        "mime": guess_type(image)[0] or "application/octet-stream"
    }
    client.log(timestamp(), "Screen shot of issue.", "INFO", attachment)

client.finish_test_item(item_id=item_id, end_time=timestamp(), status="PASSED")

# Finish launch.
client.finish_launch(end_time=timestamp())

# Due to async nature of the service we need to call terminate() method which
# ensures all pending requests to server are processed.
# Failure to call terminate() may result in lost data.
client.terminate()

Send attachment (screenshots)

The client uses requests library for working with RP and the same semantics to work with attachments (data).

To log an attachment you need to pass file content and metadata to ``

import logging

from reportportal_client import RPLogger, RPLogHandler

logging.setLoggerClass(RPLogger)
rp_logger = logging.getLogger(__name__)
rp_logger.setLevel(logging.DEBUG)
rp_logger.addHandler(RPLogHandler())

screenshot_file_path = 'path/to/file.png'

with open(screenshot_file_path, "rb") as image_file:
    file_data = image_file.read()

    # noinspection PyArgumentList
    rp_logger.info(
        "Some Text Here",
        attachment={"name": "test_name_screenshot.png",
                    "data": file_data,
                    "mime": "image/png"}
    )

Copyright Notice

Licensed under the Apache 2.0 license (see the LICENSE.txt file).

Metadata

Release files for reportportal-client 5.7.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for reportportal-client 5.7.10
File	Size	Uploaded
reportportal_client-5.7.10.tar.gz	73.1 kB	Aug 5, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for reportportal-client 5.7.10
File	Interpreter	ABI	Platform	Reset
reportportal_client-5.7.10-py2.py3-none-any.whl 88.7 kB Aug 5, 2026	Python 2, Python 3	none	any	Details

Total release size: 161.8 kB

Release files / reportportal_client-5.7.10.tar.gz

Download URL	reportportal_client-5.7.10.tar.gz
Size	73.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`3ee9b12a3aebd4af09f305b0cba1610b27ff4e86622a27a6b73ee37b2dece6af`
BLAKE2b-256 checksum How to use checksums	`4085f0cfd61faa1778cebc30a3ccae4dbd5ea6cb5d197b70d62a0a51ffcfe02e`
Upload date	Aug 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / reportportal_client-5.7.10-py2.py3-none-any.whl

Download URL	reportportal_client-5.7.10-py2.py3-none-any.whl
Size	88.7 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`08604295bd7590e7b0ba975c58b6b9c79b2ee0c69f795fd9912b88c452bcd07b`
BLAKE2b-256 checksum How to use checksums	`3b50070f9e69a3414d57ff0317987c2fe819c53f9986fe9e4a9956884a1896d9`
Upload date	Aug 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`