Skip to main content

A simple image comparer

Project description

📸 PanonPy

PanonPy is a simple, modular Python library for visual regression testing by comparing images differences and generating HTML report

✨ Features

  • Compare two images (actual vs baseline)
  • Auto-generate HTML report with images
  • Fail the test if images differ (optional)
  • Pytest integration ready
  • CLI support (coming soon)

📦 Installation

pip install panonpy

🚀 How to Use

Basic Usage

from panonpy.panonpy import PanonPy

# Create a PanonPy instance
tester = PanonPy(output_dir='results', fail=True)

# Compare two images
tester.compare(
    actual_image_path='path/to/home_page_screenshot.png',
    baseline_image_path='path/to/baseline_home_page.png',
    test_name='home_page_test',
    threshold=0.01  # Allow 1% difference
)

Result

  • Copies actual, baseline, and diff images into output_dir (default: 'results')
  • Generates a VisualTestsResult.html report with:
    • Green rows for identical images
    • Red rows for different images
    • Yellow rows for newly created baselines
    • Clicking an image in the report opens a full-size popup preview

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

panonpy-1.0.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

panonpy-1.0.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file panonpy-1.0.0.tar.gz.

File metadata

  • Download URL: panonpy-1.0.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.2 Darwin/24.3.0

File hashes

Hashes for panonpy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 aa5a419d3d13d0ad8317c25720ade2b7d855e1c7be910a65217c1a4ff3a96840
MD5 05ec515ec49dca95a72580670b62e6a6
BLAKE2b-256 6c9f0bca0b5c83533a9433cc46a192248ba81ac65b7d28f046115e797e8a04c9

See more details on using hashes here.

File details

Details for the file panonpy-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: panonpy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.2 Darwin/24.3.0

File hashes

Hashes for panonpy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e5739e9c33bb6d324ea2e2a1dc1205293de83eb5e7233aa2f907f41a6abc40a2
MD5 ac5e7fb2ce2b6a9412a8c257518256ea
BLAKE2b-256 e95df312df20e008adb847a3d9b45caf2665e815f372f0bd7bce7516d371e71e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page