RPA Framework
Table of Contents
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 Robohub.
The project is:
- 100% Open Source
- Sponsored by Robocorp
- Optimized for Robocloud and Robocode
- Accepting external contributions
Links
- Homepage: https://www.github.com/robocorp/rpa-framework/
- Documentation: https://rpaframework.org/
- PyPI: https://pypi.org/project/rpa-framework/
Note
RPA Framework is in Early Access phase and expected 1.0 release will happen during summer 2020.
Libraries
The RPA Framework project currently includes the following libraries:
Browser | Control browsers and automate the web |
Database | Interact with databases |
Desktop.Clipboard | Interact with the system clipboard |
Desktop.OperatingSystem | Read OS information and manipulate processes |
Desktop.Windows | Automate Windows desktop applications |
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 |
HTTP | Interact directly with web APIs |
Images | Manipulate images |
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 |
Slack | Send notifications to Slack channels |
SAP | Control SAP GUI desktop client |
Tables | Manipulate, sort, and filter tabular data |
Word.Application | Control the Word desktop application |
Installation
If you already have Python and pip installed, you can use:
pip install rpa-framework
Note
Python 3.6 or higher is required
Example
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)
Support and contact
- rpaframework.org for library documentation
- Robohub for guides and tutorials
- #rpa-framework channel in Robot Framework Slack if you have open questions or want to contribute
Contributing
Found a bug? Missing a critical feature? Interested in contributing? Head over to the Contribution guide to see where to get started.
License
This project is open-source and licensed under the terms of the Apache License 2.0.