behave-modern-html-report 1.0.0__tar.gz

behave_modern_html_report-1.0.0/.gitignore

@@ -0,0 +1,26 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.env
+.tox/
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+
+# Generated artifacts
+examples/demo-report.html
+report.html
+*.html.bak
+
+# IDE
+.vscode/
+.idea/
+*.swp

behave_modern_html_report-1.0.0/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-06-28
+
+### Added
+
+- New **Tags** page with per-tag scenario counts, pass rate, duration, and a pass-rate chart.
+- `behave_modern_html_report.attach` helper API: `attach_screenshot`, `attach_file`, `attach_text`, `attach_json`, `log` for easy `environment.py` integration.
+- **JSON sidecar output** (`bmr.json_sidecar = true`) writes `report.json` next to the HTML report.
+- Inline step duration bar showing each step's relative cost within the scenario.
+- Copy-reproduce-command button on every scenario (`behave features/example.feature:3`).
+
+### Changed
+
+- Promoted PyPI classifier from `Beta` to `Production/Stable`.
+- README badges now point to PyPI and CI.
+
+## [0.1.0] - 2026-06-28
+
+### Added
+
+- Initial release of **Behave Modern Report**.
+- Layered architecture: `formatter`, `collector`, `models`, `statistics`, `renderer`, `assets`.
+- Single-file, fully offline HTML report.
+- Dark / Light / Auto themes.
+- Dashboard with execution summary and environment metadata.
+- Interactive Chart.js statistics (status pie, duration bar, slowest scenarios).
+- Sidebar navigation: Dashboard, Features, Scenarios, Statistics, Environment.
+- Client-side instant search and multi-criteria filtering.
+- Expandable features, scenarios and steps with rich metadata.
+- Modern error viewer with copy-to-clipboard.
+- Attachment support (images, text, JSON, etc.) with lightbox gallery.
+- Configurable title, company, logo, custom CSS/JS.
+- Accessibility: keyboard navigation, ARIA labels, high-contrast palette.
+- GitHub Actions CI workflow (ruff + pytest).

behave_modern_html_report-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Behave Modern Report Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

behave_modern_html_report-1.0.0/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: behave-modern-html-report
+Version: 1.0.0
+Summary: The modern, beautiful, single-file HTML report formatter for Behave.
+Project-URL: Homepage, https://github.com/MathiasPaulenko/behave-modern-html-report
+Project-URL: Repository, https://github.com/MathiasPaulenko/behave-modern-html-report
+Project-URL: Issues, https://github.com/MathiasPaulenko/behave-modern-html-report/issues
+Author-email: Mathias Paulenko <mathias.paulenko@outlook.com>
+Maintainer-email: Mathias Paulenko <mathias.paulenko@outlook.com>
+License: MIT
+License-File: LICENSE
+Keywords: bdd,behave,formatter,html,report,testing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing :: BDD
+Requires-Python: >=3.11
+Requires-Dist: behave<2,>=1.2.6
+Requires-Dist: jinja2>=3.1
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Behave Modern HTML Report
+
+> The modern, beautiful, single-file HTML report formatter for [Behave](https://behave.readthedocs.io/).
+> Dark mode, charts, instant search, attachments, zero external requests.
+
+[![PyPI](https://img.shields.io/pypi/v/behave-modern-html-report.svg)](https://pypi.org/project/behave-modern-html-report/)
+[![Python](https://img.shields.io/pypi/pyversions/behave-modern-html-report.svg)](https://pypi.org/project/behave-modern-html-report/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![CI](https://github.com/MathiasPaulenko/behave-modern-html-report/actions/workflows/ci.yml/badge.svg)](https://github.com/MathiasPaulenko/behave-modern-html-report/actions/workflows/ci.yml)
+
+`behave-modern-html-report` is a drop-in formatter for Behave that produces a single,
+self-contained HTML file — everything (CSS, JS, fonts, icons, attachments) is
+embedded so the report works offline, on any machine, forever.
+
+## Features
+
+- 🌓 **Dark / Light / Auto** themes, modern Material-3 inspired UI
+- 📊 **Interactive charts** (status pie, duration histogram, slowest scenarios, tag pass rate, timeline) — pure vanilla JS, no Chart.js CDN
+- 🏷️ **Tag analytics** page: per-tag counts, pass rate, duration, and a dedicated chart
+- � **Gherkin Rules** support: scenarios under a `Rule` are grouped and tagged correctly (Behave 1.3.x)
+- �🔍 **Instant client-side search** across features, scenarios, steps and tags
+- 🎚️ **Filter by status** with one click
+- 📁 **Expandable** features → scenarios → steps with rich metadata
+- 🧯 **Modern error viewer** with copy-to-clipboard tracebacks
+- 🖼️ **Attachments**: images (with lightbox), JSON, text, binaries
+- 🚀 **Copy-reproduce-command** per scenario (`behave features/example.feature:3`)
+- 📊 **Inline step duration bars** to spot slow steps at a glance
+- ♿ **Accessible**: keyboard navigation, ARIA labels, reduced-motion support
+- 📦 **Single HTML file**, works offline, no web server, no CDN
+- 🧩 **Clean architecture** — formatter / collector / models / renderer separation, fully testable
+- 🛠️ **Extensible** — custom CSS/JS, custom title/logo/company, JSON sidecar, future plugin system
+
+## Installation
+
+```bash
+pip install behave-modern-html-report
+```
+
+## Quick start
+
+In your project's `behave.ini` (or `setup.cfg`):
+
+```ini
+[behave.formatters]
+modern = behave_modern_html_report.formatter:ModernHTMLFormatter
+```
+
+Then run:
+
+```bash
+behave -f modern -o report.html
+```
+
+Open `report.html` in any browser. Done.
+
+## Configuration
+
+All options are read from `behave`'s `userdata`:
+
+```ini
+[behave.userdata]
+bmr.title         = My Awesome Suite
+bmr.company       = Acme Inc.
+bmr.logo          = https://example.com/logo.svg
+bmr.theme         = auto          ; auto | dark | light
+bmr.json_sidecar  = true          ; writes report.json next to report.html
+bmr.custom_css    = path/to/extra.css
+bmr.custom_js     = path/to/extra.js
+```
+
+## Behave 1.3.x and Gherkin Rules compatibility
+
+`behave-modern-html-report` is tested against Behave 1.3.x and fully supports the Gherkin `Rule` keyword.
+
+- Scenarios under a `Rule` keep their parent rule name and inherit their Rule tags correctly.
+- Extended final statuses (`error`, `hook_error`, `cleanup_error`, `xfailed`, `xpassed`, `pending_warn`) are normalised and displayed in the UI.
+- Error-like statuses are grouped as failures for feature status and tag analytics.
+
+```gherkin
+Feature: Checkout
+
+  Rule: Payment required
+    @payment
+    Scenario: Card payment succeeds
+      Given the user has items in cart
+      When they pay with a valid card
+      Then the order is confirmed
+```
+
+## Attachments from your `environment.py`
+
+Use the public helper API — no need to reach into the formatter:
+
+```python
+from behave_modern_html_report import attach_screenshot, attach_text, log
+
+def after_step(context, step):
+    if step.status == "failed":
+        attach_screenshot(context, context.browser, name="failure.png")
+        attach_text(context, str(step.exception), name="error.txt")
+        log(f"URL at failure: {context.browser.current_url}")
+```
+
+The helpers also work with Playwright, Selenium, PIL images, bytes, files, and JSON data.
+
+## Generate a demo without running Behave
+
+```bash
+python examples/generate_demo.py
+```
+
+This builds `examples/demo-report.html` with a realistic-looking suite —
+useful for previews, screenshots, and design iteration.
+
+## Architecture
+
+```text
+behave events
+    │
+    ▼
+ formatter.py ── thin adapter
+    │
+    ▼
+ collector.py ── builds the model tree
+    │
+    ▼
+   models.py  ── pure dataclasses
+                (Execution → Feature → Rule-aware Scenario → Step)
+    │
+    ▼
+ statistics.py ── aggregates counters, durations, buckets
+    │
+    ▼
+ renderer.py  + templates/ + assets/  ── Jinja2 → single HTML file
+```
+
+The renderer is **independent of Behave**, so any tool that can produce an
+`Execution` object (e.g. a JSON loader) can use it.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+ruff check .
+```
+
+## License
+
+[MIT](LICENSE) © Mathias Paulenko

behave_modern_html_report-1.0.0/README.md

@@ -0,0 +1,150 @@
+# Behave Modern HTML Report
+
+> The modern, beautiful, single-file HTML report formatter for [Behave](https://behave.readthedocs.io/).
+> Dark mode, charts, instant search, attachments, zero external requests.
+
+[![PyPI](https://img.shields.io/pypi/v/behave-modern-html-report.svg)](https://pypi.org/project/behave-modern-html-report/)
+[![Python](https://img.shields.io/pypi/pyversions/behave-modern-html-report.svg)](https://pypi.org/project/behave-modern-html-report/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![CI](https://github.com/MathiasPaulenko/behave-modern-html-report/actions/workflows/ci.yml/badge.svg)](https://github.com/MathiasPaulenko/behave-modern-html-report/actions/workflows/ci.yml)
+
+`behave-modern-html-report` is a drop-in formatter for Behave that produces a single,
+self-contained HTML file — everything (CSS, JS, fonts, icons, attachments) is
+embedded so the report works offline, on any machine, forever.
+
+## Features
+
+- 🌓 **Dark / Light / Auto** themes, modern Material-3 inspired UI
+- 📊 **Interactive charts** (status pie, duration histogram, slowest scenarios, tag pass rate, timeline) — pure vanilla JS, no Chart.js CDN
+- 🏷️ **Tag analytics** page: per-tag counts, pass rate, duration, and a dedicated chart
+- � **Gherkin Rules** support: scenarios under a `Rule` are grouped and tagged correctly (Behave 1.3.x)
+- �🔍 **Instant client-side search** across features, scenarios, steps and tags
+- 🎚️ **Filter by status** with one click
+- 📁 **Expandable** features → scenarios → steps with rich metadata
+- 🧯 **Modern error viewer** with copy-to-clipboard tracebacks
+- 🖼️ **Attachments**: images (with lightbox), JSON, text, binaries
+- 🚀 **Copy-reproduce-command** per scenario (`behave features/example.feature:3`)
+- 📊 **Inline step duration bars** to spot slow steps at a glance
+- ♿ **Accessible**: keyboard navigation, ARIA labels, reduced-motion support
+- 📦 **Single HTML file**, works offline, no web server, no CDN
+- 🧩 **Clean architecture** — formatter / collector / models / renderer separation, fully testable
+- 🛠️ **Extensible** — custom CSS/JS, custom title/logo/company, JSON sidecar, future plugin system
+
+## Installation
+
+```bash
+pip install behave-modern-html-report
+```
+
+## Quick start
+
+In your project's `behave.ini` (or `setup.cfg`):
+
+```ini
+[behave.formatters]
+modern = behave_modern_html_report.formatter:ModernHTMLFormatter
+```
+
+Then run:
+
+```bash
+behave -f modern -o report.html
+```
+
+Open `report.html` in any browser. Done.
+
+## Configuration
+
+All options are read from `behave`'s `userdata`:
+
+```ini
+[behave.userdata]
+bmr.title         = My Awesome Suite
+bmr.company       = Acme Inc.
+bmr.logo          = https://example.com/logo.svg
+bmr.theme         = auto          ; auto | dark | light
+bmr.json_sidecar  = true          ; writes report.json next to report.html
+bmr.custom_css    = path/to/extra.css
+bmr.custom_js     = path/to/extra.js
+```
+
+## Behave 1.3.x and Gherkin Rules compatibility
+
+`behave-modern-html-report` is tested against Behave 1.3.x and fully supports the Gherkin `Rule` keyword.
+
+- Scenarios under a `Rule` keep their parent rule name and inherit their Rule tags correctly.
+- Extended final statuses (`error`, `hook_error`, `cleanup_error`, `xfailed`, `xpassed`, `pending_warn`) are normalised and displayed in the UI.
+- Error-like statuses are grouped as failures for feature status and tag analytics.
+
+```gherkin
+Feature: Checkout
+
+  Rule: Payment required
+    @payment
+    Scenario: Card payment succeeds
+      Given the user has items in cart
+      When they pay with a valid card
+      Then the order is confirmed
+```
+
+## Attachments from your `environment.py`
+
+Use the public helper API — no need to reach into the formatter:
+
+```python
+from behave_modern_html_report import attach_screenshot, attach_text, log
+
+def after_step(context, step):
+    if step.status == "failed":
+        attach_screenshot(context, context.browser, name="failure.png")
+        attach_text(context, str(step.exception), name="error.txt")
+        log(f"URL at failure: {context.browser.current_url}")
+```
+
+The helpers also work with Playwright, Selenium, PIL images, bytes, files, and JSON data.
+
+## Generate a demo without running Behave
+
+```bash
+python examples/generate_demo.py
+```
+
+This builds `examples/demo-report.html` with a realistic-looking suite —
+useful for previews, screenshots, and design iteration.
+
+## Architecture
+
+```text
+behave events
+    │
+    ▼
+ formatter.py ── thin adapter
+    │
+    ▼
+ collector.py ── builds the model tree
+    │
+    ▼
+   models.py  ── pure dataclasses
+                (Execution → Feature → Rule-aware Scenario → Step)
+    │
+    ▼
+ statistics.py ── aggregates counters, durations, buckets
+    │
+    ▼
+ renderer.py  + templates/ + assets/  ── Jinja2 → single HTML file
+```
+
+The renderer is **independent of Behave**, so any tool that can produce an
+`Execution` object (e.g. a JSON loader) can use it.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+ruff check .
+```
+
+## License
+
+[MIT](LICENSE) © Mathias Paulenko

behave_modern_html_report-1.0.0/behave_modern_html_report/__init__.py

@@ -0,0 +1,42 @@
+"""Behave Modern Report.
+
+The modern, beautiful, single-file HTML report formatter for Behave.
+
+Public API:
+    ModernHTMLFormatter -- the Behave entry point.
+    Renderer           -- standalone renderer (Behave-independent).
+    Collector          -- builds an execution model from formatter events.
+    models             -- dataclasses representing the execution tree.
+    attach_file        -- attach a file to the current step.
+    attach_text        -- attach a text snippet to the current step.
+    attach_json        -- attach JSON data to the current step.
+    attach_screenshot  -- attach a screenshot to the current step.
+    log                -- append a log line to the current step.
+"""
+
+from __future__ import annotations
+
+from .attach import (
+    attach_file,
+    attach_json,
+    attach_screenshot,
+    attach_text,
+    log,
+)
+from .collector import Collector
+from .formatter import ModernHTMLFormatter
+from .renderer import Renderer
+
+__all__ = [
+    "ModernHTMLFormatter",
+    "Renderer",
+    "Collector",
+    "attach_file",
+    "attach_text",
+    "attach_json",
+    "attach_screenshot",
+    "log",
+    "__version__",
+]
+
+__version__ = "1.0.0"