visual-regression-tracker 4.0.0

Open source, self hosted solution for visual testing and managing results of visual testing.

Python SDK for Visual Regression Tracker

Install

pip install visual_regression_tracker

Usage

Import

from visual_regression_tracker import VisualRegressionTracker, Config, TestRun

Configure connection

config = Config(
    # apiUrl - URL where backend is running 
    apiUrl='http://localhost:4200',

    # project - Project name or ID
    project='Default project',

    # apiKey - User apiKey
    apiKey='tXZVHX0EA4YQM1MGDD',

    # branch - Current git branch 
    branchName='develop',
)

vrt = VisualRegressionTracker(config)

Setup / Teardown

As context manager:

with vrt:
    ...
    # track test runs
    ...

Without context manager:

vrt.start()
...
# track test runs
...
vrt.stop()

Assert

vrt.track(TestRun(
    # Name to be displayed
    # Required
    name='Image name',

    # Base64 encoded string
    # Required
    imageBase64=image,

    # Allowed mismatch tollerance in %
    # Optional
    # Default: 0%
    diffTollerancePercent=1,

    # Optional
    os='Mac',

    # Optional
    browser='Chrome',

    # Optional
    viewport='800x600',

    # Optional
    device='PC',
))