Metadata-Version: 2.1
Name: visual_regression_tracker
Version: 0.1
Summary: Open source, self hosted solution for visual testing and managing results of visual testing.
Home-page: https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker
Author: 
License: APACHE
Description: 
        # Python SDK for [Visual Regression Tracker](https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker)
        
        [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/b6796a5b10954c69a2151b118e44a5af)](https://www.codacy.com/gh/Visual-Regression-Tracker/sdk-js?utm_source=github.com&utm_medium=referral&utm_content=Visual-Regression-Tracker/sdk-js&utm_campaign=Badge_Coverage)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b9a9e660b0e14c6c9fb38c7cf09ab16c)](https://app.codacy.com/gh/Visual-Regression-Tracker/sdk-js?utm_source=github.com&utm_medium=referral&utm_content=Visual-Regression-Tracker/sdk-js&utm_campaign=Badge_Grade_Dashboard)
        
        ## Install
        ```python
        pip install visual_regression_tracker
        ```
        
        ## Usage
        ### Import
        ```python
        from visual_regression_tracker import VisualRegressionTracker, Config, TestRun
        ```
        
        ### Configure connection
        ```python
        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)
        ```
        
        ### Send image
        ```python
        vrt.track(TestRun(
            # Name to be displayed
            # Required
            name='Image name',
        
            # Base64 encoded string
            # Required
            imageBase64=image,
        
            # Allowed mismatch tollerance in %
            # Optional
            # Default: 1%
            diffTollerancePercent=0,
        
            # Optional
            os='Mac',
        
            # Optional
            browser='Chrome',
        
            # Optional
            viewport='800x600',
        
            # Optional
            device='PC',
        ))
        ```
Platform: UNKNOWN
Requires: requests
Description-Content-Type: text/markdown
