Skip to content

Commit 203e0ef

Browse files
authored
Update readme (#74)
* update README.md * Update README.md
1 parent b25c71b commit 203e0ef

1 file changed

Lines changed: 45 additions & 18 deletions

File tree

README.md

Lines changed: 45 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A powerful, plug-and-play Pytest plugin to generate **HTML + JSON reports**, det
88
```bash
99
pip install pytest-reporter-plus
1010
# or with Poetry
11-
poetry add --dev pytest-reporter-plus
11+
poetry add pytest-reporter-plus
1212
```
1313

1414
## 🧾 Usage
@@ -52,25 +52,22 @@ report.html – a clean, styled HTML report
5252

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

55-
![Screenshot 2025-05-28 at 3 43 17 PM](https://github.com/user-attachments/assets/6fd7a419-58c1-4651-96f7-093ced1f02ee)
55+
![ScreenRecording2025-06-21at2 37 31PM-ezgif com-video-to-gif-converter](https://github.com/user-attachments/assets/90f694bf-189c-45e1-8e1d-7acd2a975f91)
5656

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

59-
#### 📝 Comprehensive output capture: All your test logs with loggers, print() statements, and screenshots are automatically captured and embedded in the report...
60-
61-
![ezgif-744a5d34a4c46d](https://github.com/user-attachments/assets/209cd2c0-d33b-48ec-b58b-8c8991ce35be)
62-
6359
#### 📧 Email Test Reports: Send your reports via email effortlessly using SendGrid integration.
6460

6561
![Screenshot 2025-05-28 at 4 38 49 PM](https://github.com/user-attachments/assets/3f40e206-5dfd-45e9-a511-4dd206cf3318)
6662

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

69-
![ezgif-64896277dcf8f8](https://github.com/user-attachments/assets/f5616a07-0dd9-40ed-aa9a-cf9adee3a0b8)
65+
![ScreenRecording2025-06-21at2 52 49PM-ezgif com-video-to-gif-converter](https://github.com/user-attachments/assets/b9760927-7c67-4bbf-b03d-e13964c727ee)
66+
67+
#### 📝 Comprehensive output capture: All your test logs with loggers, print() statements, and screenshots are automatically captured and embedded in the report...
7068

71-
#### ⏱️ Sort & Filter: Easily sort tests by duration or filter by custom tags and skip status to focus on what matters.
69+
![ezgif-744a5d34a4c46d](https://github.com/user-attachments/assets/209cd2c0-d33b-48ec-b58b-8c8991ce35be)
7270

73-
![ezgif-3056394be0e9a4](https://github.com/user-attachments/assets/bb60c50a-4709-42f3-8571-19cbd76a93cf)
7471

7572
#### 🔍 Universal Test Search + Smart Link Navigation
7673

@@ -84,15 +81,41 @@ Just start typing, and the dashboard will instantly filter tests by:
8481

8582
✅ Custom URLs or keywords present in the links
8683

87-
![Screen Recording 2025-06-01 at 2 48 08 PM](https://github.com/user-attachments/assets/057441ac-06a3-421f-aafc-915968a90463)
8884

89-
## Why use pytest-reporter-plus?
85+
![ScreenRecording2025-06-21at3 10 06PM-ezgif com-video-to-gif-converter](https://github.com/user-attachments/assets/f81c9a81-f98d-4151-ad7a-c1184cd199eb)
86+
87+
88+
### AND MANY MANY MORE
89+
90+
## Target Audience
91+
92+
This plugin is aimed at those who are:
9093

91-
Stop wasting time writing and maintaining custom pytest reporter hooks like pytest_runtest_makereport!
92-
With pytest-reporter-plus, you get a beautiful, lightweight HTML report out of the box — no extra coding needed.
94+
- Are frustrated with archiving folders full of assets, CSS, JS, and dashboards just to share test results.
9395

94-
Just install, run your tests, and let the plugin handle all the reporting magic. Focus on what matters: writing and
95-
running your tests.
96+
- Don’t want to refactor existing test suites or tag everything with new decorators just to integrate with a reporting tool.
97+
98+
- Prefer simplicity — a zero-config, zero code, lightweight report that still looks clean, useful, and polished.
99+
100+
- 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.
101+
102+
103+
## Comparison with Alternatives
104+
Most existing pytest reporter tools:
105+
106+
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.
107+
108+
Heavy duty with bloated charts and other test management features(when they arent your only test management system either) increasing your archive size.
109+
110+
This plugin aims to fill those gaps by acting as a companion layer on top of the JSON report, focusing on:
111+
112+
🔄 Merge + flakiness intelligence
113+
114+
🔗 Traceability via metadata
115+
116+
🧼 HTML that’s both readable and minimal
117+
118+
🧼 Quickly copy test paths and run in your local
96119

97120
## 🔁 Flaky Test Detection
98121

@@ -134,13 +157,17 @@ PRs, issues, and feature requests are welcome! Let's make this tool more awesome
134157
```
135158
docker build -t pytest-reporter-plus .
136159
docker run -it pytest-reporter-plus /bin/bash
160+
poetry install --dev
161+
162+
poetry run pytest tests/
137163
```
138164

139-
## 📛 Naming
165+
## Motivation
166+
I’m building and maintaining this in my free time, and would really appreciate:
140167

141-
Why pytest-reporter-plus?
168+
⭐ Stars if you find it useful
142169

143-
Because it does more than just reporting – it’s your enhanced test summary companion ✨
170+
🐞 Bug reports, feedback, or PRs if you try it out
144171

145172
## 📜 License
146173

0 commit comments

Comments
 (0)