From 384c826eac1dda918c7cbf00134ff2b3442a80be Mon Sep 17 00:00:00 2001
From: Radek Bednarik <radek.bednarik@tesena.com>
Date: Tue, 8 Mar 2022 19:47:11 +0100
Subject: [PATCH] update doclib & pyproject.toml

---
 docs/WatchUI.html | 4 ++--
 pyproject.toml    | 3 +++
 tasks.py          | 4 ++++
 3 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/docs/WatchUI.html b/docs/WatchUI.html
index 8e9898a..1c0718e 100644
--- a/docs/WatchUI.html
+++ b/docs/WatchUI.html
@@ -6,7 +6,7 @@
 <meta http-equiv="Pragma" content="no-cache">
 <meta http-equiv="Expires" content="-1">
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta content="Robot Framework 4.1.3 (Python 3.10.2 on linux)" name="Generator">
+<meta content="Robot Framework 4.1.3 (Python 3.10.2 on win32)" name="Generator">
 <link rel="icon" type="image/x-icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKcAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAqAAAAAAAAAAAAAAAAAAAALIAAAD/AAAA4AAAANwAAADcAAAA3AAAANwAAADcAAAA3AAAANwAAADcAAAA4AAAAP8AAACxAAAAAAAAAKYAAAD/AAAAuwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC/AAAA/wAAAKkAAAD6AAAAzAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN8AAAD/AAAA+gAAAMMAAAAAAAAAAgAAAGsAAABrAAAAawAAAGsAAABrAAAAawAAAGsAAABrAAAADAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAIsAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAANEAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAAAAAAAAMgAAADIAAAAyAAAAMgAAADIAAAAyAAAAMgAAADIAAAAFAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAADwAAAB8AAAAAAAAAGAAAABcAAAAAAAAAH8AAABKAAAAAAAAAAAAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAADCAAAA/wAAACkAAADqAAAA4QAAAAAAAAD7AAAA/wAAALAAAAAGAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAIwAAAP4AAAD/AAAA/wAAAGAAAAAAAAAAAAAAAMkAAAD/AAAAigAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAAAAAAAIAAAAcAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAEgAAAAAAAAAAAAAA2gAAAP8AAAD7AAAAywAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN4AAAD/AAAAqwAAAP8AAACvAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALIAAAD/AAAAsgAAAAAAAAC5AAAA/wAAAMoAAADAAAAAwAAAAMAAAADAAAAAwAAAAMAAAADAAAAAwAAAAMkAAAD/AAAAvAAAAAAAAAAAAAAAAAAAAKwAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAArQAAAAAAAAAAwAMAAIABAAAf+AAAP/wAAD/8AAAgBAAAP/wAAD/8AAA//AAAJIwAADHEAAA//AAAP/wAAB/4AACAAQAAwAMAAA==">
 <style media="all" type="text/css">
 :root {
@@ -1102,7 +1102,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"name": "WatchUI", "doc": "<p>WatchUI - Custom library for comparing images with use in Robot Framework.</p>\n<h2 id=\"Table of Contents\">Table of Contents</h2>\n<ul>\n<li><a href=\"#Usage\" class=\"name\">Usage</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Examples\" class=\"name\">Examples</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Usage\">Usage</h2>\n<p>This library allows for automated visual testing of web frontends. Currently, this library is not officialy supported, so best way is to clone the repository and copy the WatchUI.py library file into your project and then import it - see Importing section. However, you can also install it via command <b>pip install WatchUI</b> and then import it. <b>IMPORTANT</b>: When using keywords of this library, please remember, that screenshots have to have same resolution!</p>\n<h2 id=\"Examples\">Examples</h2>\n<p>Import library</p>\n<pre>\n<span class=\"name\">Library</span> | &lt;path_to_library file&gt; | outputs_folder= | ssim_basic= | format_image= | tesseract_path=\n</pre>\n<p>Compare Images</p>\n<table border=\"1\">\n<tr>\n<td>Compare Images</td>\n<td>path1</td>\n<td>path2</td>\n<td>save_folder=</td>\n<td>ssim=</td>\n<td>format_image=</td>\n</tr>\n</table>", "version": "", "generated": "2022-03-03 11:10:07", "type": "LIBRARY", "scope": "TEST", "docFormat": "HTML", "source": "/home/procesor/projects/python/WatchUI/WatchUI/__init__.py", "lineno": 8, "tags": [], "inits": [{"name": "Init", "args": [{"name": "outputs_folder", "types": [], "defaultValue": "./outputs", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "outputs_folder=./outputs"}, {"name": "ssim_basic", "types": [], "defaultValue": "1.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ssim_basic=1.0"}, {"name": "format_image", "types": [], "defaultValue": "png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "format_image=png"}, {"name": "tesseract_path", "types": [], "defaultValue": "C:\\\\Program Files\\\\Tesseract-OCR\\\\tesseract.exe", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "tesseract_path=C:\\\\Program Files\\\\Tesseract-OCR\\\\tesseract.exe"}], "doc": "<p>Library can be imported either with default output folder and set lowest limit of difference between images (ssim), or you can provide your own values. Keyword Arguments: outputs_folder {str} -- path, where you want to save images with highlighted differences (default: \"../Outputs\") ssim_basic {float} -- threshold value in the interval (0, 1&gt;. Tests are passed, if ssim value returned by keyword test functions is bigger than this (default: 1.0) format_image {str} -- Format for saving picture/screenshot (png, jpg etc.) tesseract_path {str} -- path for tesseract Example: format_image=jpg (default: png) Examples:</p>\n<table border=\"1\">\n<tr>\n<th>Setting</th>\n<th>Value</th>\n<th>Value</th>\n<th>Value</th>\n<th>Comment</th>\n</tr>\n<tr>\n<td>Library</td>\n<td>WatchUI</td>\n<td></td>\n<td></td>\n<td># Uses default values of keyword arguments</td>\n</tr>\n<tr>\n<td>Library</td>\n<td>WatchUI</td>\n<td>outputs_folder=&lt;path_to_folder&gt;</td>\n<td></td>\n<td># changes folder to different one</td>\n</tr>\n<tr>\n<td>Library</td>\n<td>WatchUI</td>\n<td>outputs_folder=&lt;path_to_folder&gt;</td>\n<td>ssim_basic=&lt;float&gt;</td>\n<td># changes output folder and ssim threshold</td>\n</tr>\n</table>", "shortdoc": "Library can be imported either with default output folder and set lowest limit of difference between images (ssim), or you can provide your own values. Keyword Arguments:     outputs_folder {str} -- path, where you want to save images with highlighted     differences (default: \"../Outputs\")     ssim_basic {float} -- threshold value in the interval (0, 1>. Tests are passed,     if ssim value returned by keyword test functions is bigger than this (default: 1.0)     format_image {str} -- Format for saving picture/screenshot (png, jpg etc.)     tesseract_path {str} -- path for tesseract     Example: format_image=jpg (default: png) Examples: | =Setting= | =Value= | =Value= | =Value= | =Comment= | | Library   | WatchUI |      |  | # Uses default values of keyword arguments | | Library   | WatchUI | outputs_folder=<path_to_folder> | | # changes folder to different one | | Library   | WatchUI | outputs_folder=<path_to_folder> | ssim_basic=<float> | # changes output folder and ssim threshold |", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/WatchUI.py", "lineno": 33}], "keywords": [{"name": "Check Dir", "args": [{"name": "save_folder", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "save_folder: str"}], "doc": "<p>Checks given value for <span class=\"name\">save_folder</span>, verifies against default and if it does not exists, creates it. Args: save_folder (str): path to save folder Returns: str: self.save_folder_path</p>", "shortdoc": "Checks given value for `save_folder`, verifies against default and if it does not exists, creates it. Args:     save_folder (str): path to save folder Returns:     str: self.save_folder_path", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/Ibasic/IBasic.py", "lineno": 25}, {"name": "Check If Args Has Ok Numbers", "args": [{"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "need_numbers", "types": ["int"], "defaultValue": "4", "kind": "NAMED_ONLY", "required": false, "repr": "need_numbers: int = 4"}], "doc": "<p>Verifies, whether correct number of arguments was provided. *Args: Arguments to be verified Args: need_numbers (int, optional): required number of arguments. Defaults to 4. Raises: ValueError: Returns: bool: True, if number of <span class=\"name\">*args</span> matches the <span class=\"name\">need_number</span> value. Else throws <span class=\"name\">ValueError</span></p>", "shortdoc": "Verifies, whether correct number of arguments was provided. *Args:     Arguments to be verified Args:     need_numbers (int, optional): required number of arguments. Defaults to 4. Raises:     ValueError: Returns:     bool: True, if number of `*args` matches the `need_number` value.     Else throws `ValueError`", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/Ibasic/IBasic.py", "lineno": 138}, {"name": "Check Image Exists", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}], "doc": "<p>Checks, that image file on given <span class=\"name\">path</span> exists. Args: path (str): path to given image file. Raises: FileExistsError:</p>", "shortdoc": "Checks, that image file on given `path` exists. Args:     path (str): path to given image file. Raises:     FileExistsError:", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/Ibasic/IBasic.py", "lineno": 42}, {"name": "Check Image Format", "args": [{"name": "image_format", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "image_format: str"}], "doc": "<p>Checks image format. If \"png\", returns default, else returns <span class=\"name\">image_format</span>. Args: image_format (str): format of the image, e.g. \"png\", \"jpg\", etc. Returns: str: image format file extension, e.g \".png\", \".jpg\"</p>", "shortdoc": "Checks image format. If \"png\", returns default, else returns `image_format`. Args:     image_format (str): format of the image, e.g. \"png\", \"jpg\", etc. Returns:     str: image format file extension, e.g \".png\", \".jpg\"", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/Ibasic/IBasic.py", "lineno": 75}, {"name": "Check Ssim", "args": [{"name": "ssim", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "ssim: float"}], "doc": "<p>Checks, if <span class=\"name\">ssim</span> is of <span class=\"name\">&lt;float&gt;</span> type and if it is within &lt;0.0 , 1.0&gt; range. Args: ssim (float): SSIM value Raises: TypeError: ValueError: Returns: float: returns the SSIM value</p>", "shortdoc": "Checks, if `ssim` is of `<float>` type and if it is within <0.0 , 1.0> range. Args:     ssim (float): SSIM value Raises:     TypeError:     ValueError: Returns:     float: returns the SSIM value", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/Ibasic/IBasic.py", "lineno": 52}, {"name": "Check Tess Path", "args": [{"name": "path_to_tess", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path_to_tess: str"}], "doc": "<p>Checks, whether <span class=\"name\">path_to tess</span> is equal to expected default. If so, returns default value. Else returns provided value. Args: path_to_tess (str): path to tesseract folder Returns: str: self.path_to_tesseract_folder</p>", "shortdoc": "Checks, whether `path_to tess` is equal to expected default. If so, returns default value. Else returns provided value. Args:     path_to_tess (str): path to tesseract folder Returns:     str: self.path_to_tesseract_folder", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/Ibasic/IBasic.py", "lineno": 86}, {"name": "Compare Images", "args": [{"name": "base_image_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "base_image_path: str"}, {"name": "compared_image_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "compared_image_path: str"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "save_folder="}, {"name": "ssim", "types": [], "defaultValue": "1.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ssim=1.0"}, {"name": "image_format", "types": [], "defaultValue": "png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "image_format=png"}], "doc": "<p>Compares image on <span class=\"name\">compared_image_path</span> against base image on <span class=\"name\">base_image_path</span>. Args: base_image_path (str): path to base image compared_image_path (str): path to compared image save_folder (str): path to the save folder ssim (float): SSIM threshold value image_format (str): image format, e.g. \"png\", \"jpg\" Raises: TypeError:</p>", "shortdoc": "Compares image on `compared_image_path` against base image on `base_image_path`. Args:     base_image_path (str): path to base image     compared_image_path (str): path to compared image     save_folder (str): path to the save folder     ssim (float): SSIM threshold value     image_format (str): image format, e.g. \"png\", \"jpg\" Raises:     TypeError:", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/Image.py", "lineno": 117}, {"name": "Compare Screen Without Areas", "args": [{"name": "base_image_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "base_image_path: str"}, {"name": "compared_image_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "compared_image_path: str"}, {"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "NAMED_ONLY", "required": false, "repr": "save_folder="}, {"name": "ssim", "types": [], "defaultValue": "1.0", "kind": "NAMED_ONLY", "required": false, "repr": "ssim=1.0"}, {"name": "image_format", "types": [], "defaultValue": "png", "kind": "NAMED_ONLY", "required": false, "repr": "image_format=png"}], "doc": "<p>Compares two images without selected areas of the image. Args: base_image_path (str): path to the base image compared_image_path (str): path to the compared image save_folder (str): path to the save folder ssim (float): SSIM threshold value image_format (str): format of the image, e.g. \"png\", \"jpg\"</p>", "shortdoc": "Compares two images without selected areas of the image. Args:     base_image_path (str): path to the base image     compared_image_path (str): path to the compared image     save_folder (str): path to the save folder     ssim (float): SSIM threshold value     image_format (str): format of the image, e.g. \"png\", \"jpg\"", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/Image.py", "lineno": 164}, {"name": "Crop Image", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "x1", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x1: int"}, {"name": "y1", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y1: int"}, {"name": "x2", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x2: int"}, {"name": "y2", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y2: int"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "save_folder="}, {"name": "image_format", "types": [], "defaultValue": "png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "image_format=png"}], "doc": "<p>Creates cropped image and saves it. Args: path (str): path to the image x1 (int): x1 coords y1 (int): y1 coords x2 (int): x2 coords y2 (int): y2 coords save_folder (str): path to save folder image_format (str): format of the saved image, e.g. \"png\", \"jpg\"</p>", "shortdoc": "Creates cropped image and saves it. Args:     path (str): path to the image     x1 (int): x1 coords     y1 (int): y1 coords     x2 (int): x2 coords     y2 (int): y2 coords     save_folder (str): path to save folder     image_format (str): format of the saved image, e.g. \"png\", \"jpg\"", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/Image.py", "lineno": 230}, {"name": "Image Area On Text", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "coordinates", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*coordinates"}, {"name": "oem", "types": ["str"], "defaultValue": "3", "kind": "NAMED_ONLY", "required": false, "repr": "oem: str = 3"}, {"name": "psm", "types": ["str"], "defaultValue": "3", "kind": "NAMED_ONLY", "required": false, "repr": "psm: str = 3"}, {"name": "language", "types": ["str"], "defaultValue": "eng", "kind": "NAMED_ONLY", "required": false, "repr": "language: str = eng"}, {"name": "path_to_tesseract", "types": ["str"], "defaultValue": "", "kind": "NAMED_ONLY", "required": false, "repr": "path_to_tesseract: str = "}], "doc": "<p>Convert to text only the selected area of the image and return. Args: path (str): path to the image oem (str): [description] psm (str): [description] language (str): [description] path_to_tesseract (str): path to the installed tesseract library Returns: Union[list[str], str]: returned text</p>", "shortdoc": "Convert to text only the selected area of the image and return. Args:     path (str): path to the image     oem (str): [description]     psm (str): [description]     language (str): [description]     path_to_tesseract (str): path to the installed tesseract library Returns:     Union[list[str], str]: returned text", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/Tesseract.py", "lineno": 39}, {"name": "Image To String", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "oem", "types": ["str"], "defaultValue": "3", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "oem: str = 3"}, {"name": "psm", "types": ["str"], "defaultValue": "3", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "psm: str = 3"}, {"name": "language", "types": ["str"], "defaultValue": "eng", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "language: str = eng"}, {"name": "path_to_tesseract", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_to_tesseract="}], "doc": "<p>Converts provided image to string and returns. Args: path (str): path to the image oem (str): [description] psm (str): [description] language (str): [description] path_to_tesseract (str): path to installed tesseract binary Returns: str: OCRed text from image</p>", "shortdoc": "Converts provided image to string and returns. Args:     path (str): path to the image     oem (str): [description]     psm (str): [description]     language (str): [description]     path_to_tesseract (str): path to installed tesseract binary Returns:     str: OCRed text from image", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/Tesseract.py", "lineno": 15}, {"name": "Pdf To Image", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "name", "types": ["str"], "defaultValue": "img", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "name: str = img"}, {"name": "page_number", "types": ["int"], "defaultValue": "-1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_number: int = -1"}, {"name": "zoom", "types": ["int"], "defaultValue": "3", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "zoom: int = 3"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "save_folder="}], "doc": "<p>Converts pdf to image - .png format. Args: path (str): path to the .pdf file save_folder (str): path to the save folder name (str): name of the file of the image to be saved number_page (str): page from the pdf document to be saved as image. if value is <span class=\"name\">-1</span>, then saves all pages as separated .png files.</p>", "shortdoc": "Converts pdf to image - .png format. Args:     path (str): path to the .pdf file     save_folder (str): path to the save folder     name (str): name of the file of the image to be saved     number_page (str): page from the pdf document to be saved as image.     if value is `-1`, then saves all pages as separated .png files.", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/PDF.py", "lineno": 18}, {"name": "Return Text From Area", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "page_number", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "page_number: int"}, {"name": "x1", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x1: int"}, {"name": "y1", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y1: int"}, {"name": "x2", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x2: int"}, {"name": "y2", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y2: int"}], "doc": "<p>Opens provided PDF file and returns text from the given area. Args: path (str): path to the pdf file page_number (int): page number in the pdf file x1 (int): y1 (int): x2 (int): y2 (int): Returns: str: selected text from the area</p>", "shortdoc": "Opens provided PDF file and returns text from the given area. Args:     path (str): path to the pdf file     page_number (int): page number in the pdf file     x1 (int):     y1 (int):     x2 (int):     y2 (int): Returns:     str: selected text from the area", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/PDF.py", "lineno": 55}, {"name": "Rotate Image", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "screen_name", "types": [], "defaultValue": "rotate_img", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "screen_name=rotate_img"}, {"name": "angle", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "angle=0"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "save_folder="}, {"name": "image_format", "types": [], "defaultValue": "png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "image_format=png"}], "doc": "<p>Creates rotated version of the source image and saves it. Args: path (str): path to the source image screen_name (str): name of the screen save_folder (str): path to the save folder rotate (int): [description] image_format (str): [description] Raises: AssertionError: [description]</p>", "shortdoc": "Creates rotated version of the source image and saves it. Args:     path (str): path to the source image     screen_name (str): name of the screen     save_folder (str): path to the save folder     rotate (int): [description]     image_format (str): [description] Raises:     AssertionError: [description]", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/Image.py", "lineno": 266}, {"name": "Set Log Message", "args": [{"name": "work_object", "types": ["Literal['Image', 'PDF', 'Tesseract']"], "defaultValue": "Image", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "work_object: Literal['Image', 'PDF', 'Tesseract'] = Image"}, {"name": "type_of_messages", "types": ["Literal['Info', 'Error']"], "defaultValue": "Info", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "type_of_messages: Literal['Info', 'Error'] = Info"}, {"name": "path_to_image", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_to_image: str = "}], "doc": "<p>Sets logging message. Args: work_object (Literal[, optional): What object are we working on. Defaults to \"Image\". type_of_messages (Literal[, optional): Type of logging message. Defaults to \"Info\". path_to_image (str, optional): Path to image to be appended to log message. Defaults to \"\". Raises: AssertionError:</p>", "shortdoc": "Sets logging message. Args:     work_object (Literal[, optional): What object are we working on. Defaults to \"Image\".     type_of_messages (Literal[, optional): Type of logging message. Defaults to \"Info\".     path_to_image (str, optional): Path to image to be appended to log message.     Defaults to \"\". Raises:     AssertionError:", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/Ibasic/IBasic.py", "lineno": 101}, {"name": "Should Exist This Text", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "page_number", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "page_number: int"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}], "doc": "<p>Verifies, whether given text is present in the document and given page. Args: path (str): path to pdf document page_number (int): page number text (str): text to check for presence Returns: bool: <span class=\"name\">True</span> if present, else <span class=\"name\">False</span></p>", "shortdoc": "Verifies, whether given text is present in the document and given page. Args:     path (str): path to pdf document     page_number (int): page number     text (str): text to check for presence Returns:     bool: `True` if present, else `False`", "tags": [], "source": "/home/procesor/projects/python/WatchUI/WatchUI/keywords/PDF.py", "lineno": 90}], "dataTypes": {"enums": [], "typedDicts": []}}
+libdoc = {"name": "WatchUI", "doc": "<p>WatchUI - Custom library for comparing images with use in Robot Framework.</p>\n<h2 id=\"Table of Contents\">Table of Contents</h2>\n<ul>\n<li><a href=\"#Usage\" class=\"name\">Usage</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Examples\" class=\"name\">Examples</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Usage\">Usage</h2>\n<p>This library allows for automated visual testing of web frontends. <b>IMPORTANT</b>: When using keywords of this library, please remember, that screenshots have to have same resolution!</p>\n<h2 id=\"Examples\">Examples</h2>\n<p>Import library</p>\n<pre>\n<span class=\"name\">Library</span> | &lt;path_to_library file&gt; | outputs_folder= | ssim_basic= | format_image= | tesseract_path=\n</pre>\n<p>Compare Images</p>\n<table border=\"1\">\n<tr>\n<td>Compare Images</td>\n<td>path1</td>\n<td>path2</td>\n<td>save_folder=</td>\n<td>ssim=</td>\n<td>format_image=</td>\n</tr>\n</table>", "version": "", "generated": "2022-03-08 19:38:35", "type": "LIBRARY", "scope": "TEST", "docFormat": "HTML", "source": "C:\\Repos\\WatchUI\\WatchUI\\__init__.py", "lineno": 9, "tags": [], "inits": [{"name": "Init", "args": [{"name": "outputs_folder", "types": [], "defaultValue": "./outputs", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "outputs_folder=./outputs"}, {"name": "ssim_basic", "types": [], "defaultValue": "1.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ssim_basic=1.0"}, {"name": "format_image", "types": [], "defaultValue": "png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "format_image=png"}, {"name": "tesseract_path", "types": [], "defaultValue": "C:\\\\Program Files\\\\Tesseract-OCR\\\\tesseract.exe", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "tesseract_path=C:\\\\Program Files\\\\Tesseract-OCR\\\\tesseract.exe"}], "doc": "<p>Library can be imported either with default output folder and set lowest limit of difference between images (ssim), or you can provide your own values. Keyword Arguments: outputs_folder {str} -- path, where you want to save images with highlighted differences (default: \"../Outputs\") ssim_basic {float} -- threshold value in the interval (0, 1&gt;. Tests are passed, if ssim value returned by keyword test functions is bigger than this (default: 1.0) format_image {str} -- Format for saving picture/screenshot (png, jpg etc.) tesseract_path {str} -- path for tesseract Example: format_image=jpg (default: png) Examples:</p>\n<table border=\"1\">\n<tr>\n<th>Setting</th>\n<th>Value</th>\n<th>Value</th>\n<th>Value</th>\n<th>Comment</th>\n</tr>\n<tr>\n<td>Library</td>\n<td>WatchUI</td>\n<td></td>\n<td></td>\n<td># Uses default values of keyword arguments</td>\n</tr>\n<tr>\n<td>Library</td>\n<td>WatchUI</td>\n<td>outputs_folder=&lt;path_to_folder&gt;</td>\n<td></td>\n<td># changes folder to different one</td>\n</tr>\n<tr>\n<td>Library</td>\n<td>WatchUI</td>\n<td>outputs_folder=&lt;path_to_folder&gt;</td>\n<td>ssim_basic=&lt;float&gt;</td>\n<td># changes output folder and ssim threshold</td>\n</tr>\n</table>", "shortdoc": "Library can be imported either with default output folder and set lowest limit of difference between images (ssim), or you can provide your own values. Keyword Arguments:     outputs_folder {str} -- path, where you want to save images with highlighted     differences (default: \"../Outputs\")     ssim_basic {float} -- threshold value in the interval (0, 1>. Tests are passed,     if ssim value returned by keyword test functions is bigger than this (default: 1.0)     format_image {str} -- Format for saving picture/screenshot (png, jpg etc.)     tesseract_path {str} -- path for tesseract     Example: format_image=jpg (default: png) Examples: | =Setting= | =Value= | =Value= | =Value= | =Comment= | | Library   | WatchUI |      |  | # Uses default values of keyword arguments | | Library   | WatchUI | outputs_folder=<path_to_folder> | | # changes folder to different one | | Library   | WatchUI | outputs_folder=<path_to_folder> | ssim_basic=<float> | # changes output folder and ssim threshold |", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\WatchUI.py", "lineno": 27}], "keywords": [{"name": "Check Dir", "args": [{"name": "save_folder", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "save_folder: str"}], "doc": "<p>Checks given value for <span class=\"name\">save_folder</span>, verifies against default and if it does not exists, creates it. Args: save_folder (str): path to save folder Returns: str: self.save_folder_path</p>", "shortdoc": "Checks given value for `save_folder`, verifies against default and if it does not exists, creates it. Args:     save_folder (str): path to save folder Returns:     str: self.save_folder_path", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\Ibasic\\IBasic.py", "lineno": 27}, {"name": "Check If Args Has Ok Numbers", "args": [{"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "need_numbers", "types": ["int"], "defaultValue": "4", "kind": "NAMED_ONLY", "required": false, "repr": "need_numbers: int = 4"}], "doc": "<p>Verifies, whether correct number of arguments was provided. *Args: Arguments to be verified Args: need_numbers (int, optional): required number of arguments. Defaults to 4. Raises: ValueError: Returns: bool: True, if number of <span class=\"name\">*args</span> matches the <span class=\"name\">need_number</span> value. Else throws <span class=\"name\">ValueError</span></p>", "shortdoc": "Verifies, whether correct number of arguments was provided. *Args:     Arguments to be verified Args:     need_numbers (int, optional): required number of arguments. Defaults to 4. Raises:     ValueError: Returns:     bool: True, if number of `*args` matches the `need_number` value.     Else throws `ValueError`", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\Ibasic\\IBasic.py", "lineno": 138}, {"name": "Check Image Exists", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}], "doc": "<p>Checks, that image file on given <span class=\"name\">path</span> exists. Args: path (str): path to given image file. Raises: FileExistsError:</p>", "shortdoc": "Checks, that image file on given `path` exists. Args:     path (str): path to given image file. Raises:     FileExistsError:", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\Ibasic\\IBasic.py", "lineno": 44}, {"name": "Check Image Format", "args": [{"name": "image_format", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "image_format: str"}], "doc": "<p>Checks image format. If \"png\", returns default, else returns <span class=\"name\">image_format</span>. Args: image_format (str): format of the image, e.g. \"png\", \"jpg\", etc. Returns: str: image format file extension, e.g \".png\", \".jpg\"</p>", "shortdoc": "Checks image format. If \"png\", returns default, else returns `image_format`. Args:     image_format (str): format of the image, e.g. \"png\", \"jpg\", etc. Returns:     str: image format file extension, e.g \".png\", \".jpg\"", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\Ibasic\\IBasic.py", "lineno": 77}, {"name": "Check Ssim", "args": [{"name": "ssim", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "ssim: float"}], "doc": "<p>Checks, if <span class=\"name\">ssim</span> is of <span class=\"name\">&lt;float&gt;</span> type and if it is within &lt;0.0 , 1.0&gt; range. Args: ssim (float): SSIM value Raises: TypeError: ValueError: Returns: float: returns the SSIM value</p>", "shortdoc": "Checks, if `ssim` is of `<float>` type and if it is within <0.0 , 1.0> range. Args:     ssim (float): SSIM value Raises:     TypeError:     ValueError: Returns:     float: returns the SSIM value", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\Ibasic\\IBasic.py", "lineno": 54}, {"name": "Check Tess Path", "args": [{"name": "path_to_tess", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path_to_tess: str"}], "doc": "<p>Checks, whether <span class=\"name\">path_to tess</span> is equal to expected default. If so, returns default value. Else returns provided value. Args: path_to_tess (str): path to tesseract folder Returns: str: self.path_to_tesseract_folder</p>", "shortdoc": "Checks, whether `path_to tess` is equal to expected default. If so, returns default value. Else returns provided value. Args:     path_to_tess (str): path to tesseract folder Returns:     str: self.path_to_tesseract_folder", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\Ibasic\\IBasic.py", "lineno": 88}, {"name": "Compare Images", "args": [{"name": "base_image_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "base_image_path: str"}, {"name": "compared_image_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "compared_image_path: str"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "save_folder="}, {"name": "ssim", "types": [], "defaultValue": "1.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ssim=1.0"}, {"name": "image_format", "types": [], "defaultValue": "png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "image_format=png"}], "doc": "<p>Compares image on <span class=\"name\">compared_image_path</span> against base image on <span class=\"name\">base_image_path</span>. Args: base_image_path (str): path to base image compared_image_path (str): path to compared image save_folder (str): path to the save folder ssim (float): SSIM threshold value image_format (str): image format, e.g. \"png\", \"jpg\" Raises: TypeError:</p>", "shortdoc": "Compares image on `compared_image_path` against base image on `base_image_path`. Args:     base_image_path (str): path to base image     compared_image_path (str): path to compared image     save_folder (str): path to the save folder     ssim (float): SSIM threshold value     image_format (str): image format, e.g. \"png\", \"jpg\" Raises:     TypeError:", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\Image.py", "lineno": 121}, {"name": "Compare Screen Without Areas", "args": [{"name": "base_image_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "base_image_path: str"}, {"name": "compared_image_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "compared_image_path: str"}, {"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "NAMED_ONLY", "required": false, "repr": "save_folder="}, {"name": "ssim", "types": [], "defaultValue": "1.0", "kind": "NAMED_ONLY", "required": false, "repr": "ssim=1.0"}, {"name": "image_format", "types": [], "defaultValue": "png", "kind": "NAMED_ONLY", "required": false, "repr": "image_format=png"}], "doc": "<p>Compares two images without selected areas of the image. Args: base_image_path (str): path to the base image compared_image_path (str): path to the compared image save_folder (str): path to the save folder ssim (float): SSIM threshold value image_format (str): format of the image, e.g. \"png\", \"jpg\"</p>", "shortdoc": "Compares two images without selected areas of the image. Args:     base_image_path (str): path to the base image     compared_image_path (str): path to the compared image     save_folder (str): path to the save folder     ssim (float): SSIM threshold value     image_format (str): format of the image, e.g. \"png\", \"jpg\"", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\Image.py", "lineno": 168}, {"name": "Crop Image", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "x1", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x1: int"}, {"name": "y1", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y1: int"}, {"name": "x2", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x2: int"}, {"name": "y2", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y2: int"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "save_folder="}, {"name": "image_format", "types": [], "defaultValue": "png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "image_format=png"}], "doc": "<p>Creates cropped image and saves it. Args: path (str): path to the image x1 (int): x1 coords y1 (int): y1 coords x2 (int): x2 coords y2 (int): y2 coords save_folder (str): path to save folder image_format (str): format of the saved image, e.g. \"png\", \"jpg\"</p>", "shortdoc": "Creates cropped image and saves it. Args:     path (str): path to the image     x1 (int): x1 coords     y1 (int): y1 coords     x2 (int): x2 coords     y2 (int): y2 coords     save_folder (str): path to save folder     image_format (str): format of the saved image, e.g. \"png\", \"jpg\"", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\Image.py", "lineno": 234}, {"name": "Image Area On Text", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "coordinates", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*coordinates"}, {"name": "oem", "types": ["str"], "defaultValue": "3", "kind": "NAMED_ONLY", "required": false, "repr": "oem: str = 3"}, {"name": "psm", "types": ["str"], "defaultValue": "3", "kind": "NAMED_ONLY", "required": false, "repr": "psm: str = 3"}, {"name": "language", "types": ["str"], "defaultValue": "eng", "kind": "NAMED_ONLY", "required": false, "repr": "language: str = eng"}, {"name": "path_to_tesseract", "types": ["str"], "defaultValue": "", "kind": "NAMED_ONLY", "required": false, "repr": "path_to_tesseract: str = "}], "doc": "<p>Convert to text only the selected area of the image and return. Args: path (str): path to the image oem (str): Engine mode. Tesseract has several engine modes with different performance and speed. psm (str): Page Segmentation Mode (--psm). That affects how Tesseract splits image in lines of text and words. Pick the one which works best for you. language (str): [description] path_to_tesseract (str): path to the installed tesseract library Returns: Union[list[str], str]: returned text</p>", "shortdoc": "Convert to text only the selected area of the image and return. Args:     path (str): path to the image     oem (str): Engine mode. Tesseract has several engine modes with different performance and speed.     psm (str): Page Segmentation Mode (--psm). That affects how Tesseract splits image in lines of text and words. Pick the one which works best for you.     language (str): [description]     path_to_tesseract (str): path to the installed tesseract library Returns:     Union[list[str], str]: returned text", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\Tesseract.py", "lineno": 44}, {"name": "Image To String", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "oem", "types": ["str"], "defaultValue": "3", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "oem: str = 3"}, {"name": "psm", "types": ["str"], "defaultValue": "3", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "psm: str = 3"}, {"name": "language", "types": ["str"], "defaultValue": "eng", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "language: str = eng"}, {"name": "path_to_tesseract", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_to_tesseract="}], "doc": "<p>Converts provided image to string and returns. Args: path (str): path to the image oem (str): Engine mode. Tesseract has several engine modes with different performance and speed. psm (str): Page Segmentation Mode (--psm). That affects how Tesseract splits image in lines of text and words. Pick the one which works best for you. language (str): [description] path_to_tesseract (str): path to installed tesseract binary Returns: str: OCRed text from image</p>", "shortdoc": "Converts provided image to string and returns. Args:     path (str): path to the image     oem (str): Engine mode. Tesseract has several engine modes with different performance and speed.     psm (str): Page Segmentation Mode (--psm). That affects how Tesseract splits image in lines of text and words. Pick the one which works best for you.     language (str): [description]     path_to_tesseract (str): path to installed tesseract binary Returns:     str: OCRed text from image", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\Tesseract.py", "lineno": 15}, {"name": "Pdf To Image", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "name", "types": ["str"], "defaultValue": "img", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "name: str = img"}, {"name": "page_number", "types": ["int"], "defaultValue": "-1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_number: int = -1"}, {"name": "zoom", "types": ["int"], "defaultValue": "3", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "zoom: int = 3"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "save_folder="}], "doc": "<p>Converts pdf to image - .png format. Args: path (str): path to the .pdf file save_folder (str): path to the save folder name (str): name of the file of the image to be saved number_page (str): page from the pdf document to be saved as image. if value is <span class=\"name\">-1</span>, then saves all pages as separated .png files.</p>", "shortdoc": "Converts pdf to image - .png format. Args:     path (str): path to the .pdf file     save_folder (str): path to the save folder     name (str): name of the file of the image to be saved     number_page (str): page from the pdf document to be saved as image.     if value is `-1`, then saves all pages as separated .png files.", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\PDF.py", "lineno": 19}, {"name": "Return Text From Area", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "page_number", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "page_number: int"}, {"name": "x1", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x1: int"}, {"name": "y1", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y1: int"}, {"name": "x2", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x2: int"}, {"name": "y2", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y2: int"}], "doc": "<p>Opens provided PDF file and returns text from the given area. Args: path (str): path to the pdf file page_number (int): page number in the pdf file x1 (int): y1 (int): x2 (int): y2 (int): Returns: str: selected text from the area</p>", "shortdoc": "Opens provided PDF file and returns text from the given area. Args:     path (str): path to the pdf file     page_number (int): page number in the pdf file     x1 (int):     y1 (int):     x2 (int):     y2 (int): Returns:     str: selected text from the area", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\PDF.py", "lineno": 57}, {"name": "Rotate Image", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "screen_name", "types": [], "defaultValue": "rotate_img", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "screen_name=rotate_img"}, {"name": "angle", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "angle=0"}, {"name": "save_folder", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "save_folder="}, {"name": "image_format", "types": [], "defaultValue": "png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "image_format=png"}], "doc": "<p>Creates rotated version of the source image and saves it. Args: path (str): path to the source image screen_name (str): name of the screen save_folder (str): path to the save folder rotate (int): [description] image_format (str): [description] Raises: AssertionError: [description]</p>", "shortdoc": "Creates rotated version of the source image and saves it. Args:     path (str): path to the source image     screen_name (str): name of the screen     save_folder (str): path to the save folder     rotate (int): [description]     image_format (str): [description] Raises:     AssertionError: [description]", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\Image.py", "lineno": 270}, {"name": "Set Log Message", "args": [{"name": "work_object", "types": ["Literal['Image', 'PDF', 'Tesseract']"], "defaultValue": "Image", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "work_object: Literal['Image', 'PDF', 'Tesseract'] = Image"}, {"name": "type_of_messages", "types": ["Literal['Info', 'Error']"], "defaultValue": "Info", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "type_of_messages: Literal['Info', 'Error'] = Info"}, {"name": "path_to_image", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_to_image: str = "}], "doc": "<p>Sets logging message. Args: work_object (Literal[, optional): What object are we working on. Defaults to \"Image\". type_of_messages (Literal[, optional): Type of logging message. Defaults to \"Info\". path_to_image (str, optional): Path to image to be appended to log message. Defaults to \"\". Raises: AssertionError:</p>", "shortdoc": "Sets logging message. Args:     work_object (Literal[, optional): What object are we working on. Defaults to \"Image\".     type_of_messages (Literal[, optional): Type of logging message. Defaults to \"Info\".     path_to_image (str, optional): Path to image to be appended to log message.     Defaults to \"\". Raises:     AssertionError:", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\Ibasic\\IBasic.py", "lineno": 103}, {"name": "Should Exist This Text", "args": [{"name": "path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "page_number", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "page_number: int"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}], "doc": "<p>Verifies, whether given text is present in the document and given page. Args: path (str): path to pdf document page_number (int): page number text (str): text to check for presence Returns: bool: <span class=\"name\">True</span> if present, else <span class=\"name\">False</span></p>", "shortdoc": "Verifies, whether given text is present in the document and given page. Args:     path (str): path to pdf document     page_number (int): page number     text (str): text to check for presence Returns:     bool: `True` if present, else `False`", "tags": [], "source": "C:\\Repos\\WatchUI\\WatchUI\\keywords\\PDF.py", "lineno": 92}], "dataTypes": {"enums": [], "typedDicts": []}}
 </script>
 <title></title>
 </head>
diff --git a/pyproject.toml b/pyproject.toml
index 091f7cb..398af98 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -2,6 +2,9 @@
 name = "WatchUI"
 version = "2.0.1"
 description = "RobotFramework library package for automated visual testing."
+readme = "README.md"
+repository = "https://github.com/Tesena-smart-testing/WatchUI"
+documentation = "https://tesena-smart-testing.github.io/WatchUI/"
 authors = ["Jan Egermaier <jan.egermaier@tesena.com>", "Radek Bednarik <radek.bednarik@tesena.com>", "Michal Jirka <michal.jirka@tesena.com>", "Marcel Veselka <marcel.veselka@tesena.com>"]
 license = "MIT"
 classifiers = [
diff --git a/tasks.py b/tasks.py
index 97e48d6..91ebcc2 100644
--- a/tasks.py
+++ b/tasks.py
@@ -23,3 +23,7 @@ def docs():
 def test():
     """Run tests."""
     run("tests/test.robot")
+
+
+if __name__ == "__main__":
+    docs()