ORPA-pyOpenRPA/Sources/GuideSphinx/index.rst

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

.. image:: /img/ModalGuide.png
   :alt: ModalGuide.png

*by Ivan Maslov (Russia)* - see :ref:`3.-Copyrights-&-Contacts`.

! ATTENTION ! pyOpenRPA works only on MS Windows 7+/Server 2008+. Guys from Unix/Mac - sorry. We will come to you soon :)


**************************************************
About
**************************************************
Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here!

pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA)

The pyOpenRPA - free, fast and reliable
Powerful OpenSource RPA tool for business (based on python 3). Best performance 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 PYOPENRPA license.
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.

**************************************************
Repo structure
**************************************************

The description of the each folder in GitLab repo is going below:

- **Agent**: template build for the pyOpenRPA.Agent component
- **Orchestrator**: template build for the pyOpenRPA.Orchestrator component
- **Resources**: 3rd party resources which is needed to provide pyOpenRPA encapsulation from the Operating System (OS) dependencies.
- **Robot**: template build for the robot
- **Sources**: pyOpenRPA python package sources + sphinx sources
- **Studio**: build for the pyOpenRPA.Studio which support Desktop UI (support x32 and x64 desktop UI apps)
- **Utils**: many additional good tools for the python developer
- **Wiki**: compiled wiki documentation

**************************************************
The pyOpenRPA structure
**************************************************

The pyOpenRPA has 4 main tools:
############################################
- Studio
- Robot
- Orchestrator
- Agent

Studio
######################
The pyOpenRPA.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 pyOpenRPA.Robot package is the core of any action execution in the pyOpenRPA. 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 pyOpenRPA.Orchestrator package has been developed to maintain robot infrastructure (2+ robots algorythm).

**Features**

- Start/Stop robot algorithm
- Robot scheduler
- Remote machine screenshot viewer
- Remote machine cmd shell
- Remote machine logs storage

Agent
######################

The pyOpenRPA.Agent tool has been developed to maintain robot infrastructure (2+ robots algorythm).

**Features**

- Send CMD to the RPA GUI session (start/safe stop/force stop/logout)
- Get screenshots from the RPA GUI session
- Get the list of the running processes

**************************************************
Wiki structure
**************************************************
In wiki you can use the following docs:

- ENG Guide HTML `[|OPEN GITLAB|] <https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/html/index.html>`_
- ENG Guide MarkDown `[|OPEN GITLAB|] <https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/markdown/index.md>`_
- ENG Guide PDF `[|OPEN GITLAB|] <https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf>`_

- RUS Article: Less cost - no paid RPA `[|OPEN HABR|] <https://habr.com/ru/post/506766/>`_
- RUS Tutorial Desktop UI `[|OPEN HABR|] <https://habr.com/ru/post/509644/>`_; `[|OPEN GITLAB|] <https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Tutorial/DesktopGUI_Habr/index.md>`_
- RUS Tutorial Web UI `[|OPEN HABR|] <https://habr.com/ru/post/515310/>`_; `[|OPEN GITLAB|] <https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Tutorial/WebGUI_Habr/readme.md>`_
- RUS Leaflet pyOpenRPA v4.pdf `[|OPEN GITLAB|] <https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v4.pdf>`_

**************************************************
Guide 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/*

.. toctree::
   :maxdepth: 3
   :caption: AGENT
   :glob:

   Agent/*
   
.. toctree::
   :maxdepth: 2
   :caption: TOOLS
   :glob:

   Tools/*