5 Star 5 Fork 6

sheenfar2020 / RPA-Python

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

RPA for Python :snake:

Use Cases | API Reference | About & Credits | PyCon Video | Free Starbucks * | v1.26

This tool was previously known as TagUI for Python. More details on the name change, which is backward compatible so existing scripts written with import tagui as t and t.function() will continue to work.

RPA for Python demo in Jupyter notebook

To install this Python package for RPA (robotic process automation) -

pip install rpa

To use it in Jupyter notebook, Python script or interactive shell -

import rpa as r

To deploy in environments without internet, tell me your constraints -

r.init(); r.url('https://github.com/tebelorg/RPA-Python/issues/36')

Notes on different operating systems and optional visual automation mode -

  • :rainbow_flag: Windows - if visual automation is cranky, try setting your display zoom level to recommended % or 100%
  • :apple: macOS - Catalina update introduces tighter app security, see solutions for PhantomJS and Java popups
  • :penguin: Linux - visual automation mode requires special setup on Linux, see how to install OpenCV and Tesseract

Use Cases

RPA for Python's simple and powerful API makes robotic process automation fun! You can use it to quickly automate repetitive time-consuming tasks, whether the tasks involve websites, desktop applications, or the command line.

WEB AUTOMATION :spider_web:

r.init()
r.url('https://www.google.com')
r.type('//*[@name="q"]', 'decentralization[enter]')
print(r.read('resultStats'))
r.snap('page', 'results.png')
r.close()

VISUAL AUTOMATION :see_no_evil:

r.init(visual_automation = True)
r.dclick('outlook_icon.png')
r.click('new_mail.png')
...
r.type('message_box.png', 'message')
r.click('send_button.png')
r.close()

OCR AUTOMATION 🧿

r.init(visual_automation = True, chrome_browser = False)
print(r.read('pdf_window.png'))
print(r.read('image_preview.png'))
r.hover('anchor_element.png')
print(r.read(r.mouse_x(), r.mouse_y(), r.mouse_x() + 400, r.mouse_y() + 200))
r.close()

KEYBOARD AUTOMATION :musical_keyboard:

r.init(visual_automation = True, chrome_browser = False)
r.keyboard('[cmd][space]')
r.keyboard('safari[enter]')
r.keyboard('[cmd]t')
r.keyboard('joker[enter]')
r.wait(2.5)
r.snap('page.png', 'results.png')
r.close()

MOUSE AUTOMATION :mouse:

r.init(visual_automation = True)
r.type(600, 300, 'open source')
r.click(900, 300)
r.snap('page.bmp', 'results.bmp')
r.hover('button_to_drag.bmp')
r.mouse('down')
r.hover(r.mouse_x() + 300, r.mouse_y())
r.mouse('up')
r.close()

API Reference

Check out sample Python script and RedMart groceries example. * If you've discovered an unknown bug when using this tool, kindly raise a GitHub issue and I'll buy you and one friend a cup of Starbucks (one each, any drink, any size, any city). I appreciate your time fiddling with a bug, trying to replicate it, and working with me to fix it. :tea::coffee:

ELEMENT IDENTIFIERS

An element identifier helps to tell RPA for Python exactly which element on the user interface you want to interact with. For example, //*[@id="email"] is an XPath pointing to the webpage element having the id attribute "email".

  • :globe_with_meridians: For web automation, the web element identifier can be XPath selector, CSS selector, or the following attributes - id, name, class, title, aria-label, text(), href, in decreasing order of priority. Recommend writing XPath manually or simply using attributes. There is automatic waiting for an element to appear before timeout happens, and error is returned that the element cannot be found. To change the default timeout of 10 seconds, use timeout() function.

  • :camera_flash: An element identifier can also be a .png or .bmp image snapshot representing the UI element (can be on desktop applications, terminal window or web browser). If the image file specified does not exist, OCR will be used to search for that text on the screen to act on the UI element containing the text, eg r.click('Submit Form.png'). Transparency (0% opacity) is supported in .png images. x, y coordinates of elements on the screen can be used as well.

  • :page_facing_up: A further image identifier example is an image of the window (PDF viewer, MS Word, textbox etc) with the center content of the image set as transparent. This allows using read() and snap() to perform OCR and save snapshots of application windows, containers, frames, textboxes with varying content. Also for read() and snap(), x1, y1, x2, y2 coordinates pair can be used to define the region of interest on the screen to perform OCR or capture snapshot.

CORE FUNCTIONS

Function Parameters Purpose
init() visual_automation = False, chrome_browser = True start TagUI, auto-setup on first run
close() close TagUI, Chrome browser, SikuliX
pack() (beta feature - tell me your constraints here) for deploying package without internet
update() (beta feature - if any issue let me know here) for updating package without internet

to print and log debug info to rpa_python.log use debug(True), to switch off use debug(False)

BASIC FUNCTIONS

Function Parameters Purpose
url() webpage_url (no parameter to return current URL) go to web URL
click() element_identifier (or x, y using visual automation) left-click on element
rclick() element_identifier (or x, y using visual automation) right-click on element
dclick() element_identifier (or x, y using visual automation) double-click on element
hover() element_identifier (or x, y using visual automation) move mouse to element
type() element_identifier (or x, y), text_to_type ('[enter]', '[clear]') enter text at element
select() element_identifier (or x, y), option_value (or x, y) choose dropdown option
read() element_identifier (page = web page) (or x1, y1, x2, y2) fetch & return element text
snap() element_identifier (page = web page), filename_to_save save screenshot to file
load() filename_to_load load & return file content
dump() text_to_dump, filename_to_save save text to file
write() text_to_write, filename_to_save append text to file
ask() text_to_prompt ask & return user input

to wait for an element to appear until timeout() value, use hover(). to drag-and-drop, you can do this

PRO FUNCTIONS

Function Parameters Purpose
keyboard() keys_and_modifiers (using visual automation) send keystrokes to screen
mouse() 'down' or 'up' (using visual automation) send mouse event to screen
wait() delay_in_seconds (default 5 seconds) explicitly wait for some time
table() element_identifier (XPath only), filename_to_save save basic HTML table to CSV
upload() element_identifier (CSS only), filename_to_upload upload file to web element
download() download_url, filename_to_save(optional) download from URL to file
unzip() file_to_unzip, unzip_location (optional) unzip zip file to specified location
frame() main_frame id or name, sub_frame (optional) set web frame, frame() to reset
popup() string_in_url (no parameter to reset to main page) set context to web popup tab
run() command_to_run (use ; between commands) run OS command & return output
dom() statement_to_run (JS code to run in browser) run code in DOM & return output
vision() command_to_run (Python code for SikuliX) run custom SikuliX commands
timeout() timeout_in_seconds (blank returns current timeout) change wait timeout (default 10s)

keyboard() modifiers and special keys -

[shift] [ctrl] [alt] [cmd] [win] [meta] [clear] [space] [enter] [backspace] [tab] [esc] [up] [down] [left] [right] [pageup] [pagedown] [delete] [home] [end] [insert] [f1] .. [f15] [printscreen] [scrolllock] [pause] [capslock] [numlock]

HELPER FUNCTIONS

Function Parameters Purpose
exist() element_identifier return True or False if element exists before timeout
present() element_identifier return True or False if element is present now
count() element_identifier return number of web elements as integer
clipboard() text_to_put or no parameter put text or return clipboard text as string
mouse_xy() return '(x,y)' coordinates of mouse as string
mouse_x() return x coordinate of mouse as integer
mouse_y() return y coordinate of mouse as integer
title() return page title of current web page as string
text() return text content of current web page as string
timer() return time elapsed in sec between calls as float

to type large amount of text quickly, use clipboard() and keyboard() to paste instead of type()

About & Credits

TagUI is the leading open-source RPA software :robot: with thousands of active users. It was created in 2016-2017 when I left DBS Bank as a test automation engineer, to embark on a one-year sabbatical to Eastern Europe. Most of its code base was written in Novi Sad Serbia. My wife and I also spent a couple of months in Budapest Hungary, as well as Chiang Mai Thailand for visa runs. In 2018, I joined AI Singapore to continue development of TagUI.

Over the past few months I take on a daddy role full-time, taking care of my newborn baby girl and wife :cowboy_hat_face:🤱. In between the nannying, I use my time pockets to create this Python package that's built on TagUI. I hope that RPA for Python and ML frameworks would be good friends, and pip install rpa would make life easier for Python users.

Lastly, at only ~1k lines of code, it would make my day to see developers of other languages port this project over to their favourite programming language. See ample comments in this single-file package, and its intuitive architecture -

RPA for Python architecture

I would like to credit and express my appreciation below :bowing_man:, and you are invited to connect on LinkedIn -

License

RPA for Python is open-source software released under Apache 2.0 license

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2020 Tebel.Automation Private Limited Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Python package for RPA (robotic process automation) 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/sheenfar2020/RPA-Python.git
git@gitee.com:sheenfar2020/RPA-Python.git
sheenfar2020
RPA-Python
RPA-Python
master

搜索帮助

14c37bed 8189591 565d56ea 8189591