Skip to content

Commit b8f091b

Browse files
committed
update readme
1 parent d84f5bf commit b8f091b

1 file changed

Lines changed: 19 additions & 36 deletions

File tree

README.md

Lines changed: 19 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -36,43 +36,29 @@ pytest
3636

3737
That's it! No configuration needed.
3838

39-
### Example Output
39+
### Successful Example Output
4040

4141
**Before (standard pytest):**
42-
```
43-
=================== test session starts ===================
44-
platform linux -- Python 3.14.0, pytest-9.0.2, pluggy-1.6.0
45-
rootdir: /path/to/project
46-
collected 4 items
47-
48-
tests/test_math.py .. [50%]
49-
tests/test_user.py .F [100%]
50-
51-
======================== FAILURES =========================
52-
_____________ test_user_validation ____________
53-
def test_user_validation():
54-
> assert user.is_valid()
55-
E AssertionError: assert False
56-
...
57-
```
42+
43+
![](assets/success-pytest.png)
44+
45+
**After (with pytest-elegant):**
46+
47+
![](assets/success-pytest-elegant.png)
48+
49+
### Failure Example Output
50+
51+
**Before (standard pytest):**
52+
53+
![](assets/failure-pytest.png)
5854

5955
**After (with pytest-elegant):**
60-
```
61-
PASS tests/test_math.py
62-
✓ test_addition 0.01s
63-
✓ test_subtraction 0.01s
64-
65-
FAIL tests/test_user.py
66-
✓ test_user_creation 0.05s
67-
⨯ test_user_validation 0.03s
68-
────────────────────────────────────────
69-
AssertionError: assert False
70-
File "tests/test_user.py", line 12, in test_user_validation
71-
→ assert user.is_valid()
72-
73-
Tests: 3 passed, 1 failed, 4 total
74-
Duration: 0.10s
75-
```
56+
57+
![](assets/failure-pytest-elegant.png)
58+
59+
**After (with pytest-elegant with verbose mode):**
60+
61+
![](assets/failure-pytest-elegant-verbose.png)
7662

7763
## Configuration
7864

@@ -173,9 +159,6 @@ pytest-elegant is a pytest plugin that:
173159
# Run all tests
174160
pytest
175161

176-
# Run with coverage
177-
pytest --cov=pytest_elegant --cov-report=term-missing
178-
179162
# Run specific test file
180163
pytest tests/test_reporter.py
181164
```

0 commit comments

Comments
 (0)