ORPA-pyOpenRPA/Wiki/ENG_Guide/markdown/index.md

<!-- 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 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

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

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](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