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.

####################################
Портал документации pyOpenRPA
####################################

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

**************************************************
Дорогие коллеги!
**************************************************
Добро пожаловать на портал документации pyOpenRPA. 

pyOpenRPA - это самое прогрессивное и технологичное RPA решение на рынке роботизации (открытый код). Наших роботов невозможно отключить принудительно - управлять ими будете только вы!
Вместе с pyOpenRPA стало возможно сочетать в рамках одного проекта все перспективные технологии, такие как: 

* распознавание, 
* искусственный интеллект, 
* машинное обучение, 
* большие данные, 
* голосовые и чат-боты, 
* речевая аналитика, 
* компьютерное зрение.

В компании pyOpenRPA LLC мы создаем стандарты вендора нового поколения. Предлагаем не просто платформу роботизации RPA, а уникальный набор услуг для каждого клиента в зависимости от решаемой задачи.
Мы знаем, что реальная ценность роботизации RPA для вас заключается не в каком-то софте. Софт - это лишь 1 из 3 компонентов. Остальные 2 компонента - это люди и вычислительные мощности (железо). Вам нужно комплексное и системное решение проблемы, и мы вам в этом поможем!

Наша открытость и ряд стратегических инициатив позволяют с легкостью привлекать сотни новых специалистов и клиентов. Быть предельно прозрачными перед всеми участниками рынка. Предлагать индивидуальный набор услуг, нацеленный именно на решение проблем клиента.

С презентацией pyOpenRPA вы можете ознакомиться по ссылке: `[СМОТРЕТЬ PDF] <https://pyopenrpa.ru/Index/pyOpenRPA_product_service.pdf>`_ . Если возникнут вопросы, то вы всегда можете обратиться к нам (контакты см. в презентации).

pyOpenRPA - роботы вам помогут!

**Иван Маслов, основатель и генеральный директор pyOpenRPA LLC**


**************************************************
О портале
**************************************************

Портал состоит из следующих разделов:
############################################
- ОБЩЕЕ
- МОДУЛЬ РОБОТ
- МОДУЛЬ СТУДИЯ
- МОДУЛЬ ОРКЕСТРАТОР
- МОДУЛЬ АГЕНТ
- ИНСТРУМЕНТЫ


ОБЩЕЕ
######################
В разделе описание общие положения, такие как: Описание структуры портала, инструкция по развертыванию и запуску pyOpenRPA, информация о правообладателе, контакты.

МОДУЛЬ РОБОТ
######################
Модуль обеспечивает всю необходимую функциональность для создания любого программного робота RPA. Модуль робота поставляется в качестве библиотеки Python, что позволяет с легкостью интегрировать его в другие проекты перспективных технологий.

**Содержит**

- уровень доступа к элементам локального (win32, UI automation) и веб приложения
- уровень доступа к текстовым каналам передачи данных (клавиатура, буфер обмена)
- уровень доступа к графическим каналам передачи данных (мышь, экран)

Подробное описание модуля: :ref:`module.robot.description`.

МОДУЛЬ СТУДИИ
######################
Модуль является инструментом для отладки проектируемых узлов программного робота RPA. Запускается в качестве обособленного приложения в веб-браузере.

**Основные возможности**

- Поиск и запуск доступных действий над UI элементом
- Чтение и запись атрибутов UI элемента
- Визуальное прототипирование алгоритма
- Редактирование UI селекторов
- Поиск UI элементов по наведению мыши
- Поиск UI элементов в дереве UI объектов
- Автоматизированная генерация UI селекторов

Подробное описание модуля: :ref:`module.studio.description`.

МОДУЛЬ ОРКЕСТРАТОР
######################

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

**************************************************
Технические требования
**************************************************

ВЕРСИЯ |release|

*by Ivan Maslov (Russia)* - see 

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


**************************************************
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>`_

:ref:`3.-Copyrights-&-Contacts`.

**************************************************
Guide content
**************************************************

.. toctree::
   :maxdepth: 2
   :caption: ОБЩЕЕ
   :glob:

   Выбрать версию <https://pyopenrpa.ru/wiki/guide/index>
   *

.. toctree::
   :maxdepth: 2
   :caption: МОДУЛЬ РОБОТ
   :glob:

   Robot/*

.. toctree::
   :maxdepth: 2
   :caption: МОДУЛЬ СТУДИЯ
   :glob:

   Studio/*

.. toctree::
   :maxdepth: 3
   :caption: МОДУЛЬ ОРКЕСТРАТОР
   :glob:

   Orchestrator/*

.. toctree::
   :maxdepth: 3
   :caption: МОДУЛЬ АГЕНТ
   :glob:

   Agent/*
   
.. toctree::
   :maxdepth: 2
   :caption: ИНСТРУМЕНТЫ
   :glob:

   Tools/*