pyplaykit 1.5.0__tar.gz → 1.7.0__tar.gz

{pyplaykit-1.5.0 → pyplaykit-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyplaykit
-Version: 1.5.0
+Version: 1.7.0
 Summary: Enterprise Python + Playwright automation framework
 Author-email: Shan Konduru <shankonduru@gmail.com>
 License: MIT
@@ -33,6 +33,9 @@ Requires-Dist: jmespath>=1.0.0
 Requires-Dist: xlrd>=2.0.1
 Requires-Dist: zeep>=4.2.1
 Requires-Dist: gql[httpx]>=3.5.0
+Provides-Extra: data-comparison
+Requires-Dist: pandas>=2.0.0; extra == "data-comparison"
+Requires-Dist: openpyxl>=3.1.0; extra == "data-comparison"
 
 # PyPlayKit - Enterprise Test Automation Framework
 
@@ -449,13 +452,18 @@ PyPlayKit provides comprehensive data comparison capabilities using the built-in
 ### Prerequisites for Data Comparison
 
 ```bash
-# Install data comparison dependencies
+# Option 1: Install with optional dependencies
+pip install pyplaykit[data-comparison]
+
+# Option 2: Install dependencies separately
 pip install pandas openpyxl
 
-# Or use the examples requirements file
+# Option 3: Use the examples requirements file
 pip install -r examples/requirements.txt
 ```
 
+**Note**: Data comparison features require pandas and openpyxl. The framework will work without them for UI/API/Database testing.
+
 ### Supported Comparison Types
 
 | Comparison Type | Use Case | Example |
@@ -466,22 +474,44 @@ pip install -r examples/requirements.txt
 
 ### Quick Example: Excel-to-Excel Comparison
 
+**Simple One-Line API** (Recommended for QE Engineers):
+
+```python
+import pytest
+from utils.data_comparison_utils import compare_excel_files
+
+@pytest.mark.data
+def test_compare_excel_files(logger):
+    # ONE function call - framework handles everything!
+    result = compare_excel_files(
+        source_file="report_baseline.xlsx",
+        target_file="report_current.xlsx",
+        float_tolerance=0.01
+    )
+    
+    # Check results
+    logger.info(f"{result.summary}")
+    logger.info(f"HTML Report: {result.report_path}")
+    
+    if not result.passed:
+        pytest.fail(f"Validation failed! {result.failed_count} discrepancies found.")
+```
+
+**Manual Validation** (For custom logic):
+
 ```python
 import pytest
 import pandas as pd
-from pathlib import Path
 from pyplaykit import DataValidator
 
 @pytest.mark.data
-def test_compare_excel_files(logger):
-    # Read both files
-    df1 = pd.read_excel("report_baseline.xlsx")
-    df2 = pd.read_excel("report_current.xlsx")
+def test_compare_with_custom_logic(logger):
+    df1 = pd.read_excel("baseline.xlsx")
+    df2 = pd.read_excel("current.xlsx")
     
     records1 = df1.to_dict('records')
     records2 = df2.to_dict('records')
     
-    # Compare row by row
     for idx, (r1, r2) in enumerate(zip(records1, records2)):
         DataValidator.assert_records_equal(r1, r2)
     
@@ -512,29 +542,61 @@ pytest examples/data_comparison_examples.py::test_excel_to_excel_basic -v -s
 
 ### Interactive HTML Reports ⭐ **NEW**
 
-Generate filterable, searchable HTML validation reports:
+**Option 1: Automatic Report Generation** (Recommended):
+
+```python
+from utils.data_comparison_utils import compare_excel_files
+
+# Framework automatically tracks ALL mismatches and generates HTML report
+result = compare_excel_files(
+    source_file="baseline.xlsx",
+    target_file="current.xlsx",
+    float_tolerance=0.01
+)
+
+# Result includes:
+print(f"Passed: {result.passed}")
+print(f"Matched: {result.passed_count}")
+print(f"Failed: {result.failed_count}")
+print(f"Total Mismatches: {result.total_mismatches}")
+print(f"Report: {result.report_path}")
+```
+
+**Available Functions:**
+
+*File-to-File:*
+- `compare_excel_files()` - Excel to Excel
+- `compare_csv_files()` - CSV to CSV
+
+*File-to-Database:*
+- `compare_excel_to_db()` - Excel to Database
+- `compare_csv_to_db()` - CSV to Database
+
+*Database-to-File:*
+- `compare_db_to_excel()` - Database to Excel
+- `compare_db_to_csv()` - Database to CSV
+
+*Database-to-Database:*
+- `compare_db_to_db()` - Database to Database
+
+*Advanced:*
+- `compare_dataframes()` - DataFrame to DataFrame (custom sources)
+
+**Option 2: Manual Report Building** (Advanced):
 
 ```python
 from utils.data_comparison_report import DataComparisonReport
 
-# Initialize report
+# For custom comparison logic
 report = DataComparisonReport()
 report.set_comparison_type("FILE_TO_FILE (Excel)")
 report.set_source("baseline.xlsx", 100)
 report.set_target("current.xlsx", 100)
 
-# Add mismatch
-report.add_mismatch(
-    mismatch_type="VALUE_MISMATCH",
-    row_index=5,
-    mismatching_fields=["Price"],
-    source_value=99.99,
-    target_value=100.00,
-    reason="Price increased by $0.01"
-)
+# Your custom comparison logic here...
+# report.add_mismatch(...) for each discrepancy
 
-# Generate interactive HTML report
-report.generate_report("reports/data_validation/report.html")
+report.generate_report("reports/validation.html")
 ```
 
 **Report Features:**
@@ -543,8 +605,11 @@ report.generate_report("reports/data_validation/report.html")
 - 📋 Row-by-row mismatch details
 - 🎨 Color-coded status indicators
 - 📱 Mobile-responsive design
+- ⚡ Zero manual mismatch tracking required!
 
-See **[examples/data_comparison_with_html_report.py](examples/data_comparison_with_html_report.py)** for complete examples.
+**Examples:**
+- **Simple API**: [examples/simple_comparison_examples.py](examples/simple_comparison_examples.py) ⭐ **Recommended**
+- **Manual Building**: [examples/data_comparison_with_html_report.py](examples/data_comparison_with_html_report.py)
 
 ### Full Documentation
 

pyplaykit-1.5.0/pyplaykit.egg-info/PKG-INFO → pyplaykit-1.7.0/README.md

@@ -1,39 +1,3 @@
-Metadata-Version: 2.4
-Name: pyplaykit
-Version: 1.5.0
-Summary: Enterprise Python + Playwright automation framework
-Author-email: Shan Konduru <shankonduru@gmail.com>
-License: MIT
-Project-URL: Homepage, https://github.com/ShanKonduru/pyplaykit
-Project-URL: Repository, https://github.com/ShanKonduru/pyplaykit
-Project-URL: Bug Tracker, https://github.com/ShanKonduru/pyplaykit/issues
-Keywords: playwright,pytest,automation,framework,enterprise,testing,page-object-model
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Framework :: Pytest
-Classifier: Topic :: Software Development :: Testing
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: playwright==1.54.0
-Requires-Dist: pytest==9.1.1
-Requires-Dist: pytest-cov==7.1.0
-Requires-Dist: pytest-xdist==3.8.0
-Requires-Dist: pytest-rerunfailures==16.4
-Requires-Dist: pytest-html==4.2.0
-Requires-Dist: allure-pytest==2.16.0
-Requires-Dist: PyYAML==6.0.2
-Requires-Dist: python-dotenv>=1.0.0
-Requires-Dist: httpx>=0.27.0
-Requires-Dist: jmespath>=1.0.0
-Requires-Dist: xlrd>=2.0.1
-Requires-Dist: zeep>=4.2.1
-Requires-Dist: gql[httpx]>=3.5.0
-
 # PyPlayKit - Enterprise Test Automation Framework
 
 **Tagline**: A modular, scalable, and CI/CD-ready Python + Playwright framework for enterprise automation supporting multiple projects and 50+ QE engineers.
@@ -449,13 +413,18 @@ PyPlayKit provides comprehensive data comparison capabilities using the built-in
 ### Prerequisites for Data Comparison
 
 ```bash
-# Install data comparison dependencies
+# Option 1: Install with optional dependencies
+pip install pyplaykit[data-comparison]
+
+# Option 2: Install dependencies separately
 pip install pandas openpyxl
 
-# Or use the examples requirements file
+# Option 3: Use the examples requirements file
 pip install -r examples/requirements.txt
 ```
 
+**Note**: Data comparison features require pandas and openpyxl. The framework will work without them for UI/API/Database testing.
+
 ### Supported Comparison Types
 
 | Comparison Type | Use Case | Example |
@@ -466,22 +435,44 @@ pip install -r examples/requirements.txt
 
 ### Quick Example: Excel-to-Excel Comparison
 
+**Simple One-Line API** (Recommended for QE Engineers):
+
+```python
+import pytest
+from utils.data_comparison_utils import compare_excel_files
+
+@pytest.mark.data
+def test_compare_excel_files(logger):
+    # ONE function call - framework handles everything!
+    result = compare_excel_files(
+        source_file="report_baseline.xlsx",
+        target_file="report_current.xlsx",
+        float_tolerance=0.01
+    )
+    
+    # Check results
+    logger.info(f"{result.summary}")
+    logger.info(f"HTML Report: {result.report_path}")
+    
+    if not result.passed:
+        pytest.fail(f"Validation failed! {result.failed_count} discrepancies found.")
+```
+
+**Manual Validation** (For custom logic):
+
 ```python
 import pytest
 import pandas as pd
-from pathlib import Path
 from pyplaykit import DataValidator
 
 @pytest.mark.data
-def test_compare_excel_files(logger):
-    # Read both files
-    df1 = pd.read_excel("report_baseline.xlsx")
-    df2 = pd.read_excel("report_current.xlsx")
+def test_compare_with_custom_logic(logger):
+    df1 = pd.read_excel("baseline.xlsx")
+    df2 = pd.read_excel("current.xlsx")
     
     records1 = df1.to_dict('records')
     records2 = df2.to_dict('records')
     
-    # Compare row by row
     for idx, (r1, r2) in enumerate(zip(records1, records2)):
         DataValidator.assert_records_equal(r1, r2)
     
@@ -512,29 +503,61 @@ pytest examples/data_comparison_examples.py::test_excel_to_excel_basic -v -s
 
 ### Interactive HTML Reports ⭐ **NEW**
 
-Generate filterable, searchable HTML validation reports:
+**Option 1: Automatic Report Generation** (Recommended):
+
+```python
+from utils.data_comparison_utils import compare_excel_files
+
+# Framework automatically tracks ALL mismatches and generates HTML report
+result = compare_excel_files(
+    source_file="baseline.xlsx",
+    target_file="current.xlsx",
+    float_tolerance=0.01
+)
+
+# Result includes:
+print(f"Passed: {result.passed}")
+print(f"Matched: {result.passed_count}")
+print(f"Failed: {result.failed_count}")
+print(f"Total Mismatches: {result.total_mismatches}")
+print(f"Report: {result.report_path}")
+```
+
+**Available Functions:**
+
+*File-to-File:*
+- `compare_excel_files()` - Excel to Excel
+- `compare_csv_files()` - CSV to CSV
+
+*File-to-Database:*
+- `compare_excel_to_db()` - Excel to Database
+- `compare_csv_to_db()` - CSV to Database
+
+*Database-to-File:*
+- `compare_db_to_excel()` - Database to Excel
+- `compare_db_to_csv()` - Database to CSV
+
+*Database-to-Database:*
+- `compare_db_to_db()` - Database to Database
+
+*Advanced:*
+- `compare_dataframes()` - DataFrame to DataFrame (custom sources)
+
+**Option 2: Manual Report Building** (Advanced):
 
 ```python
 from utils.data_comparison_report import DataComparisonReport
 
-# Initialize report
+# For custom comparison logic
 report = DataComparisonReport()
 report.set_comparison_type("FILE_TO_FILE (Excel)")
 report.set_source("baseline.xlsx", 100)
 report.set_target("current.xlsx", 100)
 
-# Add mismatch
-report.add_mismatch(
-    mismatch_type="VALUE_MISMATCH",
-    row_index=5,
-    mismatching_fields=["Price"],
-    source_value=99.99,
-    target_value=100.00,
-    reason="Price increased by $0.01"
-)
+# Your custom comparison logic here...
+# report.add_mismatch(...) for each discrepancy
 
-# Generate interactive HTML report
-report.generate_report("reports/data_validation/report.html")
+report.generate_report("reports/validation.html")
 ```
 
 **Report Features:**
@@ -543,8 +566,11 @@ report.generate_report("reports/data_validation/report.html")
 - 📋 Row-by-row mismatch details
 - 🎨 Color-coded status indicators
 - 📱 Mobile-responsive design
+- ⚡ Zero manual mismatch tracking required!
 
-See **[examples/data_comparison_with_html_report.py](examples/data_comparison_with_html_report.py)** for complete examples.
+**Examples:**
+- **Simple API**: [examples/simple_comparison_examples.py](examples/simple_comparison_examples.py) ⭐ **Recommended**
+- **Manual Building**: [examples/data_comparison_with_html_report.py](examples/data_comparison_with_html_report.py)
 
 ### Full Documentation
 

pyplaykit-1.5.0/README.md → pyplaykit-1.7.0/pyplaykit.egg-info/PKG-INFO

@@ -1,3 +1,42 @@
+Metadata-Version: 2.4
+Name: pyplaykit
+Version: 1.7.0
+Summary: Enterprise Python + Playwright automation framework
+Author-email: Shan Konduru <shankonduru@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/ShanKonduru/pyplaykit
+Project-URL: Repository, https://github.com/ShanKonduru/pyplaykit
+Project-URL: Bug Tracker, https://github.com/ShanKonduru/pyplaykit/issues
+Keywords: playwright,pytest,automation,framework,enterprise,testing,page-object-model
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Pytest
+Classifier: Topic :: Software Development :: Testing
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: playwright==1.54.0
+Requires-Dist: pytest==9.1.1
+Requires-Dist: pytest-cov==7.1.0
+Requires-Dist: pytest-xdist==3.8.0
+Requires-Dist: pytest-rerunfailures==16.4
+Requires-Dist: pytest-html==4.2.0
+Requires-Dist: allure-pytest==2.16.0
+Requires-Dist: PyYAML==6.0.2
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: jmespath>=1.0.0
+Requires-Dist: xlrd>=2.0.1
+Requires-Dist: zeep>=4.2.1
+Requires-Dist: gql[httpx]>=3.5.0
+Provides-Extra: data-comparison
+Requires-Dist: pandas>=2.0.0; extra == "data-comparison"
+Requires-Dist: openpyxl>=3.1.0; extra == "data-comparison"
+
 # PyPlayKit - Enterprise Test Automation Framework
 
 **Tagline**: A modular, scalable, and CI/CD-ready Python + Playwright framework for enterprise automation supporting multiple projects and 50+ QE engineers.
@@ -413,13 +452,18 @@ PyPlayKit provides comprehensive data comparison capabilities using the built-in
 ### Prerequisites for Data Comparison
 
 ```bash
-# Install data comparison dependencies
+# Option 1: Install with optional dependencies
+pip install pyplaykit[data-comparison]
+
+# Option 2: Install dependencies separately
 pip install pandas openpyxl
 
-# Or use the examples requirements file
+# Option 3: Use the examples requirements file
 pip install -r examples/requirements.txt
 ```
 
+**Note**: Data comparison features require pandas and openpyxl. The framework will work without them for UI/API/Database testing.
+
 ### Supported Comparison Types
 
 | Comparison Type | Use Case | Example |
@@ -430,22 +474,44 @@ pip install -r examples/requirements.txt
 
 ### Quick Example: Excel-to-Excel Comparison
 
+**Simple One-Line API** (Recommended for QE Engineers):
+
+```python
+import pytest
+from utils.data_comparison_utils import compare_excel_files
+
+@pytest.mark.data
+def test_compare_excel_files(logger):
+    # ONE function call - framework handles everything!
+    result = compare_excel_files(
+        source_file="report_baseline.xlsx",
+        target_file="report_current.xlsx",
+        float_tolerance=0.01
+    )
+    
+    # Check results
+    logger.info(f"{result.summary}")
+    logger.info(f"HTML Report: {result.report_path}")
+    
+    if not result.passed:
+        pytest.fail(f"Validation failed! {result.failed_count} discrepancies found.")
+```
+
+**Manual Validation** (For custom logic):
+
 ```python
 import pytest
 import pandas as pd
-from pathlib import Path
 from pyplaykit import DataValidator
 
 @pytest.mark.data
-def test_compare_excel_files(logger):
-    # Read both files
-    df1 = pd.read_excel("report_baseline.xlsx")
-    df2 = pd.read_excel("report_current.xlsx")
+def test_compare_with_custom_logic(logger):
+    df1 = pd.read_excel("baseline.xlsx")
+    df2 = pd.read_excel("current.xlsx")
     
     records1 = df1.to_dict('records')
     records2 = df2.to_dict('records')
     
-    # Compare row by row
     for idx, (r1, r2) in enumerate(zip(records1, records2)):
         DataValidator.assert_records_equal(r1, r2)
     
@@ -476,29 +542,61 @@ pytest examples/data_comparison_examples.py::test_excel_to_excel_basic -v -s
 
 ### Interactive HTML Reports ⭐ **NEW**
 
-Generate filterable, searchable HTML validation reports:
+**Option 1: Automatic Report Generation** (Recommended):
+
+```python
+from utils.data_comparison_utils import compare_excel_files
+
+# Framework automatically tracks ALL mismatches and generates HTML report
+result = compare_excel_files(
+    source_file="baseline.xlsx",
+    target_file="current.xlsx",
+    float_tolerance=0.01
+)
+
+# Result includes:
+print(f"Passed: {result.passed}")
+print(f"Matched: {result.passed_count}")
+print(f"Failed: {result.failed_count}")
+print(f"Total Mismatches: {result.total_mismatches}")
+print(f"Report: {result.report_path}")
+```
+
+**Available Functions:**
+
+*File-to-File:*
+- `compare_excel_files()` - Excel to Excel
+- `compare_csv_files()` - CSV to CSV
+
+*File-to-Database:*
+- `compare_excel_to_db()` - Excel to Database
+- `compare_csv_to_db()` - CSV to Database
+
+*Database-to-File:*
+- `compare_db_to_excel()` - Database to Excel
+- `compare_db_to_csv()` - Database to CSV
+
+*Database-to-Database:*
+- `compare_db_to_db()` - Database to Database
+
+*Advanced:*
+- `compare_dataframes()` - DataFrame to DataFrame (custom sources)
+
+**Option 2: Manual Report Building** (Advanced):
 
 ```python
 from utils.data_comparison_report import DataComparisonReport
 
-# Initialize report
+# For custom comparison logic
 report = DataComparisonReport()
 report.set_comparison_type("FILE_TO_FILE (Excel)")
 report.set_source("baseline.xlsx", 100)
 report.set_target("current.xlsx", 100)
 
-# Add mismatch
-report.add_mismatch(
-    mismatch_type="VALUE_MISMATCH",
-    row_index=5,
-    mismatching_fields=["Price"],
-    source_value=99.99,
-    target_value=100.00,
-    reason="Price increased by $0.01"
-)
+# Your custom comparison logic here...
+# report.add_mismatch(...) for each discrepancy
 
-# Generate interactive HTML report
-report.generate_report("reports/data_validation/report.html")
+report.generate_report("reports/validation.html")
 ```
 
 **Report Features:**
@@ -507,8 +605,11 @@ report.generate_report("reports/data_validation/report.html")
 - 📋 Row-by-row mismatch details
 - 🎨 Color-coded status indicators
 - 📱 Mobile-responsive design
+- ⚡ Zero manual mismatch tracking required!
 
-See **[examples/data_comparison_with_html_report.py](examples/data_comparison_with_html_report.py)** for complete examples.
+**Examples:**
+- **Simple API**: [examples/simple_comparison_examples.py](examples/simple_comparison_examples.py) ⭐ **Recommended**
+- **Manual Building**: [examples/data_comparison_with_html_report.py](examples/data_comparison_with_html_report.py)
 
 ### Full Documentation
 

{pyplaykit-1.5.0 → pyplaykit-1.7.0}/pyplaykit.egg-info/SOURCES.txt

@@ -59,6 +59,7 @@ utils/api_test_helper.py
 utils/assertion_helper.py
 utils/auth_manager.py
 utils/data_comparison_report.py
+utils/data_comparison_utils.py
 utils/data_loader.py
 utils/data_source.py
 utils/data_validator.py

{pyplaykit-1.5.0 → pyplaykit-1.7.0}/pyplaykit.egg-info/requires.txt

@@ -12,3 +12,7 @@ jmespath>=1.0.0
 xlrd>=2.0.1
 zeep>=4.2.1
 gql[httpx]>=3.5.0
+
+[data-comparison]
+pandas>=2.0.0
+openpyxl>=3.1.0

{pyplaykit-1.5.0 → pyplaykit-1.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyplaykit"
-version = "1.5.0"
+version = "1.7.0"
 description = "Enterprise Python + Playwright automation framework"
 readme = "README.md"
 license = { text = "MIT" }
@@ -42,6 +42,12 @@ dependencies = [
   "gql[httpx]>=3.5.0",
 ]
 
+[project.optional-dependencies]
+data-comparison = [
+  "pandas>=2.0.0",
+  "openpyxl>=3.1.0",
+]
+
 [project.scripts]
 pyplaykit = "pyplaykit.cli:main"
 

pyplaykit-1.7.0/utils/__init__.py

@@ -0,0 +1,48 @@
+"""Utils package for PyPlayKit framework."""
+
+from utils.data_comparison_report import DataComparisonReport
+
+# Lazy imports for optional dependencies (pandas, openpyxl)
+# These are only imported when actually used
+def __getattr__(name):
+    """Lazy import for optional comparison utilities."""
+    comparison_functions = (
+        "compare_excel_files", "compare_csv_files", "compare_dataframes",
+        "compare_excel_to_db", "compare_db_to_excel",
+        "compare_csv_to_db", "compare_db_to_csv",
+        "compare_db_to_db",
+        "ComparisonResult"
+    )
+
+    if name in comparison_functions:
+        try:
+            from utils.data_comparison_utils import (
+                compare_excel_files,
+                compare_csv_files,
+                compare_dataframes,
+                compare_excel_to_db,
+                compare_db_to_excel,
+                compare_csv_to_db,
+                compare_db_to_csv,
+                compare_db_to_db,
+                ComparisonResult,
+            )
+            return globals()[name] if name in globals() else locals()[name]
+        except ImportError as e:
+            raise ImportError(
+                f"'{name}' requires optional dependencies. Install with: pip install pandas openpyxl"
+            ) from e
+    raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
+
+__all__ = [
+    "DataComparisonReport",
+    "compare_excel_files",
+    "compare_csv_files",
+    "compare_dataframes",
+    "compare_excel_to_db",
+    "compare_db_to_excel",
+    "compare_csv_to_db",
+    "compare_db_to_csv",
+    "compare_db_to_db",
+    "ComparisonResult",
+]