Skip to main content

Generate a modern, interactive HTML report from Robot Framework output.xml

Project description

Robotframework ReportLens

PyPI version Python CI Tests

ReportLens turns Robot Framework XML output (output.xml) into a single, self-contained HTML report with a modern, interactive UI.

Sample Report

View generated reports here

Installation

pip install robotframework-reportlens

Requires Python 3.7+. No extra dependencies (stdlib only).

Usage

After running Robot Framework tests (e.g. robot test/), generate a report from output.xml:

reportlens output.xml -o report.html

Arguments:

  • xml_file – Path to Robot Framework XML output (e.g. output.xml)
  • -o, --output – Output HTML path (default: report.html)

Examples:

# Default output (report.html in current directory)
reportlens output.xml

# Custom output path
reportlens output.xml -o docs/report.html

Open the generated .html file in a browser.

You can also run the module directly:

python -m robotframework_reportlens output.xml -o report.html

Features

  • Suite/test tree – Navigate suites and tests with pass/fail/skip counts
  • Search & filters – Filter by status and tags; search test names
  • Keyword tree – Expand SETUP, keywords, and TEARDOWN; select a keyword to see its logs
  • Logs panel – Log level filter (All, ERROR, WARN, INFO, etc.); copy button on each log message (shown on hover)
  • Failed-tests summary – Quick access to failed tests from the sidebar
  • Dark/light theme – Toggle in the report header
  • Fixed layout – Same layout on all screens; zoom and scroll as needed

How it works

ReportLens reads output.xml, parses suites, tests, keywords, and messages, then builds one HTML file from a bundled template. The report is data-driven: all content is embedded as JSON and rendered by JavaScript in the browser. No server required.

Development / source layout

├── robotframework_reportlens/
│   ├── __init__.py
│   ├── cli.py           # reportlens entry point
│   ├── generator.py     # XML → report data → HTML
│   └── template/
│       └── template.html
├── tests/
│   ├── conftest.py      # pytest fixtures
│   ├── test_cli.py      # CLI tests
│   ├── test_generator.py # report generator tests
│   └── fixtures/        # minimal Robot output.xml for tests
├── pyproject.toml
└── README.md

Running tests

Install with dev dependencies and run pytest:

pip install -e ".[dev]"
pytest tests/ -v

License

Apache License 2.0 - See LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

robotframework_reportlens-0.1.3.tar.gz (33.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

robotframework_reportlens-0.1.3-py3-none-any.whl (31.5 kB view details)

Uploaded Python 3

File details

Details for the file robotframework_reportlens-0.1.3.tar.gz.

File metadata

File hashes

Hashes for robotframework_reportlens-0.1.3.tar.gz
Algorithm Hash digest
SHA256 7b960236d4b017ca506ca255d0741dc32b6c16cd576d8bf96bee965976a09ecf
MD5 c2e633096f61a86093084f365280cc67
BLAKE2b-256 686f7eedc7880123820309ee91d43375eefa71895b97ed0baef7946dcead53da

See more details on using hashes here.

File details

Details for the file robotframework_reportlens-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_reportlens-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3c4b163715c2e7c183be64f69a4b642caf8df40547ac69b54de2e6b115c87ce1
MD5 5a952f4b4008fb1ffb97f923bb069506
BLAKE2b-256 caa0a5adaa2455fb7525b5765d1786709b7662ef6202b41529ebf2b5103a6429

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page