visualcheck 0.1.0__tar.gz

visualcheck-0.1.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: visualcheck
+Version: 0.1.0
+Summary: Visual regression checking with figma-first baselines, pixel+SSIM diffing, ignore regions, and HTML reports.
+Author-email: Arif Shah <ashah7775@gmail.com>
+License: MIT
+Project-URL: Homepage, https://bitbucket.org/arif_automation/visualcheck
+Project-URL: Source, https://bitbucket.org/arif_automation/visualcheck
+Keywords: visual-regression,playwright,ssim,qa,figma
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: playwright>=1.40
+Requires-Dist: pillow>=10
+Requires-Dist: numpy>=1.23
+Requires-Dist: opencv-python-headless>=4.8
+Requires-Dist: scikit-image>=0.20
+Requires-Dist: PyYAML>=6
+Requires-Dist: Jinja2>=3
+Requires-Dist: typer>=0.9
+Requires-Dist: rich>=13
+Requires-Dist: jsonschema>=4
+
+# visualcheck
+
+Visual regression checking with **Figma-first baselines**, **pixel diff + SSIM**, **ignore regions**, and a **self-contained HTML report**.
+
+## Install
+
+```bash
+pip install visualcheck
+playwright install chromium
+```
+
+## Quickstart
+
+Create `visualcheck.yaml`:
+
+```yaml
+project: consumer_website
+suite: daily_sanity
+
+envs:
+  qa: "https://qa.example.com"
+  prod: "https://www.example.com"
+
+views:
+  desktop_profiles: ["desktop_1440x900"]
+  mobile_devices: ["iPhone 15 Pro Max", "iPhone 13 mini", "Pixel 7"]
+
+pages:
+  - id: home
+    url: "/"
+
+baseline:
+  priority: ["figma", "runtime"]
+  create_if_missing: true
+  never_overwrite: true
+  on_created: "INFO"
+
+compare:
+  resize_on_mismatch: true
+  mismatch_level: "WARN"
+  thresholds:
+    max_pixel_diff_pct: 0.10
+    min_ssim: 0.995
+
+ignore_regions:
+  global:
+    selectors: ["#cookie-banner", ".chat-widget"]
+```
+
+Run:
+
+```bash
+visualcheck run --env qa
+```
+
+## Baseline rules (locked)
+
+For each snapshot+view:
+1) If a **Figma baseline** exists: use it
+2) Else if a **runtime baseline** exists: use it
+3) Else: capture and **create baseline** (INFO: `BASELINE_CREATED`)
+
+Baselines live at repo root:
+
+- `visual_baseline/<project>/<suite>/figma/...`
+- `visual_baseline/<project>/<suite>/runtime/...`
+
+Run outputs go under:
+
+- `test_report/<project>/visual_runs/<run_id>/...`
+
+## License
+MIT

visualcheck-0.1.0/README.md

@@ -0,0 +1,73 @@
+# visualcheck
+
+Visual regression checking with **Figma-first baselines**, **pixel diff + SSIM**, **ignore regions**, and a **self-contained HTML report**.
+
+## Install
+
+```bash
+pip install visualcheck
+playwright install chromium
+```
+
+## Quickstart
+
+Create `visualcheck.yaml`:
+
+```yaml
+project: consumer_website
+suite: daily_sanity
+
+envs:
+  qa: "https://qa.example.com"
+  prod: "https://www.example.com"
+
+views:
+  desktop_profiles: ["desktop_1440x900"]
+  mobile_devices: ["iPhone 15 Pro Max", "iPhone 13 mini", "Pixel 7"]
+
+pages:
+  - id: home
+    url: "/"
+
+baseline:
+  priority: ["figma", "runtime"]
+  create_if_missing: true
+  never_overwrite: true
+  on_created: "INFO"
+
+compare:
+  resize_on_mismatch: true
+  mismatch_level: "WARN"
+  thresholds:
+    max_pixel_diff_pct: 0.10
+    min_ssim: 0.995
+
+ignore_regions:
+  global:
+    selectors: ["#cookie-banner", ".chat-widget"]
+```
+
+Run:
+
+```bash
+visualcheck run --env qa
+```
+
+## Baseline rules (locked)
+
+For each snapshot+view:
+1) If a **Figma baseline** exists: use it
+2) Else if a **runtime baseline** exists: use it
+3) Else: capture and **create baseline** (INFO: `BASELINE_CREATED`)
+
+Baselines live at repo root:
+
+- `visual_baseline/<project>/<suite>/figma/...`
+- `visual_baseline/<project>/<suite>/runtime/...`
+
+Run outputs go under:
+
+- `test_report/<project>/visual_runs/<run_id>/...`
+
+## License
+MIT

visualcheck-0.1.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "visualcheck"
+version = "0.1.0"
+description = "Visual regression checking with figma-first baselines, pixel+SSIM diffing, ignore regions, and HTML reports."
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [{name = "Arif Shah", email = "ashah7775@gmail.com"}]
+keywords = ["visual-regression", "playwright", "ssim", "qa", "figma"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+dependencies = [
+  "playwright>=1.40",
+  "pillow>=10",
+  "numpy>=1.23",
+  "opencv-python-headless>=4.8",
+  "scikit-image>=0.20",
+  "PyYAML>=6",
+  "Jinja2>=3",
+  "typer>=0.9",
+  "rich>=13",
+  "jsonschema>=4",
+]
+
+[project.urls]
+Homepage = "https://bitbucket.org/arif_automation/visualcheck"
+Source = "https://bitbucket.org/arif_automation/visualcheck"
+
+[project.scripts]
+visualcheck = "visualcheck.cli:app"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.package-data]
+visualcheck = ["templates/*.html", "schemas/*.json"]

visualcheck-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

visualcheck-0.1.0/src/visualcheck/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"

visualcheck-0.1.0/src/visualcheck/cli.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Optional
+
+import typer
+
+app = typer.Typer(add_completion=False, help="visualcheck: visual regression checking (MVP scaffold)")
+
+
+@app.command()
+def run(
+    env: str = typer.Option(..., help="Environment key from visualcheck.yaml (e.g. qa/prod)"),
+    config: Path = typer.Option(Path("visualcheck.yaml"), help="Path to visualcheck.yaml"),
+):
+    """Run capture+diff+report. (MVP scaffold)"""
+    if not config.exists():
+        raise typer.BadParameter(f"Config not found: {config}")
+
+    typer.echo(f"visualcheck v0.1.0 (scaffold)\nconfig={config}\nenv={env}")
+    typer.echo("Next: implement capture+baseline+diff+report.")
+
+
+@app.command("figma-sync")
+def figma_sync(
+    config: Path = typer.Option(Path("visualcheck.yaml"), help="Path to visualcheck.yaml"),
+):
+    """Sync Figma frames into figma baseline folder. (planned)"""
+    typer.echo("figma sync: planned")
+
+
+@app.command()
+def diff(
+    baseline: Path = typer.Option(..., help="Baseline folder"),
+    current: Path = typer.Option(..., help="Current screenshots folder"),
+    out: Path = typer.Option(Path("report"), help="Output report folder"),
+):
+    """Diff-only mode. (planned)"""
+    typer.echo(json.dumps({"baseline": str(baseline), "current": str(current), "out": str(out)}))

visualcheck-0.1.0/src/visualcheck.egg-info/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: visualcheck
+Version: 0.1.0
+Summary: Visual regression checking with figma-first baselines, pixel+SSIM diffing, ignore regions, and HTML reports.
+Author-email: Arif Shah <ashah7775@gmail.com>
+License: MIT
+Project-URL: Homepage, https://bitbucket.org/arif_automation/visualcheck
+Project-URL: Source, https://bitbucket.org/arif_automation/visualcheck
+Keywords: visual-regression,playwright,ssim,qa,figma
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: playwright>=1.40
+Requires-Dist: pillow>=10
+Requires-Dist: numpy>=1.23
+Requires-Dist: opencv-python-headless>=4.8
+Requires-Dist: scikit-image>=0.20
+Requires-Dist: PyYAML>=6
+Requires-Dist: Jinja2>=3
+Requires-Dist: typer>=0.9
+Requires-Dist: rich>=13
+Requires-Dist: jsonschema>=4
+
+# visualcheck
+
+Visual regression checking with **Figma-first baselines**, **pixel diff + SSIM**, **ignore regions**, and a **self-contained HTML report**.
+
+## Install
+
+```bash
+pip install visualcheck
+playwright install chromium
+```
+
+## Quickstart
+
+Create `visualcheck.yaml`:
+
+```yaml
+project: consumer_website
+suite: daily_sanity
+
+envs:
+  qa: "https://qa.example.com"
+  prod: "https://www.example.com"
+
+views:
+  desktop_profiles: ["desktop_1440x900"]
+  mobile_devices: ["iPhone 15 Pro Max", "iPhone 13 mini", "Pixel 7"]
+
+pages:
+  - id: home
+    url: "/"
+
+baseline:
+  priority: ["figma", "runtime"]
+  create_if_missing: true
+  never_overwrite: true
+  on_created: "INFO"
+
+compare:
+  resize_on_mismatch: true
+  mismatch_level: "WARN"
+  thresholds:
+    max_pixel_diff_pct: 0.10
+    min_ssim: 0.995
+
+ignore_regions:
+  global:
+    selectors: ["#cookie-banner", ".chat-widget"]
+```
+
+Run:
+
+```bash
+visualcheck run --env qa
+```
+
+## Baseline rules (locked)
+
+For each snapshot+view:
+1) If a **Figma baseline** exists: use it
+2) Else if a **runtime baseline** exists: use it
+3) Else: capture and **create baseline** (INFO: `BASELINE_CREATED`)
+
+Baselines live at repo root:
+
+- `visual_baseline/<project>/<suite>/figma/...`
+- `visual_baseline/<project>/<suite>/runtime/...`
+
+Run outputs go under:
+
+- `test_report/<project>/visual_runs/<run_id>/...`
+
+## License
+MIT

visualcheck-0.1.0/src/visualcheck.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+src/visualcheck/__init__.py
+src/visualcheck/cli.py
+src/visualcheck.egg-info/PKG-INFO
+src/visualcheck.egg-info/SOURCES.txt
+src/visualcheck.egg-info/dependency_links.txt
+src/visualcheck.egg-info/entry_points.txt
+src/visualcheck.egg-info/requires.txt
+src/visualcheck.egg-info/top_level.txt

visualcheck-0.1.0/src/visualcheck.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

visualcheck-0.1.0/src/visualcheck.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+visualcheck = visualcheck.cli:app

visualcheck-0.1.0/src/visualcheck.egg-info/requires.txt

@@ -0,0 +1,10 @@
+playwright>=1.40
+pillow>=10
+numpy>=1.23
+opencv-python-headless>=4.8
+scikit-image>=0.20
+PyYAML>=6
+Jinja2>=3
+typer>=0.9
+rich>=13
+jsonschema>=4

visualcheck-0.1.0/src/visualcheck.egg-info/top_level.txt

@@ -0,0 +1 @@
+visualcheck