Automagica is a Smart Robotic Process Automation (SRPA) platform for fully automating tedious, manual tasks with software.
This repository is for the open source Python library, where all the Automagica building blocks are. With Automagica, automating cross-platform processes becomes a breeze. With this open source library we want to provide a comprehensive and consistent wrapper around known and lesser known automation libraries.
Refer to the Automagica official website for more information. Registered users can access the Automagica Portal. For more info see the documentation.
- We just launched the latest version of our Automagica Portal
- Follow our blog to stay up to date
- We're on Discord now as well!
- We opened a group on Telegram for the community
- You can now also run automations developed with UiPath, Blue Prism, Automation Anywhere, AutoIt and Robot Framework with Automagica Portal!
We can support you end-to-end in all your automation needs, from estimating automation potential for processes to technical implementation and integration. Please send an e-mail to sales@automagica.com for enquiries and rates.
The easiest way to install Automagica is by using the installer for Windows which can be downloaded from the Automagica Portal.
You can install Automagica by running the following commands:
sudo yum install python3-devel chromium -y
sudo pip3 install automagica -U
You can install Automagica by running the following commands:
sudo apt-get install python3-devel chromium -y
sudo pip3 install automagica -U
If you would like to run browser automations, you also need to install Chromium or Chrome.
If you wish to only install the Automagica Python library (without registering for the Automagica Portal), follow the below steps.
-
Download and install Python 3.7
-
Install the latest version Automagica on your machine:
pip install automagica --upgrade
Before getting started in development mode, don't forget to import the activities from automagica in your python script. If unsure, it is possible to import all the activities for development purposes by starting your script with:
from automagica import *
Try out the one-click examples:
- Webscraping in Chrome
- Read and write data in Excel
- Automatically make a PowerPoint presentation
- Change your Windows wallpaper
- Manipulate files and folders
- Use OCR to read images and click buttons
Browser working with Excel:
SAP Automation (Production example, sensitive information is blurred):
Folder and File manipulation
This is still under heavy development, but we're exploring possibilities of running Automagica robots in a containerized desktop. You can try this with docker with the following commands:
git clone https://github.com/oakwoodai/automagica
cd automagica
docker build . -t automagica
docker run -it -p 8080:8080 automagica
Then browse to http://localhost:8080/vnc.html
An overview of all official Automagica activities:
Process | Description |
---|---|
Cryptography | ββ |
Generate random Fernet key. Fernet guarantees that a message encrypted using it cannot be manipulated or read without the key. Fernet is an implementation of symmetric (also known as βsecret keyβ) authenticated cryptography | |
Encrypt text with (Fernet) key, | |
Dexrypt bytes-like object to string with (Fernet) key | |
Encrypt file with (Fernet) key. Note that file will be unusable unless unlocked with the same key. | |
Decrypts file with (Fernet) key | |
Generate key based on password and salt. If both password and salt are known the key can be regenerated. | |
Generate hash from file | |
Generate hash from text | |
Random | ββ |
Random numbers can be integers (not a fractional number) or a float (fractional number). | |
Generates a random boolean (True or False) | |
Generates a random name. Adding a locale adds a more common name in the specified locale. Provides first name and last name. | |
Generates a random address. Specifying locale changes random locations and streetnames based on locale. | |
Generates a random beep, only works on Windows | |
Generates a random date. | |
Generates a random UUID4 (universally unique identifier). While the probability that a UUID will be duplicated is not zero, it is close enough to zero to be negligible. | |
User Input | ββ |
Prompt the user for an input with a pop-up window. | |
Prompt the user for a password. The password will be masked on screen while entering. | |
Prompt a popup which asks user for username and password and returns in plain text. Password will be masked. | |
A pop-up message with title and message. | |
Display custom OSD (on-screen display) message. Can be used to display a message for a limited amount of time. Can be used for illustration, debugging or as OSD. | |
Browser | ββ |
Open the Chrome Browser with the Selenium webdriver. Canb be used to automate manipulations in the browser.Different elements can be found as: | |
Save all images on current page in the Browser | |
Find all elements by their text. Text does not need to match exactly, part of text is enough. | |
Find one element by text. Text does not need to match exactly, part of text is enough. | |
Find all links on a webpage in the browser | |
Highlight elements in yellow in the browser | |
Quit the browser by exiting gracefully. One can also use the native 'quit' function, e.g. 'browser.quit()' | |
Find all elements with specified xpath on a webpage in the the browser. Can also use native 'find_elements_by_xpath' function e.g. browser.find_elements_by_xpath()You can easily | |
Find all element with specified xpath on a webpage in the the browser. Can also use native 'find_elements_by_xpath' function e.g. browser.find_element_by_xpath() | |
Credential Management | ββ |
Add a credential which stores credentials locally and securely. All parameters should be Unicode text. | |
Delete a locally stored credential. All parameters should be Unicode text. | |
Get a locally stored redential. All parameters should be Unicode text. | |
FTP | ββ |
Can be used to automate activites for FTP | |
Downloads a file from FTP server. Connection needs to be established first. | |
Upload file to FTP server | |
Generate a list of all the files in the FTP directory | |
Check if FTP directory exists | |
Create a FTP directory. Note that sufficient permissions are present | |
Keyboard | ββ |
Press and release an entered key. Make sure your keyboard is on US layout (standard QWERTY).If you are using this on Mac Os you might need to grant acces to your terminal application. (Security Preferences > Security & Privacy > Privacy > Accessibility) | |
Press a combination of two or three keys simultaneously. Make sure your keyboard is on US layout (standard QWERTY). | |
Types text in the current active field by simulating keyboard typing. Make sure your keyboard is on US layout (standard QWERTY). | |
Mouse | ββ |
Get the x and y pixel coordinates of current mouse position.These coordinates represent the absolute pixel position of the mouse on the computer screen. The x-coΓΆrdinate starts on the left side and increases going right. The y-coΓΆrdinate increases going down. | |
Displays mouse position in an overlay. Refreshes every two seconds. Can be used to find mouse position of element on the screen.These coordinates represent the absolute pixel position of the mouse on the computer screen. The x-coΓΆrdinate starts on the left side and increases going right. The y-coΓΆrdinate increases going down. | |
Clicks on a pixel position on the visible screen determined by x and y coordinates. | |
Double clicks on a pixel position on the visible screen determined by x and y coordinates. | |
Right clicks on a pixel position on the visible screen determined by x and y coordinates. | |
Moves te pointer to a x-y position. | |
Moves the mouse an x- and y- distance relative to its current pixel position. | |
Drag the mouse from its current position to a entered x-y position, while holding a specified button. | |
Image | ββ |
Take a random square snippet from the current screen. Mainly for testing and/or development purposes. | |
Take a screenshot of current screen. | |
This function searches the screen for a match with template image and clicks directly in the middle. Note that this only finds exact matches.For a more advanced and robust vision detection method see Automagica AI functionality. | |
Double click on similar image on the screen. This function searches the screen for a match with template image and doubleclicks directly in the middle.Note that this only finds exact matches. For a more advanced and robust vision detection method see Automagica AI functionality. | |
Right click on similar image on the screen. This function searches the screen for a match with template image and right clicks directly in the middle.Note that this only finds exact matches. For a more advanced and robust vision detection method see Automagica AI functionality. | |
Find exact image on the screen. This function searches the screen for a match with template image and clicks directly in the middle.Note that this only finds exact matches. For a more advanced and robust vision detection method see Automagica AI functionality. | |
Folder Operations | ββ |
List all files in a folder (and subfolders)Checks all folders and subfolders for files. This could take some time for large repositories. | |
Creates new folder at the given path. | |
Rename a folder | |
Open a folder with the default explorer. | |
Moves a folder from one place to another.If the new location already contains a folder with the same name, a random 4 character uid is added to the name. | |
Remove a folder including all subfolders and files. For the function to work optimal, all files and subfolders in the main targetfolder should be closed. | |
Remove all contents from a folderFor the function to work optimal, all files and subfolders in the main targetfolder should be closed. | |
Check whether folder exists or not, regardless if folder is empty or not. | |
Copies a folder from one place to another.If the new location already contains a folder with the same name, a random 4 character id is added to the name. | |
Zia folder and it's contents. Creates a .zip file. | |
Unzips a file or folder from a .zip file. | |
Delay | ββ |
Make the robot wait for a specified number of seconds. Note that this activity is blocking. This means that subsequent activities will not occur until the the specified waiting time has expired. | |
Waits for an image to appear on the screenNote that this activity waits for an exact match of the template image to appear on the screen.Small variations, such as color or resolution could result in a mismatch. | |
Waits until a folder exists.Not that this activity is blocking and will keep the system waiting. | |
Word Application | ββ |
For this activity to work, Microsoft Office Word needs to be installed on the system. | |
Append text at end of Word document. | |
Can be used for example to replace arbitrary placeholder value. For example whenusing template document, using 'XXXX' as a placeholder. Take note that all strings are case sensitive. | |
Read all the text from a document | |
Export the document to PDF | |
Export to HTML | |
Set the footers of the document | |
Set the headers of the document | |
Word File | ββ |
These activities can read, write and edit Word (docx) files without the need of having Word installed.Note that, in contrary to working with the :func: 'Word' activities, a file get saved directly after manipulation. | |
Read all the text from the document | |
Append text at the end of the document | |
Save document | |
Save file on specified path | |
Set headers of Word document | |
Replaces all occurences of a placeholder text in the document with a replacement text. | |
Outlook Application | ββ |
For this activity to work, Outlook needs to be installed on the system. | |
Send an e-mail using Outlook | |
Retrieve list of folders from Outlook | |
Retrieve list of messages from Outlook | |
Deletes e-mail messages in a certain folder. Can be specified by searching on subject, body or sender e-mail. | |
Move e-mail messages in a certain folder. Can be specified by searching on subject, body or sender e-mail. | |
Save all attachments from certain folder | |
Retrieve all contacts | |
Add a contact to Outlook contacts | |
Close the Outlook application | |
Excel Application | ββ |
For this activity to work, Microsoft Office Excel needs to be installed on the system. | |
Adds a worksheet to the current workbook | |
Activate a worksheet in the current Excel document by name | |
Save the current workbook | |
Save the current workbook to a specific path | |
Write to a specific cell in the currently active workbook and active worksheet | |
Read a cell from the currently active workbook and active worksheet | |
Write to a specific range in the currently active worksheet in the active workbook | |
Read a range of cells from the currently active worksheet in the active workbook | |
Run a macro by name from the currently active workbook | |
Get names of all the worksheets in the currently active workbook | |
Get table data from the currently active worksheet by name of the table | |
Activate a particular range in the currently active workbook | |
Activates the first empty cell going down | |
Activates the first empty cell going right | |
Activates the first empty cell going left | |
Activates the first empty cell going up | |
Write a formula to a particular cell | |
Read the formula from a particular cell | |
Inserts an empty row to the currently active worksheet | |
Inserts an empty column in the currently active worksheet. Existing columns will shift to the right. | |
Deletes a row from the currently active worksheet. Existing data will shift up. | |
Delet a column from the currently active worksheet. Existing columns will shift to the left. | |
Export to PDF | |
Insert list of dictionaries as a table in Excel | |
Read data from a worksheet as a list of lists | |
This closes Excel, make sure to use :func: 'save' or 'save_as' if you would like to save before quitting. | |
Excel File | ββ |
This activity can read, write and edit Excel (xlsx) files without the need of having Excel installed.Note that, in contrary to working with the :func: 'Excel' activities, a file get saved directly after manipulation. | |
Export to pandas dataframe | |
Activate a worksheet. By default the first worksheet is activated. | |
Save file as | |
Write a cell based on column and row | |
Read a cell based on column and row | |
Add a worksheet | |
Get worksheet names | |
PowerPoint Application | ββ |
For this activity to work, PowerPoint needs to be installed on the system. | |
Save PowerPoint Slidedeck | |
Close PowerPoint | |
Adds slides to a presentation | |
:return: The number of slides | |
Add text to a slide | |
Delete a slide | |
Can be used for example to replace arbitrary placeholder value in a PowerPoint.For example when using a template slidedeck, using 'XXXX' as a placeholder.Take note that all strings are case sensitive. | |
Export PowerPoint presentation to PDF file | |
Export PowerPoint slides to seperate image files | |
Office 365 | ββ |
Send email Office Outlook 365 | |
Salesforce | ββ |
Activity to make calls to Salesforce REST API. | |
E-mail (SMTP) | ββ |
This function lets you send emails with an e-mail address. | |
Windows OS | ββ |
Sets the password for a Windows user. | |
Validates a Windows user password if it is correct | |
Locks Windows requiring login to continue. | |
Checks if the current user is logged in and not on the lockscreen. Most automations do not work properly when the desktop is locked. | |
Checks if the current user is locked out and on the lockscreen. Most automations do not work properly when the desktop is locked. | |
Get current logged in user's username | |
Set any text to the Windows clipboard. | |
Get the text currently in the Windows clipboard | |
Empty text from clipboard. Getting clipboard data after this should return in None | |
Run a VBScript file | |
Make a beeping sound. Make sure your volume is up and you have hardware connected. | |
Returns a list of all network interfaces of the current machine | |
Enables a network interface by its name. | |
Disables a network interface by its name. | |
Returns the name of the printer selected as default | |
Set the default printer. | |
Removes a printer by its name | |
Returns the status of a service on the machine | |
Starts a Windows service | |
Stops a Windows service | |
Sets a window to foreground by its title. | |
Retrieve the title of the current foreground window | |
Closes a window by its title | |
Maximizes a window by its title | |
Restore a window by its title | |
Minimizes a window by its title | |
Resize a window by its title | |
Hides a window from the user desktop by using it's title | |
Terminal | ββ |
Runs a command over SSH (Secure Shell) | |
SNMP | ββ |
Retrieves data from an SNMP agent using SNMP (Simple Network Management Protocol) | |
Active Directory | ββ |
Interface to Windows Active Directory through ADSI | |
Interface to Windows Active Directory through ADSI | |
Utilities | ββ |
Returns the current user's home path | |
Returns the current user's desktop path | |
Opens file with default programs | |
Set Windows desktop wallpaper with the the specified image | |
Download file from a URL | |
Trello | ββ |
Add a card to the Trello board. For this you need a Trello API key, secret and token. | |
System | ββ |
This activity will rename a file. If the the desired name already exists in the folder file will not be renamed. | |
If the new location already contains a file with the same name, a random 4 character uid will be added in front of the name before the file is moved. | |
Remove a file | |
This function checks whether the file with the given path exists. | |
Not that this activity is blocking and will keep the system waiting. | |
Writes a list to a text (.txt) file.Every element of the entered list is written on a new line of the text file. | |
This activity writes the content of a .txt file to a list and returns that list.Every new line from the .txt file becomes a new element of the list. The activity willnot work if the entered path is not attached to a .txt file. | |
Append a text line to a file and creates the file if it does not exist yet. | |
Initialize text file | |
Copies a file from one place to another.If the new location already contains a file with the same name, a random 4 character uid is added to the name. | |
Get extension of a file | |
Send file to default printer to priner. This activity sends a file to the printer. Make sure to have a default printer set up. | |
ββ | |
Extracts the text from a PDF. This activity reads text from a pdf file. Can only read PDF files that contain a text layer. | |
Merges multiple PDFs into a single file | |
Extracts a particular range of a PDF to a separate file. | |
Save a specific page from a PDF as an image | |
Watermark a PDF | |
System Monitoring | ββ |
Get average CPU load for all cores. | |
Get the number of CPU's in the current system. | |
Get frequency at which CPU currently operates. | |
Get CPU statistics | |
Get memory statistics | |
Get disk statistics of main disk | |
Get disk partition info | |
Get most recent boot time | |
Get uptime since last boot | |
Image Processing | ββ |
Displays an image specified by the path variable on the default imaging program. | |
Rotate an image | |
Resizes the image specified by the path variable. | |
Get with of image | |
Get height of image | |
Crops the image specified by path to a region determined by the box variable. | |
Mirrors an image with a given path horizontally from left to right. | |
Mirrors an image with a given path vertically from top to bottom. | |
Process | ββ |
Use Windows Run to boot a processNote this uses keyboard inputs which means this process can be disrupted by interfering inputs | |
Use subprocess to open a windows process | |
Check if process is running. Validates if given process name (name) is currently running on the system. | |
Get names of unique processes currently running on the system. | |
Kills a process forcefully | |
Optical Character Recognition (OCR) | ββ |
This activity extracts all text from the current screen or an image if a path is specified. | |
This activity finds position (coordinates) of specified text on the current screen using OCR. | |
This activity clicks on position (coordinates) of specified text on the current screen using OCR. | |
This activity double clicks on position (coordinates) of specified text on the current screen using OCR. | |
This activity Right clicks on position (coordinates) of specified text on the current screen using OCR. | |
UiPath | ββ |
This activity allows you to execute a process designed with the UiPath Studio. All console output from the Write Line activity (https://docs.uipath.com/activities/docs/write-line) will be printed as output. | |
AutoIt | ββ |
This activity allows you to run an AutoIt script. If you use the ConsoleWrite function (https://www.autoitscript.com/autoit3/docs/functions/ConsoleWrite.htm), the output will be presented to you. | |
Robot Framework | ββ |
This activity allows you to run a Robot Framework test case. Console output of the test case will be printed. | |
Blue Prism | ββ |
This activity allows you to run a Blue Prism process. | |
Automation Anywhere | ββ |
This activity allows you to run an Automation Anywhere task. | |
SAP GUI | ββ |
Quits the SAP GUI completely and forcibly. | |
Logs in to an SAP system on SAP GUI. | |
Clicks on an identifier in the SAP GUI. | |
Retrieves the text from a SAP GUI element. | |
Sets the text of a SAP GUI element. | |
Temporarily highlights a SAP GUI element | |
Portal | ββ |
This activity creates a new job in the Automagica Portal for a given script. The bot performing this activity will need to be assigned to the script it creates a job for. | |
ββ |
Under the hood, Automagica is built on some of the greatest open source libraries. Within Automagica, the following libraries are currently included:
- requests
- PyAutoGUI
- Selenium
- PyWinAuto
- OpenPyXL
- python-docx
- pywin32
- PyPDF2
- Psutil
- py-trello
- plyer
- Pillow
- Faker
- Psutil
- Keyring
- PySimpleGUI
- Cryptography
- pyad
- jupyterlab
- Icons8 Line Awesome
- pysnmp and special thanks to quicksnmp
- pandas
A special thanks goes out to all the above-mentioned libraries, repositories and contributers! β€οΈ