Sphinx Guide first release will be ready in march 2021 (now 70%)

Create autoreplace readme.md in root when build sphinx doc
dev-linux
Ivan Maslov 4 years ago
parent d7eafa90c3
commit 2cd6ee460d

1
.gitignore vendored

@ -23,3 +23,4 @@
/**/screenshot.png /**/screenshot.png
/**/*.log /**/*.log
Wiki/ENG_Guide/doctrees Wiki/ENG_Guide/doctrees
screencapture_256_256.png

@ -1,34 +1,250 @@
# pyOpenRPA <!-- pyOpenRPA documentation master file, created by
sphinx-quickstart on Sat Dec 19 23:59:00 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. -->
# Welcome to pyOpenRPAs 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! Powerfull OpenSource RPA tool for business (based on python 3). Best perfomance and absolutely free!
## Donate 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.
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 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: In wiki you can find:
- [Tool Studio: How to use](Wiki/04.1.-Tool-Studio.-How-to-use.md) in QUEUE
- [Tool Robot: How to use](Wiki/04.2.-Tool-Robot.-How-to-use.md) Theory & practice: Web app access (Chrome, Firefox, Opera)
- Tool Orchestrator: How to use Theory & practice: Desktop app UI access (win32 and UI automation dlls)
- [Theory & practice: Web app access (Chrome, Firefox, Opera)](Wiki/05.1.-Theory-&-practice.-Web-app-access-(Chrome,-Firefox,-Opera).md) Theory & practice: Keyboard & mouse manipulation
- [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: Screen capture & image recognition
- Theory & practice: Keyboard & mouse manipulation
- Theory & practice: Screen capture & image recognition
## Tutorials ## Tutorials
[ENG]
Content in progress<br>
[RUS] * [ENG] Content in progress
[Перейти в раздел туториалов](Wiki/RUS_Tutorial/README.md)
# Copyrights & Contacts * [RUS] Перейти в раздел туториалов
pyOpenRPA is created by Ivan Maslov (Russia). Use it for free! <br>
*My purpose is to create [#IT4Business](https://www.facebook.com/RU.IT4Business) models.* <br> ## Donate
If you need IT help feel free to contact me.<br>
## My contacts: <br> pyOpenRPA is absolutely non-commercial project.
E-mail: Ivan.Maslov@UnicodeLabs.ru<br>
Skype: MegaFinder<br> Please donate some $ if pyOpenRPA project is actual for you. Link to online donations.
Facebook: https://www.facebook.com/RU.Ivan.Maslov<br> [https://money.yandex.ru/to/4100115560661986](https://money.yandex.ru/to/4100115560661986)
LinkedIn: https://www.linkedin.com/in/RU-IvanMaslov/
## Content
#License
Under the MIT license (absolutely free)
* 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

@ -3,10 +3,18 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
####################################
Welcome to pyOpenRPA's wiki 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 About
@ -23,48 +31,53 @@ At the time of this writing the pyOpenRPA is successfully using in several big R
************************************************** **************************************************
Structure Structure
************************************************** **************************************************
## The OpenRPA has 3 main tools:
The OpenRPA has 3 main tools:
############################################
- Studio - Studio
- Robot - Robot
- Orchestrator - Orchestrator
## Description
`Studio` Studio
___ ######################
Studio tool has been developed to help RPA-tors to create the robot algorythms.<br> Studio tool has been developed to help RPA-tors to create the robot algorythms.
___
**Features** **Features**
- Run actions - Run actions
- Create visual algorythms of the robot - Create visual algorythms of the robot
- Desktop app: Analyze desktop app ui tree - Desktop app: Analyze desktop app ui tree
- Desktop app: Search desktop app ui by mouse - Desktop app: Search desktop app ui by mouse
- Desktop app: Generate & edit the UIO Selector - 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. 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** **Features**
- Based on Python (killer feature) - Based on Python (killer feature)
- Support Win32 GUI framework (desktop app) - Support Win32 GUI framework (desktop app)
- Support UI automation framework (desktop app) - Support UI automation framework (desktop app)
- Support Selenium (web app) - Support Selenium (web app)
- Support PyAutoGUI (screen capture & mouse) - Support PyAutoGUI (screen capture & mouse)
- Support OpenCV (computer vision) - Support OpenCV (computer vision)
___
`Orchestrator` Orchestrator
___ ######################
The Orchestrator tool has been developed to maintain robot infrastructure (2+ robots algorythm). The Orchestrator tool has been developed to maintain robot infrastructure (2+ robots algorythm).
___
**Features** **Features**
- Start/Stop robot algorythm - Start/Stop robot algorythm
- Robot scheduler - Robot scheduler
- Remote machine screenshot viewer - Remote machine screenshot viewer
- Remote machine cmd shell - Remote machine cmd shell
- Remote machine logs storage - Remote machine logs storage
___
************************************************** **************************************************
Guide Guide (in progress)
************************************************** **************************************************
In wiki you can find: In wiki you can find:
in QUEUE in QUEUE
@ -76,19 +89,10 @@ Theory & practice: Screen capture & image recognition
************************************************** **************************************************
Tutorials Tutorials
************************************************** **************************************************
[ENG] - [ENG] Content in progress
Content in progress - [RUS] Перейти в раздел туториалов
[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
************************************************** **************************************************

@ -32,6 +32,7 @@ if errorlevel 9009 (
%SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% %SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
%SPHINXBUILD% -M markdown %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% %SPHINXBUILD% -M markdown %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
..\..\Wiki\ENG_Guide\html\index.html ..\..\Wiki\ENG_Guide\html\index.html
copy /y ..\..\Wiki\ENG_Guide\markdown\index.md ..\..\readme.md
goto end goto end
:help :help

@ -3,10 +3,9 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
####################################
Welcome to pyOpenRPA's wiki Welcome to pyOpenRPA's wiki
===================================== ####################################
************************************************** **************************************************
About About
@ -23,48 +22,53 @@ At the time of this writing the pyOpenRPA is successfully using in several big R
************************************************** **************************************************
Structure Structure
************************************************** **************************************************
## The OpenRPA has 3 main tools:
The OpenRPA has 3 main tools:
############################################
- Studio - Studio
- Robot - Robot
- Orchestrator - Orchestrator
## Description
`Studio` Studio
___ ######################
Studio tool has been developed to help RPA-tors to create the robot algorythms.<br> Studio tool has been developed to help RPA-tors to create the robot algorythms.
___
**Features** **Features**
- Run actions - Run actions
- Create visual algorythms of the robot - Create visual algorythms of the robot
- Desktop app: Analyze desktop app ui tree - Desktop app: Analyze desktop app ui tree
- Desktop app: Search desktop app ui by mouse - Desktop app: Search desktop app ui by mouse
- Desktop app: Generate & edit the UIO Selector - 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. 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** **Features**
- Based on Python (killer feature) - Based on Python (killer feature)
- Support Win32 GUI framework (desktop app) - Support Win32 GUI framework (desktop app)
- Support UI automation framework (desktop app) - Support UI automation framework (desktop app)
- Support Selenium (web app) - Support Selenium (web app)
- Support PyAutoGUI (screen capture & mouse) - Support PyAutoGUI (screen capture & mouse)
- Support OpenCV (computer vision) - Support OpenCV (computer vision)
___
`Orchestrator` Orchestrator
___ ######################
The Orchestrator tool has been developed to maintain robot infrastructure (2+ robots algorythm). The Orchestrator tool has been developed to maintain robot infrastructure (2+ robots algorythm).
___
**Features** **Features**
- Start/Stop robot algorythm - Start/Stop robot algorythm
- Robot scheduler - Robot scheduler
- Remote machine screenshot viewer - Remote machine screenshot viewer
- Remote machine cmd shell - Remote machine cmd shell
- Remote machine logs storage - Remote machine logs storage
___
************************************************** **************************************************
Guide Guide (in progress)
************************************************** **************************************************
In wiki you can find: In wiki you can find:
in QUEUE in QUEUE
@ -76,10 +80,8 @@ Theory & practice: Screen capture & image recognition
************************************************** **************************************************
Tutorials Tutorials
************************************************** **************************************************
[ENG] - [ENG] Content in progress
Content in progress - [RUS] Перейти в раздел туториалов
[RUS]
Перейти в раздел туториалов
************************************************** **************************************************
Donate Donate

@ -187,48 +187,54 @@ At the time of this writing the pyOpenRPA is successfully using in several big R
</div> </div>
<div class="section" id="structure"> <div class="section" id="structure">
<h2>Structure<a class="headerlink" href="#structure" title="Permalink to this headline"></a></h2> <h2>Structure<a class="headerlink" href="#structure" title="Permalink to this headline"></a></h2>
<p>## The OpenRPA has 3 main tools: <div class="section" id="the-openrpa-has-3-main-tools">
- Studio <h3>The OpenRPA has 3 main tools:<a class="headerlink" href="#the-openrpa-has-3-main-tools" title="Permalink to this headline"></a></h3>
- Robot <ul class="simple">
- Orchestrator <li><p>Studio</p></li>
## Description <li><p>Robot</p></li>
<cite>Studio</cite> <li><p>Orchestrator</p></li>
___ </ul>
Studio tool has been developed to help RPA-tors to create the robot algorythms.&lt;br&gt; </div>
___ <div class="section" id="studio">
<strong>Features</strong> <h3>Studio<a class="headerlink" href="#studio" title="Permalink to this headline"></a></h3>
- Run actions <p>Studio tool has been developed to help RPA-tors to create the robot algorythms.</p>
- Create visual algorythms of the robot <p><strong>Features</strong></p>
- Desktop app: Analyze desktop app ui tree <ul class="simple">
- Desktop app: Search desktop app ui by mouse <li><p>Run actions</p></li>
- Desktop app: Generate &amp; edit the UIO Selector <li><p>Create visual algorythms of the robot</p></li>
___ <li><p>Desktop app: Analyze desktop app ui tree</p></li>
<cite>Robot</cite> <li><p>Desktop app: Search desktop app ui by mouse</p></li>
___ <li><p>Desktop app: Generate &amp; edit the UIO Selector</p></li>
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. </ul>
___ </div>
<strong>Features</strong> <div class="section" id="robot">
- Based on Python (killer feature) <h3>Robot<a class="headerlink" href="#robot" title="Permalink to this headline"></a></h3>
- Support Win32 GUI framework (desktop app) <p>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.</p>
- Support UI automation framework (desktop app) <p><strong>Features</strong></p>
- Support Selenium (web app) <ul class="simple">
- Support PyAutoGUI (screen capture &amp; mouse) <li><p>Based on Python (killer feature)</p></li>
- Support OpenCV (computer vision) <li><p>Support Win32 GUI framework (desktop app)</p></li>
___ <li><p>Support UI automation framework (desktop app)</p></li>
<cite>Orchestrator</cite> <li><p>Support Selenium (web app)</p></li>
___ <li><p>Support PyAutoGUI (screen capture &amp; mouse)</p></li>
The Orchestrator tool has been developed to maintain robot infrastructure (2+ robots algorythm). <li><p>Support OpenCV (computer vision)</p></li>
___ </ul>
<strong>Features</strong>
- Start/Stop robot algorythm
- Robot scheduler
- Remote machine screenshot viewer
- Remote machine cmd shell
- Remote machine logs storage
___</p>
</div> </div>
<div class="section" id="guide"> <div class="section" id="orchestrator">
<h2>Guide<a class="headerlink" href="#guide" title="Permalink to this headline"></a></h2> <h3>Orchestrator<a class="headerlink" href="#orchestrator" title="Permalink to this headline"></a></h3>
<p>The Orchestrator tool has been developed to maintain robot infrastructure (2+ robots algorythm).</p>
<p><strong>Features</strong></p>
<ul class="simple">
<li><p>Start/Stop robot algorythm</p></li>
<li><p>Robot scheduler</p></li>
<li><p>Remote machine screenshot viewer</p></li>
<li><p>Remote machine cmd shell</p></li>
<li><p>Remote machine logs storage</p></li>
</ul>
</div>
</div>
<div class="section" id="guide-in-progress">
<h2>Guide (in progress)<a class="headerlink" href="#guide-in-progress" title="Permalink to this headline"></a></h2>
<p>In wiki you can find: <p>In wiki you can find:
in QUEUE in QUEUE
Theory &amp; practice: Web app access (Chrome, Firefox, Opera) Theory &amp; practice: Web app access (Chrome, Firefox, Opera)
@ -238,10 +244,10 @@ Theory &amp; practice: Screen capture &amp; image recognition</p>
</div> </div>
<div class="section" id="tutorials"> <div class="section" id="tutorials">
<h2>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this headline"></a></h2> <h2>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this headline"></a></h2>
<p>[ENG] <ul class="simple">
Content in progress <li><p>[ENG] Content in progress</p></li>
[RUS] <li><p>[RUS] Перейти в раздел туториалов</p></li>
Перейти в раздел туториалов</p> </ul>
</div> </div>
<div class="section" id="donate"> <div class="section" id="donate">
<h2>Donate<a class="headerlink" href="#donate" title="Permalink to this headline"></a></h2> <h2>Donate<a class="headerlink" href="#donate" title="Permalink to this headline"></a></h2>

File diff suppressed because one or more lines are too long

@ -17,47 +17,84 @@ At the time of this writing the pyOpenRPA is successfully using in several big R
## Structure ## Structure
## The OpenRPA has 3 main tools: ### The OpenRPA has 3 main tools:
- Studio
- Robot
- Orchestrator * Studio
## Description
Studio
___ * Robot
Studio tool has been developed to help RPA-tors to create the robot algorythms.<br>
___
* Orchestrator
### Studio
Studio tool has been developed to help RPA-tors to create the robot algorythms.
**Features** **Features**
- Run actions
- Create visual algorythms of the robot
- Desktop app: Analyze desktop app ui tree * Run actions
- Desktop app: Search desktop app ui by mouse
- Desktop app: Generate & edit the UIO Selector
___ * Create visual algorythms of the robot
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. 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** **Features**
- Based on Python (killer feature)
- Support Win32 GUI framework (desktop app)
- Support UI automation framework (desktop app) * Based on Python (killer feature)
- Support Selenium (web app)
- Support PyAutoGUI (screen capture & mouse)
- Support OpenCV (computer vision) * Support Win32 GUI framework (desktop app)
___
Orchestrator
___ * 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). The Orchestrator tool has been developed to maintain robot infrastructure (2+ robots algorythm).
___
**Features** **Features**
- Start/Stop robot algorythm
- Robot scheduler
- Remote machine screenshot viewer
- Remote machine cmd shell
- Remote machine logs storage
___
## Guide
* 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 wiki you can find:
in QUEUE in QUEUE
@ -68,10 +105,11 @@ Theory & practice: Screen capture & image recognition
## Tutorials ## Tutorials
[ENG]
Content in progress * [ENG] Content in progress
[RUS]
Перейти в раздел туториалов
* [RUS] Перейти в раздел туториалов
## Donate ## Donate

Loading…
Cancel
Save