Collection of open-source libraries and tools for Robotic Process Automation (RPA), designed to be used with both Robot Framework and Python
.. contents:: Table of Contents :local: :depth: 1
.. include-marker
RPA Frameworkis 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:
Robocorp Cloud_ and
Robocorp Lab_
.. _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/ .. _Robocorp Cloud: https://robocorp.com/docs/product-manuals/robocorp-cloud/robocorp-cloud .. _Robocorp Lab: https://robocorp.com/docs/product-manuals/robocorp-lab/robocorp-lab-overview
Links ^^^^^
.. 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: Latest version
.. image:: https://img.shields.io/pypi/l/rpaframework.svg :target: http://www.apache.org/licenses/LICENSE-2.0.html :alt: License
The RPA Framework project currently includes the following libraries:
+----------------------------+----------------------------------------------+ |
Archive_ | Archiving TAR and ZIP files | +----------------------------+----------------------------------------------+ |
Browser.Selenium_ | Control browsers and automate the web | +----------------------------+----------------------------------------------+ |
Browser.Playwright_ | Newer way to control browsers | +----------------------------+----------------------------------------------+ |
Cloud.AWS_ | Use Amazon AWS services | +----------------------------+----------------------------------------------+ |
Cloud.Azure_ | Use Microsoft Azure services | +----------------------------+----------------------------------------------+ |
Cloud.Google_ | Use Google Cloud services | +----------------------------+----------------------------------------------+ |
Crypto_ | Common hashing and encryption operations | +----------------------------+----------------------------------------------+ |
Database_ | Interact with databases | +----------------------------+----------------------------------------------+ |
Desktop_ | Cross-platform desktop automation | +----------------------------+----------------------------------------------+ |
Desktop.Clipboard_ | Interact with the system clipboard | +----------------------------+----------------------------------------------+ |
Desktop.OperatingSystem_ | Read OS information and manipulate processes | +----------------------------+----------------------------------------------+ |
Desktop.Windows_ | Automate Windows desktop applications | +----------------------------+----------------------------------------------+ |
Dialogs_ | Request user input during executions | +----------------------------+----------------------------------------------+ |
Email.Exchange_ | E-Mail operations (Exchange protocol) | +----------------------------+----------------------------------------------+ |
Email.ImapSmtp_ | E-Mail operations (IMAP & SMTP) | +----------------------------+----------------------------------------------+ |
Excel.Application_ | Control the Excel desktop application | +----------------------------+----------------------------------------------+ |
Excel.Files_ | Manipulate Excel files directly | +----------------------------+----------------------------------------------+ |
FileSystem_ | Read and manipulate files and paths | +----------------------------+----------------------------------------------+ |
FTP_ | Interact with FTP servers | +----------------------------+----------------------------------------------+ |
HTTP_ | Interact directly with web APIs | +----------------------------+----------------------------------------------+ |
Images_ | Manipulate images | +----------------------------+----------------------------------------------+ |
JSON_ | Manipulate JSON objects | +----------------------------+----------------------------------------------+ |
Notifier_ | Notify messages using different services | +----------------------------+----------------------------------------------+ |
Outlook.Application_ | Control the Outlook desktop application | +----------------------------+----------------------------------------------+ |
Robocloud.Items_ | Use the Robocloud Work Items API | +----------------------------+----------------------------------------------+ |
Robocloud.Secrets_ | Use the Robocloud Secrets API | +----------------------------+----------------------------------------------+ |
Salesforce_ | Salesforce operations | +----------------------------+----------------------------------------------+ |
SAP_ | Control SAP GUI desktop client | +----------------------------+----------------------------------------------+ |
Tables_ | Manipulate, sort, and filter tabular data | +----------------------------+----------------------------------------------+ |
Tasks_ | Control task execution | +----------------------------+----------------------------------------------+ |
Word.Application_ | Control the Word desktop 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/ .. _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/ .. _Robocloud.Items: https://rpaframework.org/libraries/roboclouditems/ .. Robocloud.Secrets: https://rpaframework.org/libraries/robocloudsecrets/ .. 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/
If you already have Python_ and
pip_ installed, you can use:
pip install rpaframework
To install all extra packages, you can use:
pip install rpaframework[aws,cv,google]
.. note:: Python 3.6 or higher is required
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 Seleniumlib = Selenium()
lib.open_available_browser("https://example.com") lib.input_text("id:user-name", username) lib.input_text("id:password", password)
rpaframework.org_ for library documentation
Robocorp Documentation_ for guides and tutorials
Robot Framework Slack_ if you have open questions or want to contribute
Robocorp Forum_ for discussions about RPA
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
Found a bug? Missing a critical feature? Interested in contributing? Head over to the
Contribution guide_ to see where to get started.
This project is open-source and licensed under the terms of the
Apache License 2.0_.