RPA Framework

.. contents:: Table of Contents :local: :depth: 1

.. include-docs-readme

Introduction

RPA Framework is a collection of open-source libraries and tools for Robotic Process Automation (RPA), and it is designed to be used with both Robot Framework_ and Python_. The goal is to offer well-documented and actively maintained core libraries for Software Robot Developers.

Learn more about RPA at Robocorp Documentation_.

The project is:

• 100% Open Source
• Sponsored by Robocorp_
• Optimized for Robocorp Control Room_ and Developer Tools_
• Accepting external contributions

.. _Robot Framework: https://robotframework.org .. _Robot Framework Foundation: https://robotframework.org/foundation/ .. _Python: https://www.python.org/ .. _Robocorp: https://robocorp.com .. _Robocorp Documentation: https://robocorp.com/docs-robot-framework .. _Control Room: https://robocorp.com/docs/control-room .. _Developer Tools: https://robocorp.com/downloads .. _Installing Python Packages: https://robocorp.com/docs/setup/installing-python-package-dependencies

Links ^^^^^

• Homepage: <https://www.github.com/robocorp/rpaframework/>_
• Documentation: <https://rpaframework.org/>_
• PyPI: <https://pypi.org/project/rpaframework/>_
• Release notes: <https://rpaframework.org/releasenotes.html>_
• RSS feed: <https://rpaframework.org/releases.xml>_

---

.. image:: https://img.shields.io/github/actions/workflow/status/robocorp/rpaframework/main.yaml?style=for-the-badge :target: https://github.com/robocorp/rpaframework/actions/workflows/main.yaml :alt: Status

.. image:: https://img.shields.io/pypi/dw/rpaframework?style=for-the-badge :target: https://pypi.python.org/pypi/rpaframework :alt: rpaframework

.. image:: https://img.shields.io/pypi/l/rpaframework.svg?style=for-the-badge&color=brightgreen :target: http://www.apache.org/licenses/LICENSE-2.0.html :alt: License

---

Packages

.. image:: https://img.shields.io/pypi/v/rpaframework.svg?label=rpaframework&style=for-the-badge :target: https://pypi.python.org/pypi/rpaframework :alt: rpaframework latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-assistant.svg?label=rpaframework-assistant&style=for-the-badge :target: https://pypi.python.org/pypi/rpaframework-assistant :alt: rpaframework-assistant latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-aws.svg?label=rpaframework-aws&style=for-the-badge :target: https://pypi.python.org/pypi/rpaframework-aws :alt: rpaframework-aws latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-core.svg?label=rpaframework-core&style=for-the-badge :target: https://pypi.python.org/pypi/rpaframework-core :alt: rpaframework-core latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-google.svg?label=rpaframework-google&style=for-the-badge&color=blue :target: https://pypi.python.org/pypi/rpaframework-google :alt: rpaframework-google latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-hubspot.svg?label=rpaframework-hubspot&style=for-the-badge&color=blue :target: https://pypi.python.org/pypi/rpaframework-hubspot :alt: rpaframework-hubspot latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-openai.svg?label=rpaframework-openai&style=for-the-badge&color=blue :target: https://pypi.python.org/pypi/rpaframework-openai :alt: rpaframework-openai latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-pdf.svg?label=rpaframework-pdf&style=for-the-badge&color=blue :target: https://pypi.python.org/pypi/rpaframework-pdf :alt: rpaframework-pdf latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-recognition.svg?label=rpaframework-recognition&style=for-the-badge&color=blue :target: https://pypi.python.org/pypi/rpaframework-recognition :alt: rpaframework-recognition latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-windows.svg?label=rpaframework-windows&style=for-the-badge&color=blue :target: https://pypi.python.org/pypi/rpaframework-windows :alt: rpaframework-windows latest version

---

From the above packages, rpaframework-core and rpaframework-recognition are support packages, which alone do not contain any libraries.

Libraries

The RPA Framework project currently includes the following libraries:

The x in the PACKAGE column means that library is included in the rpaframework package and for example. x,pdf means that RPA.PDF library is provided in both the rpaframework and rpaframework-pdf packages.

+----------------------------+-------------------------------------------------------+------------------------+ | LIBRARY NAME | DESCRIPTION | PACKAGE | +----------------------------+-------------------------------------------------------+------------------------+ | Archive_ | Archiving TAR and ZIP files | x | +----------------------------+-------------------------------------------------------+------------------------+ | Assistant_ | Display information to a user and request input. | assistant | +----------------------------+-------------------------------------------------------+------------------------+ | Browser.Selenium_ | Control browsers and automate the web | x | +----------------------------+-------------------------------------------------------+------------------------+ | Browser.Playwright_ | Newer way to control browsers | special (more below) | +----------------------------+-------------------------------------------------------+------------------------+ | Calendar_ | For date and time manipulations | x | +----------------------------+-------------------------------------------------------+------------------------+ | Cloud.AWS_ | Use Amazon AWS services | x,aws | +----------------------------+-------------------------------------------------------+------------------------+ | Cloud.Azure_ | Use Microsoft Azure services | x | +----------------------------+-------------------------------------------------------+------------------------+ | Cloud.Google_ | Use Google Cloud services | google | +----------------------------+-------------------------------------------------------+------------------------+ | Crypto_ | Common hashing and encryption operations | x | +----------------------------+-------------------------------------------------------+------------------------+ | Database_ | Interact with databases | x | +----------------------------+-------------------------------------------------------+------------------------+ | Desktop_ | Cross-platform desktop automation | x | +----------------------------+-------------------------------------------------------+------------------------+ | Desktop.Clipboard_ | Interact with the system clipboard | x | +----------------------------+-------------------------------------------------------+------------------------+ | Desktop.OperatingSystem_ | Read OS information and manipulate processes | x | +----------------------------+-------------------------------------------------------+------------------------+ | DocumentAI_ | Intelligent Document Processing wrapper | x | +----------------------------+-------------------------------------------------------+------------------------+ | DocumentAI.Base64AI_ | Intelligent Document Processing service | x | +----------------------------+-------------------------------------------------------+------------------------+ | DocumentAI.Nanonets_ | Intelligent Document Processing service | x | +----------------------------+-------------------------------------------------------+------------------------+ | Email.Exchange_ | E-Mail operations (Exchange protocol) | x | +----------------------------+-------------------------------------------------------+------------------------+ | Email.ImapSmtp_ | E-Mail operations (IMAP & SMTP) | x | +----------------------------+-------------------------------------------------------+------------------------+ | Excel.Application_ | Control the Excel desktop application | x | +----------------------------+-------------------------------------------------------+------------------------+ | Excel.Files_ | Manipulate Excel files directly | x | +----------------------------+-------------------------------------------------------+------------------------+ | FileSystem_ | Read and manipulate files and paths | x | +----------------------------+-------------------------------------------------------+------------------------+ | FTP_ | Interact with FTP servers | x | +----------------------------+-------------------------------------------------------+------------------------+ | HTTP_ | In