Skip to main content

Lightweight enhanced HTML reporter for Pytest

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

🧪 pytest-reporter-plus PyPI Downloads

A powerful, plug-and-play Pytest plugin to generate HTML + JSON reports, detect flaky tests, and optionally * send reports via email*. Works beautifully with or without xdist.

🚀 Installation

pip install pytest-reporter-plus
# or with Poetry
poetry add pytest-reporter-plus

🧾 Usage

Generate HTML + JSON reports:

pytest

If you are running with xdist

pytest -n numberOfWorkers

You’ll get:

report.html – a clean, styled HTML report


Available Options

Option Description Default Choices
--json-report Path to save individual JSON test reports playwright_report.json Any valid file path
--automation-tool Specify automation tool used for testing playwright playwright, selenium, other
--capture-screenshots When to capture screenshots failed failed, all, none
--html-output Directory to output HTML reports report_output Any valid directory
--screenshots Directory where screenshots will be stored screenshots Any valid directory
--send-email Send HTML report via email after the test run False True, False
--should-open-report Open your HTML report automatically post completion failed always, failed, never

✨ Features

🧩 Unified Test Reports: Get a single, easy-to-read HTML report summarizing all your test results — no hassle, just clarity.

🔄 Flaky Test Detection: Automatically flags flaky tests so you can spot and fix inconsistent failures quickly.

ScreenRecording2025-06-21at2 37 31PM-ezgif com-video-to-gif-converter

📸 Screenshot Support: View screenshots directly in the report to understand failures faster.

📧 Email Test Reports: Send your reports via email effortlessly using SendGrid integration.

Screenshot 2025-05-28 at 4 38 49 PM

🐢 Spot Slow Tests: Highlights the slowest tests so you know where to optimize your suite.

ScreenRecording2025-06-21at2 52 49PM-ezgif com-video-to-gif-converter

📝 Comprehensive output capture: All your test logs with loggers, print() statements, and screenshots are automatically captured and embedded in the report...

ezgif-744a5d34a4c46d

🔍 Universal Test Search + Smart Link Navigation

Whether you're trying to trace coverage or track unlinked test cases — this search has your back!

Just start typing, and the dashboard will instantly filter tests by:

✅ Test name

✅ Linked issue/documentation IDs (like JIRA, Testmo, Notion, etc.)

✅ Custom URLs or keywords present in the links

ScreenRecording2025-06-21at3 10 06PM-ezgif com-video-to-gif-converter

AND MANY MANY MORE

Target Audience

This plugin is aimed at those who are:

  • Are frustrated with archiving folders full of assets, CSS, JS, and dashboards just to share test results.

  • Don’t want to refactor existing test suites or tag everything with new decorators just to integrate with a reporting tool.

  • Prefer simplicity — a zero-config, zero code, lightweight report that still looks clean, useful, and polished.

  • Want “just enough” — not bare-bones plain text, not a full dashboard with database setup — just a portable HTML report that STILL supports features like links, screenshots, and markers.

Comparison with Alternatives

Most existing pytest reporter tools:

Only generate HTML reports from a single run (by making you write code for creating xmls like pytest-html) OR they generate all the JS and png files that are not the scope of test results and force you to archive it.

Heavy duty with bloated charts and other test management features(when they arent your only test management system either) increasing your archive size.

This plugin aims to fill those gaps by acting as a companion layer on top of the JSON report, focusing on:

🔄 Merge + flakiness intelligence

🔗 Traceability via metadata

🧼 HTML that’s both readable and minimal

🧼 Quickly copy test paths and run in your local

🔁 Flaky Test Detection

If a test is retried multiple times (e.g. due to a --reruns plugin), the report will flag it as FLAKY.

In the HTML report, you’ll see a badge like:

Screenshot 2025-05-28 at 3 43 17 PM

📧 Email Report (Optional)

Send the HTML report via email using --send-email. Please note you will need your own sendgrid setup to use this feature

Create an emailenv file in your project folder that has the following

sender_email=you@example.com
recipient_email=team@example.com
report_path=report.html
subject=Your Test Report
smtp_server=smtp.sendgrid.net
smtp_port=587
email_password=your_sendgrid_api_key

Run

pytest --send-email

🤝 Contributions

PRs, issues, and feature requests are welcome! Let's make this tool more awesome together.

Setting up the project is pretty simple

docker build -t pytest-reporter-plus .
docker run -it pytest-reporter-plus /bin/bash 
poetry install --dev

poetry run pytest tests/ 

Motivation

I’m building and maintaining this in my free time, and would really appreciate:

⭐ Stars if you find it useful

🐞 Bug reports, feedback, or PRs if you try it out

📜 License

MIT

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_plus-0.2.9.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

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

pytest_reporter_plus-0.2.9-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file pytest_reporter_plus-0.2.9.tar.gz.

File metadata

  • Download URL: pytest_reporter_plus-0.2.9.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for pytest_reporter_plus-0.2.9.tar.gz
Algorithm Hash digest
SHA256 f677e4fabac31e9b9c1dc6ab50df4999c7f8f2d77b952033d713e277045eb3d0
MD5 e4bcd928f951ad81625e05bfbb1eb9bd
BLAKE2b-256 ea129d33b6a8ee44c9a67e120fd972fefc73a624aec8d1d2f54e62993845ad1a

See more details on using hashes here.

File details

Details for the file pytest_reporter_plus-0.2.9-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_reporter_plus-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 69263dd437bb0f3bb473a929c2013c9836ec38b41c02ad95ffe582462a53eddc
MD5 d464a0e43bd0ff506a84f2a5874e869a
BLAKE2b-256 be369b1903bd7c14f28ac943f7fbc122f459ee41fdaaef0927a179b20c5130f2

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