pyplaykit 1.19.0__tar.gz → 1.19.2__tar.gz

{pyplaykit-1.19.0 → pyplaykit-1.19.2}/CHANGELOG.md

@@ -11,6 +11,22 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ---
 
+## [1.19.2] — 2026-07-24
+
+### Fixed
+
+- **Excel comparison demos now run out of the box** — `pyplaykit init` ships the eight sample workbooks that `tests/demo/functional/database/test_demo_excel.py` reads (`baseline.xlsx`, `current.xlsx`, `legacy_export.xlsx`, `new_system_export.xlsx`, `baseline_unordered.xlsx`, `current_unordered.xlsx`, `export_v1.xlsx`, `export_v2.xlsx`), generated at scaffold time via the new `_create_demo_excel_files()` (mirroring the bundled SQLite `demo.db`). Previously all four Excel demo tests skipped until the user manually placed files in `test_data/`. Degrades gracefully when `pandas`/`openpyxl` are absent at init time.
+
+---
+
+## [1.19.1] — 2026-07-24
+
+### Documentation
+
+- **README** — documented the `pyplaykit observability-report` HTML viewer under Reports and Artifacts → Observability, covering all invocation options (`--reports-dir`, `--output/-o`, `--open`), report contents, and the `summary.json` prerequisite.
+
+---
+
 ## [1.19.0] — 2026-07-24
 
 ### Added

{pyplaykit-1.19.0 → pyplaykit-1.19.2}/INIT_COMMAND_EXAMPLES.md

@@ -234,7 +234,7 @@ pytest tests/demo/functional/api/test_demo_api.py
 # UI tests (requires Playwright)
 pytest tests/demo/functional/ui/login/test_demo_login.py
 
-# Excel tests (place test files in test_data/)
+# Excel tests (run out of the box — sample workbooks ship in test_data/)
 pytest tests/demo/functional/database/test_demo_excel.py
 
 # Database tests (configure database in config/environments.yaml)
@@ -260,14 +260,22 @@ pytest tests/demo/functional/database/test_demo_db.py::test_migration_validation
 
 ### For Excel Tests
 
-1. Place your test files in `test_data/`:
-   ```
-   test_data/
-   ├── baseline.xlsx
-   ├── current.xlsx
-   ├── legacy_export.xlsx
-   └── new_system_export.xlsx
-   ```
+`pyplaykit init` already ships sample workbooks in `test_data/` (requires
+`pandas`/`openpyxl` at init time), so the four Excel demos run and pass out of
+the box:
+
+```
+test_data/
+├── baseline.xlsx            ├── baseline_unordered.xlsx
+├── current.xlsx             ├── current_unordered.xlsx
+├── legacy_export.xlsx       ├── export_v1.xlsx
+├── new_system_export.xlsx   └── export_v2.xlsx
+```
+
+To compare your own data, either replace those files or point the tests at new
+paths:
+
+1. Drop your files in `test_data/` (overwrite the samples or use new names).
 
 2. Update file paths in tests:
    ```python

{pyplaykit-1.19.0 → pyplaykit-1.19.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyplaykit
-Version: 1.19.0
+Version: 1.19.2
 Summary: Enterprise Python + Playwright automation framework
 Author-email: Shan Konduru <shankonduru@gmail.com>
 License: MIT
@@ -861,6 +861,31 @@ Each project config includes:
 - QA report: `reports/observability/qa_functional_report.json`
 - Leadership report: `reports/observability/leadership_kpi_report.json`
 
+**Viewing observability as an HTML report:** the reports above are JSON. To turn
+them into a single, self-contained, styled HTML report with a generation
+date/time stamp, run the `observability-report` CLI command after a pytest run:
+
+```bash
+# Default: reads reports/observability/, writes a timestamped HTML file there
+pyplaykit observability-report
+
+# Point at a different reports directory
+pyplaykit observability-report --reports-dir path/to/observability
+
+# Choose an explicit output file
+pyplaykit observability-report --output reports/observability/latest.html
+
+# Generate and open in the default web browser
+pyplaykit observability-report --open
+```
+
+The report includes a brand header with the generation timestamp and an overall
+PASSED / ATTENTION-NEEDED status pill, KPI cards (total, passed, failed, skipped,
+pass rate, flaky count, durations, automation coverage), leadership KPI metrics,
+a failed-tests table with failure classification, and a flaky-tests list. It
+requires that a pytest run has already written `summary.json`. See
+[docs/CLI_REFERENCE.md](docs/CLI_REFERENCE.md) for full option details.
+
 ### Integration Exports
 - Jira export: `reports/integrations/jira_export.json`
 - Test management: `reports/integrations/test_management_export.json`

{pyplaykit-1.19.0 → pyplaykit-1.19.2}/README.md

@@ -764,6 +764,31 @@ Each project config includes:
 - QA report: `reports/observability/qa_functional_report.json`
 - Leadership report: `reports/observability/leadership_kpi_report.json`
 
+**Viewing observability as an HTML report:** the reports above are JSON. To turn
+them into a single, self-contained, styled HTML report with a generation
+date/time stamp, run the `observability-report` CLI command after a pytest run:
+
+```bash
+# Default: reads reports/observability/, writes a timestamped HTML file there
+pyplaykit observability-report
+
+# Point at a different reports directory
+pyplaykit observability-report --reports-dir path/to/observability
+
+# Choose an explicit output file
+pyplaykit observability-report --output reports/observability/latest.html
+
+# Generate and open in the default web browser
+pyplaykit observability-report --open
+```
+
+The report includes a brand header with the generation timestamp and an overall
+PASSED / ATTENTION-NEEDED status pill, KPI cards (total, passed, failed, skipped,
+pass rate, flaky count, durations, automation coverage), leadership KPI metrics,
+a failed-tests table with failure classification, and a flaky-tests list. It
+requires that a pytest run has already written `summary.json`. See
+[docs/CLI_REFERENCE.md](docs/CLI_REFERENCE.md) for full option details.
+
 ### Integration Exports
 - Jira export: `reports/integrations/jira_export.json`
 - Test management: `reports/integrations/test_management_export.json`

{pyplaykit-1.19.0 → pyplaykit-1.19.2}/pyplaykit/cli.py

@@ -140,7 +140,11 @@ _EXAMPLE_EXCEL = '''\
 Prerequisites:
     pip install pandas openpyxl
 
-Place your Excel files in test_data/ and update the paths below.
+These tests run out of the box: ``pyplaykit init`` ships the sample workbooks
+they read (baseline.xlsx, current.xlsx, legacy_export.xlsx, etc.) into
+``test_data/``. Swap in your own files at the same paths to compare real data.
+They skip gracefully only if those workbooks are missing (e.g. pandas/openpyxl
+were not installed when the project was scaffolded).
 
 Run:
     pytest tests/demo/functional/database/test_demo_excel.py
@@ -593,6 +597,130 @@ def _create_demo_sqlite_db(test_data_dir: Path) -> None:
     print(f"  created  {db_path}  (SQLite demo database)")
 
 
+# Employee dataset shared by the Excel comparison demos. Kept in dict form so it
+# maps directly onto DataFrame columns / Excel headers.
+_DEMO_EXCEL_ROWS = [
+    {"employee_id": 1, "name": "Alice Johnson", "department": "Engineering", "salary": 95000.00},
+    {"employee_id": 2, "name": "Bob Smith", "department": "Sales", "salary": 72000.00},
+    {"employee_id": 3, "name": "Carla Diaz", "department": "Marketing", "salary": 68000.50},
+    {"employee_id": 4, "name": "Devon Lee", "department": "Engineering", "salary": 88000.00},
+    {"employee_id": 5, "name": "Emma Brown", "department": "Finance", "salary": 79000.75},
+]
+
+
+def _create_demo_excel_files(test_data_dir: Path) -> None:
+    """Ship the sample .xlsx workbooks the Excel comparison demos expect.
+
+    ``test_demo_excel.py`` reads eight fixed-path workbooks from ``test_data/``
+    and skips when they are absent. Generating them here at ``pyplaykit init``
+    time means all four Excel demos run and pass out of the box — the same
+    zero-setup guarantee the SQLite database demos already enjoy. Each pair is
+    crafted so its specific comparison (identical, column-mapped, unordered,
+    metadata-ignored) succeeds. Existing files are left untouched.
+
+    Degrades gracefully: if pandas/openpyxl are not installed at init time the
+    demos simply keep skipping until the user installs them and re-runs init.
+    """
+    try:
+        import pandas as pd
+    except ImportError:
+        print(
+            "  skipped  Excel demo workbooks (install 'pandas openpyxl' and "
+            "re-run 'pyplaykit init' to generate them)"
+        )
+        return
+
+    def write(name: str, rows: list[dict]) -> None:
+        path = test_data_dir / name
+        if path.exists():
+            return
+        try:
+            pd.DataFrame(rows).to_excel(path, index=False)
+        except ImportError:
+            # openpyxl missing — pandas raises at write time.
+            raise
+        print(f"  created  {path}  (Excel demo data)")
+
+    base = _DEMO_EXCEL_ROWS
+
+    try:
+        # 1. test_excel_files_match — identical business data; the ignored
+        #    timestamp/run_id columns differ so the demo exercises ignore_fields.
+        write("baseline.xlsx", [
+            {**r, "timestamp": "2026-01-01T00:00:00", "run_id": "run-001"} for r in base
+        ])
+        write("current.xlsx", [
+            {**r, "timestamp": "2026-07-24T09:30:00", "run_id": "run-999"} for r in base
+        ])
+
+        # 2. test_excel_with_column_mapping — legacy abbreviated columns vs new
+        #    system names; identical values once mapped. System timestamps differ
+        #    and are ignored.
+        write("legacy_export.xlsx", [
+            {
+                "emp_id": r["employee_id"], "emp_name": r["name"],
+                "emp_dept": r["department"], "emp_sal": r["salary"],
+                "created_at": "2020-01-01", "modified_at": "2020-01-01",
+            }
+            for r in base
+        ])
+        write("new_system_export.xlsx", [
+            {
+                "employee_id": r["employee_id"], "name": r["name"],
+                "department": r["department"], "salary": r["salary"],
+                "created_at": "2026-07-24", "modified_at": "2026-07-24",
+            }
+            for r in base
+        ])
+
+        # 3. test_excel_unordered_data — same rows, shuffled order; matched by the
+        #    composite key (order_id, line_number). Ignored export metadata differs.
+        order_rows = [
+            {"order_id": 1001, "line_number": 1, "sku": "A-100", "qty": 2, "amount": 40.00},
+            {"order_id": 1001, "line_number": 2, "sku": "B-200", "qty": 1, "amount": 15.50},
+            {"order_id": 1002, "line_number": 1, "sku": "C-300", "qty": 5, "amount": 99.99},
+            {"order_id": 1003, "line_number": 1, "sku": "D-400", "qty": 3, "amount": 60.00},
+        ]
+        write("baseline_unordered.xlsx", [
+            {**r, "export_timestamp": "2026-01-01T00:00:00", "batch_id": "b-001"}
+            for r in order_rows
+        ])
+        # Reverse the row order to prove key-based matching, not positional.
+        write("current_unordered.xlsx", [
+            {**r, "export_timestamp": "2026-07-24T09:30:00", "batch_id": "b-999"}
+            for r in reversed(order_rows)
+        ])
+
+        # 4. test_excel_ignore_metadata_columns — identical business data keyed by
+        #    product_id; only the system metadata columns differ (all ignored).
+        product_rows = [
+            {"product_id": "SKU-1", "product_name": "Widget", "price": 9.99, "in_stock": 120},
+            {"product_id": "SKU-2", "product_name": "Gadget", "price": 19.95, "in_stock": 45},
+            {"product_id": "SKU-3", "product_name": "Gizmo", "price": 4.50, "in_stock": 300},
+        ]
+        write("export_v1.xlsx", [
+            {
+                **r, "timestamp": "2026-01-01", "created_at": "2026-01-01",
+                "updated_at": "2026-01-01", "created_by": "etl", "modified_by": "etl",
+                "row_version": 1, "etl_batch_id": "e-001", "export_id": "x-001",
+            }
+            for r in product_rows
+        ])
+        write("export_v2.xlsx", [
+            {
+                **r, "timestamp": "2026-07-24", "created_at": "2026-07-24",
+                "updated_at": "2026-07-24", "created_by": "svc", "modified_by": "svc",
+                "row_version": 7, "etl_batch_id": "e-999", "export_id": "x-999",
+            }
+            for r in product_rows
+        ])
+    except ImportError:
+        print(
+            "  skipped  Excel demo workbooks (install 'openpyxl' and re-run "
+            "'pyplaykit init' to generate them)"
+        )
+
+
 _DEMO_README = '''# Demo Tests
 
 Runnable **reference tests** that demonstrate PyPlayKit features. They mirror
@@ -621,8 +749,9 @@ tests/demo/
 - **API** — targets the public https://jsonplaceholder.typicode.com service.
 - **Database** — uses the bundled `test_data/demo.db` SQLite database created
   by `pyplaykit init`. No PostgreSQL/MySQL server required.
-- **Excel** — skips gracefully until you drop sample `.xlsx` files in
-  `test_data/`.
+- **Excel** — runs against sample `.xlsx` workbooks that `pyplaykit init` ships
+  in `test_data/` (requires `pandas`/`openpyxl`); swap in your own files at the
+  same paths to compare real data.
 
 ## Running the demos
 ```bash
@@ -1455,6 +1584,9 @@ def _create_demo_structure(tests_root: Path, test_data_dir: Path) -> None:
     # Bundled SQLite demo database that the database demos read from.
     _create_demo_sqlite_db(test_data_dir)
 
+    # Bundled sample workbooks so the Excel comparison demos run out of the box.
+    _create_demo_excel_files(test_data_dir)
+
 
 def _create_functional_structure(functional: Path, tests_root: Path) -> None:
     """Create the ui/api/database functional test tree plus category READMEs."""

{pyplaykit-1.19.0 → pyplaykit-1.19.2}/pyplaykit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyplaykit
-Version: 1.19.0
+Version: 1.19.2
 Summary: Enterprise Python + Playwright automation framework
 Author-email: Shan Konduru <shankonduru@gmail.com>
 License: MIT
@@ -861,6 +861,31 @@ Each project config includes:
 - QA report: `reports/observability/qa_functional_report.json`
 - Leadership report: `reports/observability/leadership_kpi_report.json`
 
+**Viewing observability as an HTML report:** the reports above are JSON. To turn
+them into a single, self-contained, styled HTML report with a generation
+date/time stamp, run the `observability-report` CLI command after a pytest run:
+
+```bash
+# Default: reads reports/observability/, writes a timestamped HTML file there
+pyplaykit observability-report
+
+# Point at a different reports directory
+pyplaykit observability-report --reports-dir path/to/observability
+
+# Choose an explicit output file
+pyplaykit observability-report --output reports/observability/latest.html
+
+# Generate and open in the default web browser
+pyplaykit observability-report --open
+```
+
+The report includes a brand header with the generation timestamp and an overall
+PASSED / ATTENTION-NEEDED status pill, KPI cards (total, passed, failed, skipped,
+pass rate, flaky count, durations, automation coverage), leadership KPI metrics,
+a failed-tests table with failure classification, and a flaky-tests list. It
+requires that a pytest run has already written `summary.json`. See
+[docs/CLI_REFERENCE.md](docs/CLI_REFERENCE.md) for full option details.
+
 ### Integration Exports
 - Jira export: `reports/integrations/jira_export.json`
 - Test management: `reports/integrations/test_management_export.json`

{pyplaykit-1.19.0 → pyplaykit-1.19.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyplaykit"
-version = "1.19.0"
+version = "1.19.2"
 description = "Enterprise Python + Playwright automation framework"
 readme = "README.md"
 license = { text = "MIT" }