From d7eafa90c3407c7826e522a091855fa4647dfbf1 Mon Sep 17 00:00:00 2001 From: Ivan Maslov Date: Sun, 28 Feb 2021 20:39:48 +0300 Subject: [PATCH] Update sphinx doc in Orchestrator and in UIDesktop Orchestrator autodoc 80% Robot UIDesktop 30% --- README.md | 23 -- Sources/GuideSphinx/01_HowToInstall.rst | 29 ++ Sources/GuideSphinx/02_RoadMap.rst | 13 + .../GuideSphinx/03_Copyrights_Contacts.rst | 32 ++ Sources/GuideSphinx/Robot/03_HowToStart.rst | 71 ++++ Sources/GuideSphinx/Robot/04_Dependencies.rst | 10 + .../Studio/{Studio.rst => 01_Studio.rst} | 2 +- Sources/GuideSphinx/Studio/02_HowToUse.rst | 107 ++++++ Sources/GuideSphinx/conf.py | 2 +- Sources/GuideSphinx/index.rst | 103 +++++- Wiki/ENG_Guide/html/.buildinfo | 2 +- Wiki/ENG_Guide/html/01_HowToInstall.html | 258 +++++++++++++ Wiki/ENG_Guide/html/02_RoadMap.html | 252 +++++++++++++ .../html/03_Copyrights_Contacts.html | 257 +++++++++++++ .../html/Orchestrator/01_Orchestrator.html | 19 +- Wiki/ENG_Guide/html/Orchestrator/02_Defs.html | 75 ++-- .../Orchestrator/03_gSettingsTemplate.html | 15 +- .../html/Orchestrator/04_HowToStart.html | 15 +- Wiki/ENG_Guide/html/Robot/01_Robot.html | 19 +- Wiki/ENG_Guide/html/Robot/02_Defs.html | 19 +- Wiki/ENG_Guide/html/Robot/03_HowToStart.html | 287 +++++++++++++++ .../ENG_Guide/html/Robot/04_Dependencies.html | 236 ++++++++++++ .../Studio/{Studio.html => 01_Studio.html} | 31 +- Wiki/ENG_Guide/html/Studio/02_HowToUse.html | 345 ++++++++++++++++++ Wiki/ENG_Guide/html/_modules/index.html | 15 +- .../Orchestrator/__Orchestrator__.html | 15 +- .../_modules/pyOpenRPA/Robot/UIDesktop.html | 15 +- .../html/_sources/01_HowToInstall.rst.txt | 29 ++ .../html/_sources/02_RoadMap.rst.txt | 13 + .../_sources/03_Copyrights_Contacts.rst.txt | 32 ++ .../_sources/Orchestrator/02_Defs.rst.txt | 20 +- .../html/_sources/Robot/03_HowToStart.rst.txt | 71 ++++ .../_sources/Robot/04_Dependencies.rst.txt | 10 + .../{Studio.rst.txt => 01_Studio.rst.txt} | 2 +- .../html/_sources/Studio/02_HowToUse.rst.txt | 107 ++++++ Wiki/ENG_Guide/html/_sources/index.rst.txt | 103 +++++- Wiki/ENG_Guide/html/genindex.html | 15 +- Wiki/ENG_Guide/html/index.html | 149 +++++++- Wiki/ENG_Guide/html/objects.inv | Bin 1052 -> 1162 bytes Wiki/ENG_Guide/html/py-modindex.html | 15 +- Wiki/ENG_Guide/html/search.html | 15 +- Wiki/ENG_Guide/html/searchindex.js | 2 +- Wiki/ENG_Guide/markdown/01_HowToInstall.md | 29 ++ Wiki/ENG_Guide/markdown/02_RoadMap.md | 28 ++ .../markdown/03_Copyrights_Contacts.md | 27 ++ .../markdown/Orchestrator/02_Defs.md | 20 +- .../ENG_Guide/markdown/Robot/03_HowToStart.md | 68 ++++ .../markdown/Robot/04_Dependencies.md | 8 + .../Studio/{Studio.md => 01_Studio.md} | 2 +- Wiki/ENG_Guide/markdown/Studio/02_HowToUse.md | 98 +++++ Wiki/ENG_Guide/markdown/index.md | 148 +++++++- 51 files changed, 3100 insertions(+), 178 deletions(-) create mode 100644 Sources/GuideSphinx/01_HowToInstall.rst create mode 100644 Sources/GuideSphinx/02_RoadMap.rst create mode 100644 Sources/GuideSphinx/03_Copyrights_Contacts.rst create mode 100644 Sources/GuideSphinx/Robot/03_HowToStart.rst create mode 100644 Sources/GuideSphinx/Robot/04_Dependencies.rst rename Sources/GuideSphinx/Studio/{Studio.rst => 01_Studio.rst} (86%) create mode 100644 Sources/GuideSphinx/Studio/02_HowToUse.rst create mode 100644 Wiki/ENG_Guide/html/01_HowToInstall.html create mode 100644 Wiki/ENG_Guide/html/02_RoadMap.html create mode 100644 Wiki/ENG_Guide/html/03_Copyrights_Contacts.html create mode 100644 Wiki/ENG_Guide/html/Robot/03_HowToStart.html create mode 100644 Wiki/ENG_Guide/html/Robot/04_Dependencies.html rename Wiki/ENG_Guide/html/Studio/{Studio.html => 01_Studio.html} (72%) create mode 100644 Wiki/ENG_Guide/html/Studio/02_HowToUse.html create mode 100644 Wiki/ENG_Guide/html/_sources/01_HowToInstall.rst.txt create mode 100644 Wiki/ENG_Guide/html/_sources/02_RoadMap.rst.txt create mode 100644 Wiki/ENG_Guide/html/_sources/03_Copyrights_Contacts.rst.txt create mode 100644 Wiki/ENG_Guide/html/_sources/Robot/03_HowToStart.rst.txt create mode 100644 Wiki/ENG_Guide/html/_sources/Robot/04_Dependencies.rst.txt rename Wiki/ENG_Guide/html/_sources/Studio/{Studio.rst.txt => 01_Studio.rst.txt} (86%) create mode 100644 Wiki/ENG_Guide/html/_sources/Studio/02_HowToUse.rst.txt create mode 100644 Wiki/ENG_Guide/markdown/01_HowToInstall.md create mode 100644 Wiki/ENG_Guide/markdown/02_RoadMap.md create mode 100644 Wiki/ENG_Guide/markdown/03_Copyrights_Contacts.md create mode 100644 Wiki/ENG_Guide/markdown/Robot/03_HowToStart.md create mode 100644 Wiki/ENG_Guide/markdown/Robot/04_Dependencies.md rename Wiki/ENG_Guide/markdown/Studio/{Studio.md => 01_Studio.md} (72%) create mode 100644 Wiki/ENG_Guide/markdown/Studio/02_HowToUse.md diff --git a/README.md b/README.md index 7e1738fa..dac84641 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,8 @@ Powerfull OpenSource RPA tool for business (based on python 3). Best perfomance ## Donate pyOpenRPA is absolutely non-commercial project. [Please donate some money if this project is important for you. Link to online donations.](https://money.yandex.ru/to/4100115560661986) -## Road map -- Wiki - - ENG - in progress (see content below), plan date 31.08.2020 - - Translate page Theory & practice: Desktop app in english [done 19.08.2020] - - Create page Theory & practice: Keyboard & mouse manipulation [plan 31.08.2020] - - RUS - next step -- Tutorial - - ENG - next step - - RUS - in progress (see content below), plan date 18.09.2020 -- Dev actions - - Refactoring the arguments in UIDesktop.py (only in new branch pyOpenRPA version. For backward compatibility purpose), plan date - - ## Wiki In wiki you can find: -- [About pyOpenRPA, library dependencies and licensing](Wiki/01.-About-OpenRPA,-library-dependencies-and-licensing.md) -- [Architecture (Studio, Robot, Orchestrator)](Wiki/02.-Architecture-(Studio,-Robot,-Orchestrator).md) -- [How to install (system requirements)](Wiki/03.-How-to-install-(system-requirements).md) - [Tool Studio: How to use](Wiki/04.1.-Tool-Studio.-How-to-use.md) - [Tool Robot: How to use](Wiki/04.2.-Tool-Robot.-How-to-use.md) - Tool Orchestrator: How to use @@ -45,13 +30,5 @@ Skype: MegaFinder
Facebook: https://www.facebook.com/RU.Ivan.Maslov
LinkedIn: https://www.linkedin.com/in/RU-IvanMaslov/ -# Dependencies -* Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* pywinauto (Windows GUI automation) -* Semantic UI CSS framework -* JsRender by https://www.jsviews.com (switch to Handlebars) -* Handlebars - #License Under the MIT license (absolutely free) \ No newline at end of file diff --git a/Sources/GuideSphinx/01_HowToInstall.rst b/Sources/GuideSphinx/01_HowToInstall.rst new file mode 100644 index 00000000..6b279a32 --- /dev/null +++ b/Sources/GuideSphinx/01_HowToInstall.rst @@ -0,0 +1,29 @@ +#################################### +1. How to install +#################################### + +Are you ready to install the OpenRPA solution on your machine?
+ +Ok, we start.
+**Do the following operations:** +- Download the OpenRPA package from master branch on GitLab [Download ZIP](https://gitlab.com/UnicodeLabs/OpenRPA/-/archive/master/OpenRPA-master.zip) +- Unzip the package + +**Installation has been completed :)** + +************************************************** +How to check installation +************************************************** +- Run portable python (built in the OpenRPA) + - x32 python (OpenRPA\Resources\WPy32-3720\python-3.7.2\python.exe) + - x64 python (OpenRPA\Resources\WPy64-3720\python-3.7.2.amd64\python.exe) + +**The OpenRPA has been successfully installed if the portable python 3.7.2 was started without any exceptions (see screenshot).** +![image](uploads/cb5dec8cecafa7d64f6cd14b2672acce/image.png) + +************************************************** +System requirements +************************************************** +- OS Windows 7+ + - Need Windows package KB2999226 if use windows Vista/7/8/8.1/Server 2008/Server 2012 [Download package](https://support.microsoft.com/ru-ru/help/2999226) +- For OpenCV: OS Windows 7/8/8/10 only (no Windows Server) \ No newline at end of file diff --git a/Sources/GuideSphinx/02_RoadMap.rst b/Sources/GuideSphinx/02_RoadMap.rst new file mode 100644 index 00000000..5a6e1ab8 --- /dev/null +++ b/Sources/GuideSphinx/02_RoadMap.rst @@ -0,0 +1,13 @@ +#################################### +2. Roadmap +#################################### + +- Guide +- - ENG - in progress (see content below), plan date 31.08.2020 (failed), new plan date march 2021 +- - RUS - queue +- Tutorial +- - ENG - queue +- - RUS - queue +- Dev actions + +Refactoring the arguments in UIDesktop.py (only in new branch pyOpenRPA version. For backward compatibility purpose), plan date - \ No newline at end of file diff --git a/Sources/GuideSphinx/03_Copyrights_Contacts.rst b/Sources/GuideSphinx/03_Copyrights_Contacts.rst new file mode 100644 index 00000000..c2fd69ad --- /dev/null +++ b/Sources/GuideSphinx/03_Copyrights_Contacts.rst @@ -0,0 +1,32 @@ +#################################### +3. Copyrights & Contacts +#################################### + +pyOpenRPA is created by Ivan Maslov (Russia). +Use it absolutely for free! + +My purpose is to create #IT4Business models all over the world. +If you need IT help feel free to contact me (prefer e-mail or skype). + +Thank you! + +************************************************** +Ivan Maslov (founder) +************************************************** +E-mail: Ivan.Maslov@UnicodeLabs.ru +Skype: MegaFinder +Facebook: https://www.facebook.com/RU.Ivan.Maslov +LinkedIn: https://www.linkedin.com/in/RU-IvanMaslov/ + + +************************************************** +3-rd party components license dependencies +************************************************** +WinPython 3.7.1 32-bit & 64-bit, license MIT (https://github.com/winpython/winpython) +Selenium v..., license Apache 2.0 +pywinauto 0.6.5, license BSD 3-Clause (https://github.com/pywinauto/pywinauto) +Semantic UI ..., license MIT (https://github.com/Semantic-Org/Semantic-UI) +PyAutoGUI ..., license BSD 3-Clause (https://github.com/asweigart/pyautogui) +keyboard ..., license MIT (https://github.com/boppreh/keyboard) +OpenCV ... +pywin32 \ No newline at end of file diff --git a/Sources/GuideSphinx/Robot/03_HowToStart.rst b/Sources/GuideSphinx/Robot/03_HowToStart.rst new file mode 100644 index 00000000..7c54a33e --- /dev/null +++ b/Sources/GuideSphinx/Robot/03_HowToStart.rst @@ -0,0 +1,71 @@ +#################################### +3. How to start +#################################### + +# Content +- [About](#about) +- [How to use](#how-to-use) +- [Create python script](#create-python-script) +- [Execute python script](#execute-python-script) + +# About +The Robot tool is the main module for production process automation. It has no graphic/console interface. All low-level actions to OS are perfoming by the Robot tool in OpenRPA. + +# How to use +You can use the robot by the several ways: +- In Python script +- In Studio script (n/a) + + +## Create python script +In order to use robot just add Robot tool folder in work directory and add line "import GUI" in your script. +### Example +> import sys
+> sys.path.append('../../')
+> import selenium [#Web app access](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.1.-Theory-&-practice:-Web-app-access-(Chrome,-Firefox,-Opera))
+> import GUI [#Win32 & UI Automation access](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.2.-Theory-&-practice:-Desktop-app-UI-access-(win32-and-UI-automation-dlls))
+> import pyautogui [#Screen capture/recognition](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.4.-Theory-&-practice:-Screen-capture-&-image-recognition) [#Mouse manipulation](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.3.-Theory-&-practice:-Keyboard-&-mouse-manipulation)
+> import cv2 [#Computer vision](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.4.-Theory-&-practice:-Screen-capture-&-image-recognition)
+> import keyboard [#Keyboard manipulation](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.3.-Theory-&-practice:-Keyboard-&-mouse-manipulation)
+ +## Execute python script +The OpenRPA is fully portable solution. It contains own python enviroment both 32 and 64 bit versions. So, you can execute your python script in several ways: +- Execute in python x32 (\OpenRPA\Resources\WPy32-3720\python-3.7.2) +- Execute in python x64 (\OpenRPA\Resources\WPy64-3720\python-3.7.2.amd64) +- Execute from .cmd file + +### Execute in the Python x32 +To execute your python script in x32 bit version just write in command line from x32 python directory:
+> cd "\OpenRPA\Resources\WPy32-3720\python-3.7.2"
+> python.exe "path to your python script.py"
+ +### Execute in the Python x64 +To execute your python script in x32 bit version just write in command line from x32 python directory:
+> cd "\OpenRPA\Resources\WPy64-3720\python-3.7.2.amd64"
+> python.exe "path to your python script.py"
+ +### Execute from .cmd file +In order to simplify the execution process you can write several code lines in file with the .cmd extansion:
+> cd %~dp0 +> copy /Y ..\Resources\WPy32-3720\python-3.7.2\python.exe ..\Resources\WPy32-3720\python-3.7.2\OpenRPAOrchestrator.exe +> .\..\Resources\WPy32-3720\python-3.7.2\OpenRPAOrchestrator.exe orchestratorMain.py +> pause >nul + +## Use in studio script (n/a) + +> import sys
+> sys.path.append('../../')
+> import GUI
+> import keyboard
+> import subprocess
+> import time
+> +> #Highlight the UI Object in Folder explorer
+> GUI.UIOSelector_FocusHighlight([{"class_name":"CabinetWClass","backend":"uia"},{"ctrl_index":2},{"ctrl_index":0},{"ctrl_index":2},{"ctrl_index":0}])
+> +>#Wait 2 seconds
+>time.sleep(3)
+> +>#Loop: get child element of UI List
+>for lItem in GUI.UIOSelector_Get_UIO([{"class_name":"CabinetWClass","backend":"uia"},{"ctrl_index":2},{"ctrl_index":0},{"ctrl_index":2},{"ctrl_index":0}]).children():
+>         print(str(lItem))
diff --git a/Sources/GuideSphinx/Robot/04_Dependencies.rst b/Sources/GuideSphinx/Robot/04_Dependencies.rst new file mode 100644 index 00000000..072b606c --- /dev/null +++ b/Sources/GuideSphinx/Robot/04_Dependencies.rst @@ -0,0 +1,10 @@ +#################################### +4. Dependencies +#################################### + +Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] +Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] +pywinauto (Windows GUI automation) +Semantic UI CSS framework +JsRender by https://www.jsviews.com (switch to Handlebars) +Handlebars \ No newline at end of file diff --git a/Sources/GuideSphinx/Studio/Studio.rst b/Sources/GuideSphinx/Studio/01_Studio.rst similarity index 86% rename from Sources/GuideSphinx/Studio/Studio.rst rename to Sources/GuideSphinx/Studio/01_Studio.rst index 3f4cf4e0..55375546 100644 --- a/Sources/GuideSphinx/Studio/Studio.rst +++ b/Sources/GuideSphinx/Studio/01_Studio.rst @@ -1,5 +1,5 @@ ************************ -Description +1. Description ************************ pyOpenRPA Studio is the executable process. diff --git a/Sources/GuideSphinx/Studio/02_HowToUse.rst b/Sources/GuideSphinx/Studio/02_HowToUse.rst new file mode 100644 index 00000000..0b7dae91 --- /dev/null +++ b/Sources/GuideSphinx/Studio/02_HowToUse.rst @@ -0,0 +1,107 @@ +#################################### +2. How to use +#################################### + +Content +======= + +- `How to run <#how-to-run>`__ +- `UI Description <#ui-description>`__ +- `How to extract UI tree <#how-to-extract-ui-tree>`__ +- `How to search UI object by mouse + hover <#how-to-search-ui-object-by-mouse-hover>`__ +- `How to extract UI object + properties <#how-to-extract-ui-object-properties>`__ + +How to run +========== + +- For OS x32 +- Run (double click): OpenRPA\_32.cmd (for OS x32) +- For OS x64 +- Run (double click): OpenRPA\_64.cmd (for OS x64) +- Wait text "running server" in console. Default browser will be open + automatically +- **Attention!** The studio tool does not support the Internet explorer + (any version) for GUI rendering (lol) |image| + +UI Description +============== + +**The studio tool GUI contains of:** - 1. UI tree viewer - 2. Selected +UI object hierarchy list - 3. Selected UI object property list - 4. UIO +selector editor - 5. UIO action panel - 6. Another Python activity panel +- 7. Action/activity list + +*Look it on the GUI screenshots are listed below* + +GUI Screenshot 1 +---------------- + +.. figure:: uploads/d3d6ad14a7e50843bd89d2b14a092fee/image.png + :alt: image + + image +GUI Screenshot 2 +---------------- + +.. figure:: uploads/65b7d51c0a5b21e6b27dc23d4062d3ca/image.png + :alt: image + + image +How to extract UI tree +====================== + +In order to extract the UI tree do the following: in ``UI tree viewer`` +choose the object you are interested and click the button "Expand". ## +Action: Click the button "Expand" |image| ## Result |image| # How to +search UI object by mouse hover In order to search UI object do the +following: in ``UI tree viewer`` choose the parent object, where you are +want to search UI object, and click the button "Mouse search". The mouse +search mode will start. Turn mouse on the UI object you are interested +and wait when the studio will highlight the UI object. After the +hightlight hold the "Ctrl" key and wait 3 seconds. The interested UI +object will be shown in ``UI tree viewer``. + +Action: Click the button "Mouse search" +--------------------------------------- + +.. figure:: uploads/84d7e4de0c840631f87cf7b325b53ad8/image.png + :alt: image + + image +Action: Turn mouse on the UI object you are interested and hold the "Ctrl" key for 3 seconds +-------------------------------------------------------------------------------------------- + +.. figure:: uploads/b7c38d622bf5b7afa5b26d1686d7302a/image.png + :alt: image + + image +Result: The interested UI object will be shown in ``UI tree viewer`` +-------------------------------------------------------------------- + +.. figure:: uploads/629bbf4db2c01b9c640194230949fcd2/image.png + :alt: image + + image +How to extract UI object properties +=================================== + +In order to extract UI object properties do the following: in +``Selected UI object hierarchy list`` choose the UI object you are +interested and click it. The UI object property list will be shown in +``Selected UI object property list`` ## Action: Choose the UI object you +are interested and click it |image| + +Result: The UI object property list will be shown in ``Selected UI object property list`` +----------------------------------------------------------------------------------------- + +.. figure:: uploads/f235ae29099a713e0246cd574ac3a17c/image.png + :alt: image + + image + +.. |image| image:: uploads/504b98f76747f63900a2943532a946bb/image.png +.. |image| image:: uploads/6effc376ff6ea928840674bd744caced/image.png +.. |image| image:: uploads/18b9ab36126c8c32168bf5bbb9330701/image.png +.. |image| image:: uploads/2c27be5bdde20b5d062cbb40e74eaec5/image.png diff --git a/Sources/GuideSphinx/conf.py b/Sources/GuideSphinx/conf.py index 5376d289..1d409f7c 100644 --- a/Sources/GuideSphinx/conf.py +++ b/Sources/GuideSphinx/conf.py @@ -19,7 +19,7 @@ sys.path.insert(0, os.path.abspath(r'..')) # -- Project information ----------------------------------------------------- project = 'pyOpenRPA' -copyright = '2020, Ivan Maslov' +copyright = '2021, Ivan Maslov' author = 'Ivan Maslov' # The full version, including alpha/beta/rc tags diff --git a/Sources/GuideSphinx/index.rst b/Sources/GuideSphinx/index.rst index 81357a57..ea5a34ee 100644 --- a/Sources/GuideSphinx/index.rst +++ b/Sources/GuideSphinx/index.rst @@ -3,33 +3,122 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to pyOpenRPA's documentation! +Welcome to pyOpenRPA's wiki ===================================== + + +************************************************** +About +************************************************** +Dear RPA-tors. Let me congratulate you with great change in the RPA world. The first enterprise level open source RPA platform is here! + +The pyOpenRPA - free, fast and reliable +Powerfull OpenSource RPA tool for business (based on python 3). Best perfomance and absolutely free! + +The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. +The pyOpenRPA is distributed under the MIT license which allows you to use it in any way you want and any time you need without any restrictions. +At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. + +************************************************** +Structure +************************************************** +## The OpenRPA has 3 main tools: +- Studio +- Robot +- Orchestrator +## Description +`Studio` +___ +Studio tool has been developed to help RPA-tors to create the robot algorythms.
+___ +**Features** +- Run actions +- Create visual algorythms of the robot +- Desktop app: Analyze desktop app ui tree +- Desktop app: Search desktop app ui by mouse +- Desktop app: Generate & edit the UIO Selector +___ +`Robot` +___ +The Robot tool is the core of any action execution in OpenRPA. All action from algorythms are perfoming by the Robot tool. It looks like a console process without graphic user interface. +___ +**Features** +- Based on Python (killer feature) +- Support Win32 GUI framework (desktop app) +- Support UI automation framework (desktop app) +- Support Selenium (web app) +- Support PyAutoGUI (screen capture & mouse) +- Support OpenCV (computer vision) +___ +`Orchestrator` +___ +The Orchestrator tool has been developed to maintain robot infrastructure (2+ robots algorythm). +___ +**Features** +- Start/Stop robot algorythm +- Robot scheduler +- Remote machine screenshot viewer +- Remote machine cmd shell +- Remote machine logs storage +___ + +************************************************** +Guide +************************************************** +In wiki you can find: +in QUEUE +Theory & practice: Web app access (Chrome, Firefox, Opera) +Theory & practice: Desktop app UI access (win32 and UI automation dlls) +Theory & practice: Keyboard & mouse manipulation +Theory & practice: Screen capture & image recognition + +************************************************** +Tutorials +************************************************** +[ENG] +Content in progress +[RUS] +Перейти в раздел туториалов + +************************************************** +Donate +************************************************** + +pyOpenRPA is absolutely non-commercial project. + +Please donate some $ if pyOpenRPA project is actual for you. Link to online donations. +https://money.yandex.ru/to/4100115560661986 + + +************************************************** +Content +************************************************** + .. toctree:: :maxdepth: 2 :caption: GENERAL :glob: - + * .. toctree:: :maxdepth: 2 :caption: ROBOT :glob: - + Robot/* - + .. toctree:: :maxdepth: 2 :caption: STUDIO :glob: - + Studio/* - + .. toctree:: :maxdepth: 3 :caption: ORCHESTRATOR :glob: - + Orchestrator/* \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/.buildinfo b/Wiki/ENG_Guide/html/.buildinfo index 2a953b20..330405ef 100644 --- a/Wiki/ENG_Guide/html/.buildinfo +++ b/Wiki/ENG_Guide/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: b242bb7d21650146bd8bbd75ad743c60 +config: 4684de90a0b3a55bab26cddd161e3220 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/Wiki/ENG_Guide/html/01_HowToInstall.html b/Wiki/ENG_Guide/html/01_HowToInstall.html new file mode 100644 index 00000000..eed01cff --- /dev/null +++ b/Wiki/ENG_Guide/html/01_HowToInstall.html @@ -0,0 +1,258 @@ + + + + + + + + + + 1. How to install — pyOpenRPA v1.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

1. How to install

+

Are you ready to install the OpenRPA solution on your machine?<br>

+

Ok, we start. <br> +Do the following operations: +- Download the OpenRPA package from master branch on GitLab [Download ZIP](https://gitlab.com/UnicodeLabs/OpenRPA/-/archive/master/OpenRPA-master.zip) +- Unzip the package

+

Installation has been completed :)

+
+

How to check installation

+
    +

  • Run portable python (built in the OpenRPA) +- x32 python (OpenRPAResourcesWPy32-3720python-3.7.2python.exe) +- x64 python (OpenRPAResourcesWPy64-3720python-3.7.2.amd64python.exe)

    • +
+

The OpenRPA has been successfully installed if the portable python 3.7.2 was started without any exceptions (see screenshot). +![image](uploads/cb5dec8cecafa7d64f6cd14b2672acce/image.png)

+
+
+

System requirements

+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/02_RoadMap.html b/Wiki/ENG_Guide/html/02_RoadMap.html new file mode 100644 index 00000000..d2908441 --- /dev/null +++ b/Wiki/ENG_Guide/html/02_RoadMap.html @@ -0,0 +1,252 @@ + + + + + + + + + + 2. Roadmap — pyOpenRPA v1.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

2. Roadmap

+
    +

  • Guide

    • +
    • +

    • ENG - in progress (see content below), plan date 31.08.2020 (failed), new plan date march 2021

      • +
    +
    • +
    • +

    • RUS - queue

      • +
    +
    • +

  • Tutorial

    • +
    • +

    • ENG - queue

      • +
    +
    • +
    • +

    • RUS - queue

      • +
    +
    • +

  • Dev actions

    • +
+

Refactoring the arguments in UIDesktop.py (only in new branch pyOpenRPA version. For backward compatibility purpose), plan date -

+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/03_Copyrights_Contacts.html b/Wiki/ENG_Guide/html/03_Copyrights_Contacts.html new file mode 100644 index 00000000..a85d9439 --- /dev/null +++ b/Wiki/ENG_Guide/html/03_Copyrights_Contacts.html @@ -0,0 +1,257 @@ + + + + + + + + + + 3. Copyrights & Contacts — pyOpenRPA v1.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

3. Copyrights & Contacts

+

pyOpenRPA is created by Ivan Maslov (Russia). +Use it absolutely for free!

+

My purpose is to create #IT4Business models all over the world. +If you need IT help feel free to contact me (prefer e-mail or skype).

+

Thank you!

+
+

Ivan Maslov (founder)

+

E-mail: Ivan.Maslov@UnicodeLabs.ru +Skype: MegaFinder +Facebook: https://www.facebook.com/RU.Ivan.Maslov +LinkedIn: https://www.linkedin.com/in/RU-IvanMaslov/

+
+
+

3-rd party components license dependencies

+

WinPython 3.7.1 32-bit & 64-bit, license MIT (https://github.com/winpython/winpython) +Selenium v…, license Apache 2.0 +pywinauto 0.6.5, license BSD 3-Clause (https://github.com/pywinauto/pywinauto) +Semantic UI …, license MIT (https://github.com/Semantic-Org/Semantic-UI) +PyAutoGUI …, license BSD 3-Clause (https://github.com/asweigart/pyautogui) +keyboard …, license MIT (https://github.com/boppreh/keyboard) +OpenCV … +pywin32

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Orchestrator/01_Orchestrator.html b/Wiki/ENG_Guide/html/Orchestrator/01_Orchestrator.html index 0276e5fd..da983d76 100644 --- a/Wiki/ENG_Guide/html/Orchestrator/01_Orchestrator.html +++ b/Wiki/ENG_Guide/html/Orchestrator/01_Orchestrator.html @@ -39,7 +39,7 @@ - + @@ -84,14 +84,23 @@ -

ROBOT

+

GENERAL

+ +

ROBOT

STUDIO

ORCHESTRATOR