Table of Contents
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 Cloud and Robocorp Lab
- Accepting external contributions
- Homepage: https://www.github.com/robocorp/rpaframework/
- Documentation: https://rpaframework.org/
- PyPI: https://pypi.org/project/rpaframework/
The RPA Framework project currently includes the following libraries:
| Archive | Archiving TAR and ZIP files |
| Browser | Control browsers and automate the web |
| Cloud.AWS | Use Amazon AWS services |
| Cloud.Azure | Use Microsoft Azure services |
| Cloud.Google | Use Google Cloud services |
| 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 | For requesting user input in a HTML form |
| 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 server |
| 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 |
| Read and create PDF documents | |
| 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 |
| Twitter API interface | |
| Word.Application | Control the Word desktop application |
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:
*** Settings ***
Library RPA.Browser
*** Tasks ***
Login as user
Open browser https://example.com
Input text id:user-name ${USERNAME}
Input text id:password ${PASSWORD}The libraries are also available inside Python:
from RPA.Browser import Browser
lib = Browser()
lib.open_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
- #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
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.