pytest-elegant 0.1.0__tar.gz

pytest_elegant-0.1.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.3
+Name: pytest-elegant
+Version: 0.1.0
+Summary: A pytest plugin that provides elegant, beautiful test output
+Author: Einenlum
+Author-email: Einenlum <contact@einenlum.com>
+Requires-Dist: pytest>=7.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# pytest-elegant
+
+A pytest plugin that provides elegant, beautiful test output inspired by [Pest PHP](https://pestphp.com/)'s aesthetic.
+
+## Features
+
+- **Clean, minimal output** with ✓/✗ symbols instead of dots/F/E
+- **Colored results** - green for passing tests, red for failures, yellow for skipped
+- **File grouping** - Tests organized by file with PASS/FAIL headers
+- **Duration display** - See how long each test takes (e.g., `0.12s`)
+- **Immediate failure details** - See what went wrong right away with code context
+- **Zero configuration** - Just install and run `pytest` as usual
+- **Standard pytest syntax** - Keep your existing `def test_*` functions
+
+## Installation
+
+### Using uv (recommended)
+
+```bash
+uv add --dev pytest-elegant
+```
+
+### Using pip
+
+```bash
+pip install pytest-elegant
+```
+
+## Usage
+
+Once installed, pytest-elegant automatically transforms your pytest output. Just run:
+
+```bash
+pytest
+```
+
+That's it! No configuration needed.
+
+### Successful Example Output
+
+**Before (standard pytest):**
+
+![](assets/success-pytest.png)
+
+**After (with pytest-elegant):**
+
+![](assets/success-pytest-elegant.png)
+
+### Failure Example Output
+
+**Before (standard pytest):**
+
+![](assets/failure-pytest.png)
+
+**After (with pytest-elegant):**
+
+![](assets/failure-pytest-elegant.png)
+
+**After (with pytest-elegant with verbose mode):**
+
+![](assets/failure-pytest-elegant-verbose.png)
+
+## Configuration
+
+pytest-elegant works out of the box, but you can customize it via `pytest.ini` or `pyproject.toml`.
+
+### pyproject.toml
+
+```toml
+[tool.pytest.ini_options]
+elegant_show_context = true      # Show code context in failure output (default: true)
+elegant_group_by_file = true     # Group test results by file (default: true)
+elegant_show_duration = true     # Show test duration for each test (default: true)
+```
+
+### pytest.ini
+
+```ini
+[pytest]
+elegant_show_context = true
+elegant_group_by_file = true
+elegant_show_duration = true
+```
+
+## Disabling pytest-elegant
+
+If you need to temporarily disable pytest-elegant and see standard pytest output:
+
+```bash
+pytest --no-elegant
+```
+
+## Verbose Mode
+
+pytest-elegant respects pytest's verbosity flags:
+
+```bash
+pytest -v      # More details (full file paths, more context)
+pytest -vv     # Maximum details (full stack traces)
+```
+
+## Advanced Features
+
+### Parametrized Tests
+
+pytest-elegant beautifully formats parametrized tests, showing each parameter set:
+
+```
+  ✓ test_math[1-2-3] 0.01s
+  ✓ test_math[4-5-9] 0.01s
+  ⨯ test_math[10-20-50] 0.02s
+```
+
+### Test Classes
+
+Test classes are handled with proper nesting:
+
+```
+  PASS  tests/test_user.py
+  ✓ TestUser::test_creation 0.02s
+  ✓ TestUser::test_validation 0.01s
+```
+
+### Skipped and Expected Failures
+
+Different test outcomes have distinct symbols:
+
+- `✓` - Passed (green)
+- `⨯` - Failed (red)
+- `-` - Skipped (yellow)
+- `x` - Expected failure (yellow)
+- `X` - Unexpected pass (yellow)
+
+### Unicode Support
+
+If your terminal doesn't support ✓/✗ symbols, pytest-elegant automatically falls back to ASCII alternatives (`PASS`/`FAIL`).
+
+## Compatibility
+
+- **Python**: 3.14+
+- **pytest**: 7.0.0+
+- **Terminal**: Any terminal with ANSI color support
+- **Parallel testing**: Compatible with pytest-xdist
+
+## How It Works
+
+pytest-elegant is a pytest plugin that:
+
+1. Registers via the `pytest11` entry point
+2. Replaces pytest's default `TerminalReporter` with a custom one
+3. Customizes output formatting hooks to provide elegant, minimal output
+4. Uses pytest's built-in color support (no extra dependencies)
+
+## Development
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run specific test file
+pytest tests/test_reporter.py
+```
+
+### Type Checking
+
+```bash
+mypy src/pytest_elegant
+```
+
+### Linting
+
+```bash
+ruff check src/pytest_elegant
+```
+
+## Contributing
+
+Contributions welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new features
+4. Ensure all tests pass
+5. Submit a pull request
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Credits
+
+Heavily inspired by [Pest PHP](https://pestphp.com/) by Nuno Maduro and contributors.

pytest_elegant-0.1.0/README.md

@@ -0,0 +1,194 @@
+# pytest-elegant
+
+A pytest plugin that provides elegant, beautiful test output inspired by [Pest PHP](https://pestphp.com/)'s aesthetic.
+
+## Features
+
+- **Clean, minimal output** with ✓/✗ symbols instead of dots/F/E
+- **Colored results** - green for passing tests, red for failures, yellow for skipped
+- **File grouping** - Tests organized by file with PASS/FAIL headers
+- **Duration display** - See how long each test takes (e.g., `0.12s`)
+- **Immediate failure details** - See what went wrong right away with code context
+- **Zero configuration** - Just install and run `pytest` as usual
+- **Standard pytest syntax** - Keep your existing `def test_*` functions
+
+## Installation
+
+### Using uv (recommended)
+
+```bash
+uv add --dev pytest-elegant
+```
+
+### Using pip
+
+```bash
+pip install pytest-elegant
+```
+
+## Usage
+
+Once installed, pytest-elegant automatically transforms your pytest output. Just run:
+
+```bash
+pytest
+```
+
+That's it! No configuration needed.
+
+### Successful Example Output
+
+**Before (standard pytest):**
+
+![](assets/success-pytest.png)
+
+**After (with pytest-elegant):**
+
+![](assets/success-pytest-elegant.png)
+
+### Failure Example Output
+
+**Before (standard pytest):**
+
+![](assets/failure-pytest.png)
+
+**After (with pytest-elegant):**
+
+![](assets/failure-pytest-elegant.png)
+
+**After (with pytest-elegant with verbose mode):**
+
+![](assets/failure-pytest-elegant-verbose.png)
+
+## Configuration
+
+pytest-elegant works out of the box, but you can customize it via `pytest.ini` or `pyproject.toml`.
+
+### pyproject.toml
+
+```toml
+[tool.pytest.ini_options]
+elegant_show_context = true      # Show code context in failure output (default: true)
+elegant_group_by_file = true     # Group test results by file (default: true)
+elegant_show_duration = true     # Show test duration for each test (default: true)
+```
+
+### pytest.ini
+
+```ini
+[pytest]
+elegant_show_context = true
+elegant_group_by_file = true
+elegant_show_duration = true
+```
+
+## Disabling pytest-elegant
+
+If you need to temporarily disable pytest-elegant and see standard pytest output:
+
+```bash
+pytest --no-elegant
+```
+
+## Verbose Mode
+
+pytest-elegant respects pytest's verbosity flags:
+
+```bash
+pytest -v      # More details (full file paths, more context)
+pytest -vv     # Maximum details (full stack traces)
+```
+
+## Advanced Features
+
+### Parametrized Tests
+
+pytest-elegant beautifully formats parametrized tests, showing each parameter set:
+
+```
+  ✓ test_math[1-2-3] 0.01s
+  ✓ test_math[4-5-9] 0.01s
+  ⨯ test_math[10-20-50] 0.02s
+```
+
+### Test Classes
+
+Test classes are handled with proper nesting:
+
+```
+  PASS  tests/test_user.py
+  ✓ TestUser::test_creation 0.02s
+  ✓ TestUser::test_validation 0.01s
+```
+
+### Skipped and Expected Failures
+
+Different test outcomes have distinct symbols:
+
+- `✓` - Passed (green)
+- `⨯` - Failed (red)
+- `-` - Skipped (yellow)
+- `x` - Expected failure (yellow)
+- `X` - Unexpected pass (yellow)
+
+### Unicode Support
+
+If your terminal doesn't support ✓/✗ symbols, pytest-elegant automatically falls back to ASCII alternatives (`PASS`/`FAIL`).
+
+## Compatibility
+
+- **Python**: 3.14+
+- **pytest**: 7.0.0+
+- **Terminal**: Any terminal with ANSI color support
+- **Parallel testing**: Compatible with pytest-xdist
+
+## How It Works
+
+pytest-elegant is a pytest plugin that:
+
+1. Registers via the `pytest11` entry point
+2. Replaces pytest's default `TerminalReporter` with a custom one
+3. Customizes output formatting hooks to provide elegant, minimal output
+4. Uses pytest's built-in color support (no extra dependencies)
+
+## Development
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run specific test file
+pytest tests/test_reporter.py
+```
+
+### Type Checking
+
+```bash
+mypy src/pytest_elegant
+```
+
+### Linting
+
+```bash
+ruff check src/pytest_elegant
+```
+
+## Contributing
+
+Contributions welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new features
+4. Ensure all tests pass
+5. Submit a pull request
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Credits
+
+Heavily inspired by [Pest PHP](https://pestphp.com/) by Nuno Maduro and contributors.

pytest_elegant-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "pytest-elegant"
+version = "0.1.0"
+description = "A pytest plugin that provides elegant, beautiful test output"
+readme = "README.md"
+authors = [
+    { name = "Einenlum", email = "contact@einenlum.com" }
+]
+requires-python = ">=3.14"
+dependencies = [
+    "pytest>=7.0.0",
+    "rich>=13.0.0",
+]
+
+[project.entry-points.pytest11]
+pytest_elegant = "pytest_elegant.plugin"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_classes = "Test*"
+python_functions = "test_*"
+norecursedirs = ["fixtures"]
+
+# pytest-elegant configuration options (all default to true)
+# elegant_show_context = true      # Show code context in failure output
+# elegant_group_by_file = true     # Group test results by file with PASS/FAIL headers
+# elegant_show_duration = true     # Show test duration for each test
+
+[tool.ruff]
+line-length = 88
+target-version = "py314"
+
+[tool.mypy]
+python_version = "3.14"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[build-system]
+requires = ["uv_build>=0.9.7,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.19.1",
+    "ruff>=0.15.5",
+]

pytest_elegant-0.1.0/src/pytest_elegant/__init__.py

@@ -0,0 +1,72 @@
+"""pytest-elegant: Pytest plugin for elegant output.
+
+pytest-elegant transforms pytest's test output to provide elegant, beautiful formatting
+with minimal, clean output using ✓/✗ symbols, file grouping, and colored results.
+
+Features:
+    - Clean, minimal output with ✓/✗ symbols instead of dots/F/E
+    - Group tests by file with PASS/FAIL headers
+    - Show test duration for each test
+    - Display failures immediately with code context
+    - Colored output (green/red/yellow) for better readability
+    - Works with standard pytest `def test_*` syntax
+    - No changes to test code required
+
+Installation:
+    pip install pytest-elegant
+
+Usage:
+    Simply install the plugin and run pytest normally. pytest-elegant will automatically
+    format the output. To disable, use the --no-elegant flag:
+
+    pytest                # Elegant output (default)
+    pytest --no-elegant   # Standard pytest output
+
+Configuration:
+    Options can be set in pytest.ini or pyproject.toml:
+
+    [tool.pytest.ini_options]
+    elegant_show_context = true      # Show code context in failures
+    elegant_group_by_file = true     # Group tests by file
+    elegant_show_duration = true     # Show test durations
+
+Example Output:
+    PASS  tests/test_math.py
+    ✓ test_addition 0.01s
+    ✓ test_subtraction 0.01s
+
+    FAIL  tests/test_user.py
+    ✓ test_user_creation 0.05s
+    ⨯ test_user_validation 0.03s
+    ────────────────────────────────────────
+    AssertionError: assert False
+      File "tests/test_user.py", line 12
+    → 12   assert user.is_valid()
+
+    Tests: 3 passed, 1 failed, 4 total
+    Duration: 0.10s
+
+Modules:
+    plugin: Pytest hook implementations for integrating pytest-elegant
+    reporter: ElegantTerminalReporter class for formatting output
+    utils: Helper functions for formatting and terminal operations
+
+Classes:
+    ElegantTerminalReporter: Custom terminal reporter for elegant output
+
+Functions:
+    pytest_configure: Hook to register the custom reporter
+    pytest_report_teststatus: Hook to customize test status symbols
+"""
+
+__version__ = "0.1.0"
+
+from pytest_elegant.reporter import ElegantTerminalReporter
+from pytest_elegant.plugin import pytest_configure, pytest_report_teststatus
+
+__all__ = [
+    "__version__",
+    "ElegantTerminalReporter",
+    "pytest_configure",
+    "pytest_report_teststatus",
+]