Metadata-Version: 2.1
Name: VRT
Version: 0.1.3
Summary: VRT is a library for integrating Visual Regression Tracker with Robot Framework.
Home-page: https://github.com/NiceProjectPoland/robotframework-VRTLibrary
License: Apache-2.0
Author: Katarzyna Wawrzynek
Author-email: katarzyna.wawrzynek@niceproject.eu
Requires-Python: >=3.8
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: robotframework (>=4.0)
Requires-Dist: visual-regression-tracker (>=4.0)
Project-URL: Repository, https://github.com/NiceProjectPoland/robotframework-VRTLibrary
Description-Content-Type: text/markdown

# VRT

VRT is a library for integrating Visual Regression Tracker with Robot Framework.
For information about Visual Regression Tracker please visit the
[project page](https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker).

## Prerequisites

- Visual Regression Tracker

##Installation

The package is stored in PyPI .
To install package execute command:

```pip install VRT```

##Importing

To import library use below command:

```Library  VRT```

##Configure connection

Connection with Visual Regression Tracker should be configured using environment variables:

Example:

<pre>
VRT_APIURL= http://localhost:4200     #URL where backend is running
VRT_PROJECT= Default project          #Project name or ID
VRT_APIKEY= YourAPIKey                #User apiKey
VRT_CIBUILDID= $CI_COMMIT_SHA         #Current git commit SHA
VRT_BRANCHNAME= $CI_COMMIT_REF_NAME   #Current git branch
VRT_ENABLESOFTASSERT= "false"         #Log errors instead of exceptions
</pre>

For local use and test debugging vrt.json file can be used. The file should be placed in the project root.

<pre>
*vrt.json*

{
"apiUrl":"http://localhost:4200",
"project":"Default project",
"apiKey":"YourAPIKey",
"ciBuildId":"commit_sha",
"branchName":"develop",
"enableSoftAssert":false
}
</pre>

