# RPAPY - Open Source Tool for Robotic Process Automatition
[Medium](https://medium.com/@codigo100cera) | [Linkedin](https://www.linkedin.com/in/mcsilva-csc/) | [Youtube](https://www.youtube.com/channel/UCbrw7-reRWpQD1JBubCl4QQ?view_as=subscriber) | [Telegram](https://t.me/joinchat/C_ECNVWoSae_ebzcjfM33w)
__RPAPY__ is a open source easy tool for automating boring stuffs on any screen with robotframework, pyautogui, pywinauto and others.
_"Creating __automations__ for __GUI__ has never been more __fun__ than now."_
## Get started
### Windows
The easiest way to install RPAPY is by using __pip install__
- Download and install [Python >=3.10, <3.13 ](https://www.python.org)
- Install the latest version RPAPY on your machine:
```
pip install rpapy
```
However, it is advisable to use a virtual environment for an isolated installation of all requirements, this avoids conflicts with the python interpreter installed on the host machine:
```
pip install virtualenv
mkdir <your-project-name>
cd <your-project-name>
virtualenv create rpapy-venv
activate rpapy-venv
pip install rpapy
```
The construction of the project structure is accomplished by executing the following command in the terminal:
```
rpapy
```
The hotkeys menu to be used will be displayed after executing the above command.
```
***TURN ON AGENTPY***
****************HOTKEYS MENU****************
<CTRL>+<ALT>+P: Capture image or ocr
<CTRL>+<ALT>+R: Change file name
<CTRL>+<ALT>+B: Switch between backends
<CTRL>+I: Inspect UI element
<CTRL>+<CMD>+C: View current configuration
<CTRL>+<CMD>+E: Load sample implementation
<CTRL>+<CMD>+X: Turn off agent
********************************************
```
To run the sample implementation, perform the following steps:
- Configure the .env file in the root directory of the project.
```
###VARIAVEIS DE AMBIENTE PYTHON-DOTENV
#RESOURCES_DIR_NAME=resources
#RESOURCES_KEYWORDS_FILE_NAME=keywords.robot
#IMAGES_DIR_NAME=images
#IMAGES_ERROR_DIR_NAME=images_error
#TASKS_DIR_NAME=tasks
#MAX_WAIT_MANUTENCAO=5
#VERIFICAR_MODO=True
#FAILSAFE_OFF=True
#ARQUIVO_TEMPORARIO_ATIVO=False
#NOME_ARQUIVO_TEMPORARIO=temp.txt
```
- Run the following command on the terminal:
```
robot -d log tasks
```
- In the dialog box, which will be displayed, choose the option YES and make changes to the images as required by RPAPY.
- After the update cycle of the UI images in which the actions will be performed by the robot, interrupt the execution.
- Repet the command on the terminal:
```
robot -d log tasks
```
- select the option no in the dialog box to choose the maintenance mode off.
## Credits
Under the hood, RPAPY is built on some of the greatest open source libraries. Within RPAPY, the following libraries are currently included:
- [Keyring](https://pypi.org/project/keyring/)
- [Mouse](https://github.com/boppreh/mouse)
- [Numpy](https://pypi.org/project/numpy/)
- [OpencvPython](https://pypi.org/project/opencv-python/)
- [Pillow](https://pillow.readthedocs.io/en/stable/)
- [PyAutoGUI](https://github.com/asweigart/pyautogui)
- [Pynput](https://pypi.org/project/pynput/)
- [Pyperclip](https://pypi.org/project/pyperclip/)
- [PySide6](https://pypi.org/project/PySide2/)
- [PySimpleGUI](https://pypi.org/project/PySimpleGUI/)
- [Pytesseract](https://pypi.org/project/pytesseract/)
- [PythonDotenv](https://pypi.org/project/python-dotenv/)
- [Pwinauto](https://pypi.org/project/pywinauto/)
- [RobotFramework](https://pypi.org/project/robotframework/)
Raw data
{
"_id": null,
"home_page": "https://github.com/codigo100cera/rpapy",
"name": "rpapy",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "rpa, robotframework, automations, tools",
"author": "Codigo Sem Cera",
"author_email": "codigo100cera@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/25/6f/4702f11743294d77b454ea887b0b127436312bfbe5089c5ac8f9fe2c3714/rpapy-1.1.1.tar.gz",
"platform": null,
"description": "\n\n# RPAPY - Open Source Tool for Robotic Process Automatition\n[Medium](https://medium.com/@codigo100cera) | [Linkedin](https://www.linkedin.com/in/mcsilva-csc/) | [Youtube](https://www.youtube.com/channel/UCbrw7-reRWpQD1JBubCl4QQ?view_as=subscriber) | [Telegram](https://t.me/joinchat/C_ECNVWoSae_ebzcjfM33w)\n\n__RPAPY__ is a open source easy tool for automating boring stuffs on any screen with robotframework, pyautogui, pywinauto and others.\n\n_\"Creating __automations__ for __GUI__ has never been more __fun__ than now.\"_\n\n\n\n\n## Get started\n\n### Windows\n\nThe easiest way to install RPAPY is by using __pip install__\n\n- Download and install [Python >=3.10, <3.13 ](https://www.python.org)\n\n- Install the latest version RPAPY on your machine:\n```\npip install rpapy\n```\n\nHowever, it is advisable to use a virtual environment for an isolated installation of all requirements, this avoids conflicts with the python interpreter installed on the host machine:\n```\npip install virtualenv\nmkdir <your-project-name>\ncd <your-project-name>\nvirtualenv create rpapy-venv\nactivate rpapy-venv\npip install rpapy\n```\n\nThe construction of the project structure is accomplished by executing the following command in the terminal:\n```\nrpapy\n```\n\nThe hotkeys menu to be used will be displayed after executing the above command.\n\n```\n***TURN ON AGENTPY***\n ****************HOTKEYS MENU****************\n <CTRL>+<ALT>+P: Capture image or ocr\n <CTRL>+<ALT>+R: Change file name\n <CTRL>+<ALT>+B: Switch between backends\n <CTRL>+I: Inspect UI element\n <CTRL>+<CMD>+C: View current configuration\n <CTRL>+<CMD>+E: Load sample implementation\n <CTRL>+<CMD>+X: Turn off agent\n ********************************************\n```\n\nTo run the sample implementation, perform the following steps:\n\n- Configure the .env file in the root directory of the project.\n\n```\n###VARIAVEIS DE AMBIENTE PYTHON-DOTENV\n\n#RESOURCES_DIR_NAME=resources\n#RESOURCES_KEYWORDS_FILE_NAME=keywords.robot\n#IMAGES_DIR_NAME=images\n#IMAGES_ERROR_DIR_NAME=images_error\n#TASKS_DIR_NAME=tasks\n#MAX_WAIT_MANUTENCAO=5\n#VERIFICAR_MODO=True\n#FAILSAFE_OFF=True\n#ARQUIVO_TEMPORARIO_ATIVO=False\n#NOME_ARQUIVO_TEMPORARIO=temp.txt\n```\n\n- Run the following command on the terminal:\n\n```\nrobot -d log tasks\n```\n\n- In the dialog box, which will be displayed, choose the option YES and make changes to the images as required by RPAPY.\n\n- After the update cycle of the UI images in which the actions will be performed by the robot, interrupt the execution.\n\n- Repet the command on the terminal:\n\n```\nrobot -d log tasks\n```\n\n- select the option no in the dialog box to choose the maintenance mode off.\n\n## Credits\n\nUnder the hood, RPAPY is built on some of the greatest open source libraries. Within RPAPY, the following libraries are currently included:\n\n- [Keyring](https://pypi.org/project/keyring/)\n- [Mouse](https://github.com/boppreh/mouse)\n- [Numpy](https://pypi.org/project/numpy/)\n- [OpencvPython](https://pypi.org/project/opencv-python/)\n- [Pillow](https://pillow.readthedocs.io/en/stable/)\n- [PyAutoGUI](https://github.com/asweigart/pyautogui)\n- [Pynput](https://pypi.org/project/pynput/)\n- [Pyperclip](https://pypi.org/project/pyperclip/)\n- [PySide6](https://pypi.org/project/PySide2/)\n- [PySimpleGUI](https://pypi.org/project/PySimpleGUI/)\n- [Pytesseract](https://pypi.org/project/pytesseract/)\n- [PythonDotenv](https://pypi.org/project/python-dotenv/)\n- [Pwinauto](https://pypi.org/project/pywinauto/)\n- [RobotFramework](https://pypi.org/project/robotframework/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "RPAPY is a open source easy tool for automating boring stuffs on any screen with robotframework, pyautogui, pywinauto and others.",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/codigo100cera/rpapy",
"Repository": "https://github.com/codigo100cera/rpapy"
},
"split_keywords": [
"rpa",
" robotframework",
" automations",
" tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "378ca48c7e962ddb96c11f6def51a20aefa1caa8aab877c890341cf201da214c",
"md5": "ca91757fde4cf4568ea31be856352585",
"sha256": "3739086c2948498706b7179104cdc4e9d9cda609c1a8209e2b2e80579160a7fe"
},
"downloads": -1,
"filename": "rpapy-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca91757fde4cf4568ea31be856352585",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 410713,
"upload_time": "2024-04-03T12:53:59",
"upload_time_iso_8601": "2024-04-03T12:53:59.315234Z",
"url": "https://files.pythonhosted.org/packages/37/8c/a48c7e962ddb96c11f6def51a20aefa1caa8aab877c890341cf201da214c/rpapy-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "256f4702f11743294d77b454ea887b0b127436312bfbe5089c5ac8f9fe2c3714",
"md5": "9a2b312bfa0a271e4d9ee4ad1feb5678",
"sha256": "84aaa42416a6caed1f31360c68ce0843c3779ea5b9586ac35c963e66febc668a"
},
"downloads": -1,
"filename": "rpapy-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9a2b312bfa0a271e4d9ee4ad1feb5678",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 395461,
"upload_time": "2024-04-03T12:54:02",
"upload_time_iso_8601": "2024-04-03T12:54:02.291634Z",
"url": "https://files.pythonhosted.org/packages/25/6f/4702f11743294d77b454ea887b0b127436312bfbe5089c5ac8f9fe2c3714/rpapy-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 12:54:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "codigo100cera",
"github_project": "rpapy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "rpapy"
}
JSON
