From 2cd6ee460d83d4387032d9d5509641ca28780c29 Mon Sep 17 00:00:00 2001 From: Ivan Maslov Date: Sun, 28 Feb 2021 20:55:01 +0300 Subject: [PATCH] Sphinx Guide first release will be ready in march 2021 (now 70%) Create autoreplace readme.md in root when build sphinx doc --- .gitignore | 3 +- README.md | 272 ++++++++++++++++++--- Sources/GuideSphinx/index.rst | 60 ++--- Sources/GuideSphinx/make_ENG_Guide.bat | 1 + Wiki/ENG_Guide/html/_sources/index.rst.txt | 48 ++-- Wiki/ENG_Guide/html/index.html | 96 ++++---- Wiki/ENG_Guide/html/searchindex.js | 2 +- Wiki/ENG_Guide/markdown/index.md | 116 ++++++--- 8 files changed, 433 insertions(+), 165 deletions(-) diff --git a/.gitignore b/.gitignore index 252ea1d6..3f58b938 100644 --- a/.gitignore +++ b/.gitignore @@ -22,4 +22,5 @@ **/.idea/** /**/screenshot.png /**/*.log -Wiki/ENG_Guide/doctrees \ No newline at end of file +Wiki/ENG_Guide/doctrees +screencapture_256_256.png \ No newline at end of file diff --git a/README.md b/README.md index dac84641..678b2df6 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,250 @@ -# pyOpenRPA + +# 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! -## 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) +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 + +### 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 progress) -## Wiki In wiki you can find: -- [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 -- [Theory & practice: Web app access (Chrome, Firefox, Opera)](Wiki/05.1.-Theory-&-practice.-Web-app-access-(Chrome,-Firefox,-Opera).md) -- [Theory & practice: Desktop app UI access (win32 and UI automation dlls)](Wiki/05.2.-Theory-&-practice.-Desktop-app-UI-access-(win32-and-UI-automation-dlls).md) -- Theory & practice: Keyboard & mouse manipulation -- Theory & practice: Screen capture & image recognition +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] -[Перейти в раздел туториалов](Wiki/RUS_Tutorial/README.md) - -# Copyrights & Contacts -pyOpenRPA is created by Ivan Maslov (Russia). Use it for free!
-*My purpose is to create [#IT4Business](https://www.facebook.com/RU.IT4Business) models.*
-If you need IT help feel free to contact me.
-## My contacts:
-E-mail: Ivan.Maslov@UnicodeLabs.ru
-Skype: MegaFinder
-Facebook: https://www.facebook.com/RU.Ivan.Maslov
-LinkedIn: https://www.linkedin.com/in/RU-IvanMaslov/ - -#License -Under the MIT license (absolutely free) \ No newline at end of file + + +* [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](https://money.yandex.ru/to/4100115560661986) + +## Content + + +* 1. How to install + + + * How to check installation + + + * System requirements + + +* 2. Roadmap + + +* 3. Copyrights & Contacts + + + * Ivan Maslov (founder) + + + * 3-rd party components license dependencies + + + +* 1. Description + + + * pyOpenRPA Robot + + +* 2. Defs + + + * pyOpenRPA.Robot.UIDesktop + + + * References + + +* 3. How to start + + +* 4. Dependencies + + + +* 1. Description + + +* 2. How to use + + + * Content + + + * How to run + + + * UI Description + + + * How to extract UI tree + + + * How to extract UI object properties + + + +* 1. Description + + + * Global settings dict concept + + + * Orchestrator how to configure + + + * Orchestrator architecture + + + * Component Processor + + + * References + + +* 2. Defs + + + * pyOpenRPA.Orchestrator.__Orchestrator__ + + + * Group Agent… + + + * Group GSettings… + + + * Group OS… + + + * Group Process… + + + * Group Processor… + + + * Group Python… + + + * Group RDPSession… + + + * Group Web… + + + * Group UAC… + + + * Group Scheduler… + + + * References + + +* 3. gSettings Template + + +* 4. How to start process diff --git a/Sources/GuideSphinx/index.rst b/Sources/GuideSphinx/index.rst index ea5a34ee..059ac032 100644 --- a/Sources/GuideSphinx/index.rst +++ b/Sources/GuideSphinx/index.rst @@ -3,10 +3,18 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +#################################### Welcome to pyOpenRPA's wiki -===================================== +#################################### +************************************************** +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 ************************************************** About @@ -23,48 +31,53 @@ At the time of this writing the pyOpenRPA is successfully using in several big R ************************************************** Structure ************************************************** -## The OpenRPA has 3 main tools: + +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.
-___ + +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` -___ + +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` -___ + +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 +Guide (in progress) ************************************************** In wiki you can find: in QUEUE @@ -76,19 +89,10 @@ Theory & practice: Screen capture & image recognition ************************************************** Tutorials ************************************************** -[ENG] -Content in progress -[RUS] -Перейти в раздел туториалов - -************************************************** -Donate -************************************************** +- [ENG] Content in progress +- [RUS] Перейти в раздел туториалов -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 ************************************************** diff --git a/Sources/GuideSphinx/make_ENG_Guide.bat b/Sources/GuideSphinx/make_ENG_Guide.bat index d24c66c9..4988c383 100644 --- a/Sources/GuideSphinx/make_ENG_Guide.bat +++ b/Sources/GuideSphinx/make_ENG_Guide.bat @@ -32,6 +32,7 @@ if errorlevel 9009 ( %SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% %SPHINXBUILD% -M markdown %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% ..\..\Wiki\ENG_Guide\html\index.html +copy /y ..\..\Wiki\ENG_Guide\markdown\index.md ..\..\readme.md goto end :help diff --git a/Wiki/ENG_Guide/html/_sources/index.rst.txt b/Wiki/ENG_Guide/html/_sources/index.rst.txt index ea5a34ee..b5e4b888 100644 --- a/Wiki/ENG_Guide/html/_sources/index.rst.txt +++ b/Wiki/ENG_Guide/html/_sources/index.rst.txt @@ -3,10 +3,9 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +#################################### Welcome to pyOpenRPA's wiki -===================================== - - +#################################### ************************************************** About @@ -23,48 +22,53 @@ At the time of this writing the pyOpenRPA is successfully using in several big R ************************************************** Structure ************************************************** -## The OpenRPA has 3 main tools: + +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.
-___ + +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` -___ + +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` -___ + +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 +Guide (in progress) ************************************************** In wiki you can find: in QUEUE @@ -76,10 +80,8 @@ Theory & practice: Screen capture & image recognition ************************************************** Tutorials ************************************************** -[ENG] -Content in progress -[RUS] -Перейти в раздел туториалов +- [ENG] Content in progress +- [RUS] Перейти в раздел туториалов ************************************************** Donate diff --git a/Wiki/ENG_Guide/html/index.html b/Wiki/ENG_Guide/html/index.html index 479aba19..08f139c3 100644 --- a/Wiki/ENG_Guide/html/index.html +++ b/Wiki/ENG_Guide/html/index.html @@ -187,48 +187,54 @@ At the time of this writing the pyOpenRPA is successfully using in several big R

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.<br> -___ -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 -___

+
+

The OpenRPA has 3 main tools:

+
    +
  • Studio

  • +
  • Robot

  • +
  • Orchestrator

  • +
+
+
+

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)

  • +
-
-

Guide

+
+

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 progress)

In wiki you can find: in QUEUE Theory & practice: Web app access (Chrome, Firefox, Opera) @@ -238,10 +244,10 @@ Theory & practice: Screen capture & image recognition

Tutorials

-

[ENG] -Content in progress -[RUS] -Перейти в раздел туториалов

+
    +
  • [ENG] Content in progress

  • +
  • [RUS] Перейти в раздел туториалов

  • +