RPA Framework

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

.. include-marker

Introduction

RPA Framework

Robot Framework

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://python.org .. _Robocorp: https://robocorp.com .. _Robocorp Documentation: https://robocorp.com/docs/ .. _Control Room: https://robocorp.com/docs/control-room .. _Developer Tools: https://robocorp.com/docs/developer-tools

Links ^^^^^

• Homepage:
  _
• Documentation:
  _
• PyPI:
  _
• Release notes:
  _
• RSS feed:
  _

.. image:: https://github.com/robocorp/rpaframework/workflows/main/badge.svg :target: https://github.com/robocorp/rpaframework/actions?query=workflow%3Amain :alt: Status

.. image:: https://img.shields.io/pypi/v/rpaframework.svg?label=version :target: https://pypi.python.org/pypi/rpaframework :alt: rpaframework latest version

.. image:: https://img.shields.io/pypi/l/rpaframework.svg :target: http://www.apache.org/licenses/LICENSE-2.0.html :alt: License

.. image:: https://img.shields.io/pypi/v/rpaframework-dialogs.svg?label=rpaframework-dialogs :target: https://pypi.python.org/pypi/rpaframework-dialogs :alt: rpaframework-dialogs latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-google.svg?label=rpaframework-google :target: https://pypi.python.org/pypi/rpaframework-google :alt: rpaframework-google latest version

.. image:: https://img.shields.io/pypi/v/rpaframework-pdf.svg?label=rpaframework-pdf :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 :target: https://pypi.python.org/pypi/rpaframework-recognition :alt: rpaframework-recognition latest version

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

Libraries

The RPA Framework project currently includes the following libraries:

+----------------------------+----------------------------------------------+ |

Archive

Browser.Selenium

Browser.Playwright

Cloud.AWS

Cloud.Azure

Cloud.Google

Crypto

Database

Desktop

Desktop.Clipboard

Desktop.OperatingSystem

Desktop.Windows

Dialogs

Email.Exchange

Email.ImapSmtp

Excel.Application

Excel.Files

FileSystem

FTP

HTTP

Images

JavaAccessBridge

JSON

Notifier

Outlook.Application

PDF

Robocorp.Process

Robocorp.WorkItems

Robocorp.Vault

Salesforce

SAP

Tables

Tasks

Twitter

Word.Application

.. Archive: https://rpaframework.org/libraries/archive/ .. _Browser.Playwright: https://rpaframework.org/libraries/browserplaywright/ .. Browser.Selenium: https://rpaframework.org/libraries/browserselenium/ .. Cloud.AWS: https://rpaframework.org/libraries/cloudaws/ .. Cloud.Azure: https://rpaframework.org/libraries/cloudazure/ .. Cloud.Google: https://rpaframework.org/libraries/cloudgoogle/ .. Crypto: https://rpaframework.org/libraries/crypto/ .. _Database: https://rpaframework.org/libraries/database/ .. _Desktop: https://rpaframework.org/libraries/desktop/ .. _Desktop.Clipboard: https://rpaframework.org/libraries/desktopclipboard/ .. Desktop.Operatingsystem: https://rpaframework.org/libraries/desktopoperatingsystem/ .. Desktop.Windows: https://rpaframework.org/libraries/desktopwindows/ .. Dialogs: https://rpaframework.org/libraries/dialogs/ .. _Email.Exchange: https://rpaframework.org/libraries/emailexchange/ .. Email.ImapSmtp: https://rpaframework.org/libraries/emailimapsmtp/ .. Excel.Application: https://rpaframework.org/libraries/excelapplication/ .. Excel.Files: https://rpaframework.org/libraries/excelfiles/ .. FileSystem: https://rpaframework.org/libraries/filesystem/ .. _FTP: https://rpaframework.org/libraries/ftp/ .. _HTTP: https://rpaframework.org/libraries/http/ .. _Images: https://rpaframework.org/libraries/images/ .. _JavaAccessBridge: https://rpaframework.org/libraries/javaaccessbridge/ .. _JSON: https://rpaframework.org/libraries/json/ .. _Notifier: https://rpaframework.org/libraries/notifier/ .. _Outlook.Application: https://rpaframework.org/libraries/outlookapplication/ .. PDF: https://rpaframework.org/libraries/pdf/ .. _Robocorp.Process: https://rpaframework.org/libraries/robocorpprocess/ .. Robocorp.WorkItems: https://rpaframework.org/libraries/robocorpworkitems/ .. Robocorp.Vault: https://rpaframework.org/libraries/robocorpvault/ .. Salesforce: https://rpaframework.org/libraries/salesforce/ .. _SAP: https://rpaframework.org/libraries/sap/ .. _Tables: https://rpaframework.org/libraries/tables/ .. _Tasks: https://rpaframework.org/libraries/tasks/ .. _Twitter: https://rpaframework.org/libraries/twitter/ .. _Word.Application: https://rpaframework.org/libraries/wordapplication/

Installation

If you already have Python_ and

pip 

.. code-block:: console

pip install rpaframework

To install all extra packages, you can use:

.. code-block:: console

pip install rpaframework[aws,cv]

Other packages that can be installed separately are:

.. code-block:: console

pip install rpaframework-dialogs  # included in the rpaframework by default
pip install rpaframework-google
pip install rpaframework-pdf  # included in the rpaframework by default
pip install rpaframework-recognition

.. note:: Python 3.6 or higher is required

Example

After installation the libraries can be directly imported inside

Robot Framework

.. code:: robotframework

*** Settings ***
Library    RPA.Browser.Selenium

* Tasks *
Login as user
    Open available browser    https://example.com
    Input text    id:user-name    ${USERNAME}
    Input text    id:password     ${PASSWORD}

The libraries are also available inside Python_:

.. code:: python

from RPA.Browser.Selenium import Selenium

lib = Selenium()
lib.open_available_browser("https://example.com")
lib.input_text("id:user-name", username)
lib.input_text("id:password", password)

Support and contact

• rpaframework.org 

  _ for library documentation

• Robocorp Documentation

  _ for guides and tutorials
• #rpaframework channel in

  Robot Framework Slack

  _ if you have open questions or want to contribute

• Robocorp Forum

  _ for discussions about RPA
• Communicate with your fellow Software Robot Developers and Robocorp experts at

  Robocorp Developers Slack

  _

.. _Robot Framework Slack: https://robotframework-slack-invite.herokuapp.com/ .. _Robocorp Forum: https://forum.robocorp.com .. _Robocorp Developers Slack: https://robocorp-developers.slack.com

Contributing

Found a bug? Missing a critical feature? Interested in contributing? Head over to the

Contribution guide 

License

This project is open-source and licensed under the terms of the

Apache License 2.0