behave-reportportal

What it is and what it does

Behave-reportportal is a Behave BDD framework extension that connects your test execution to a ReportPortal instance, pushing test results, logs, and metadata in real time or batched. It acts as a bridge between Behave's test runner and ReportPortal's centralized test reporting dashboard, allowing teams to aggregate results from multiple test runs, track trends, and manage test artifacts in one place.

The package provides configuration via behave.ini, supports multiple authentication methods (API key or OAuth 2.0), and integrates with Python's standard logging module through custom handlers. It handles scenario and step-level reporting, test attributes, launch lifecycle management, and optional file attachments. Three runtime dependencies—behave, prettytable, and reportportal-client—keep the footprint minimal, and the agent supports modern Python versions from 3.8 onward.

Use it for:

• Report Behave BDD test results to a centralized ReportPortal dashboard for team visibility and trend analysis.
• Attach logs and file artifacts (memory dumps, screenshots, etc.) to individual test steps for post-execution debugging.
• Mark scenarios with test case IDs and launch attributes to organize and filter results by environment, test type, or team.
• Rerun failed test launches and link them to original runs via launch_uuid for regression tracking.
• Use OAuth 2.0 authentication to integrate with enterprise ReportPortal deployments without exposing API keys.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Integrates Behave BDD test execution with ReportPortal, automatically reporting test results, logs, and attributes to a ReportPortal server instance.

Yes. Install this if you run Behave tests and have a ReportPortal instance to report to. Low install friction, active maintenance, no known vulnerabilities, and permissive licensing make it a straightforward addition to any Behave-based test suite. The only gotcha is the requirement for a pre-configured ReportPortal server and valid credentials—without that, the agent cannot function.

Install

behave-reportportal on PyPI

pip install behave-reportportal

uv add behave-reportportal

poetry add behave-reportportal

Installing behave-reportportal

Before you install

Low friction install with three straightforward runtime dependencies. Active maintenance as of 2026-07-06 with recent release history; repository is not archived and receives regular updates.

License in practice

Licensed under Apache 2.0, a permissive license allowing commercial and private use with minimal restrictions—suitable for most projects without legal concern.

Quickstart

pip install behave-reportportal

# In features/environment.py:
from behave_reportportal.behave_agent import BehaveAgent, create_rp_service
from behave_reportportal.config import read_config

def before_all(context):
    cfg = read_config(context)
    context.rp_client = create_rp_service(cfg)
    context.rp_agent = BehaveAgent(cfg, context.rp_client)
    context.rp_agent.start_launch(context)

Requires a running ReportPortal server instance and a valid behave.ini configuration file with endpoint, project, and authentication credentials (api_key or OAuth 2.0).

Verify before relying

• Whether the agent supports real-time log streaming or only batch uploads to ReportPortal.
• Performance impact when using ASYNC_BATCHED client type with large test suites.
• Compatibility with ReportPortal server versions and any breaking changes in recent releases.

Package facts

Evidence: behave_reportportal-5.1.4-py2.py3-none-any.whl

Keywords: testing, reporting, reportportal, behave

Tags

More Testing packages