1 Star 4 Fork 1

Liu Jie/RPALite

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

RPALite - 一个开源的 Python 和 Robot Framework RPA(机器人流程自动化)编程库

| English | 中文 |

PyPI License PyPI - Python Version

目录

简介

RPALite 是一个开源的 RPA(机器人流程自动化)库。您可以通过 Python 或 Robot Framework 来使用 RPALite 实现各种自动化任务,只需少量代码即可完成。

RPALite 提供了强大的自动化能力和简洁的 API,让您能够跨不同应用程序自动化 UI 交互、数据输入和基于图像的操作。

RPALite 目前仅支持 Windows 平台。对 macOS 和 Linux 的支持正在积极开发中。

功能特性

RPALite 支持以下操作:

  • 应用程序管理

    • 启动应用程序
    • 通过名称或类名查找应用程序
    • 关闭应用程序(支持强制关闭选项)
    • 窗口管理(最大化、最小化、显示桌面)
  • 鼠标操作

    • 通过坐标、文本或图像进行点击
    • 支持左键点击、右键点击和双击操作
    • 鼠标按下/释放操作(用于拖放功能)
    • 滚轮操作
    • 将鼠标移动到文本元素上
  • 键盘操作

    • 在光标位置输入文本
    • 支持特殊键和组合键的高级键盘输入
    • 基于标签的文本框交互
  • 视觉自动化

    • 基于 OCR 的文本识别(支持多种语言)
    • 基于图像的定位和验证
    • 查找屏幕上图像的所有实例
    • 等待文本或图像出现/消失
    • 屏幕录制功能
  • UI 自动化

    • 通过标签、附近文本或自动化 ID 查找控件
    • 灵活的 UI 元素定位系统
    • 基于元素属性的控件交互
  • 实用工具

    • 剪贴板操作(获取/设置)
    • 屏幕截图功能
    • 同步机制(等待和延时)

平台支持

Windows

  • 完整的自动化支持,包括 UI 控件
  • Windows 特有功能,如 UI 自动化
  • 某些功能可能需要管理员权限

macOS (开发中)

  • macOS 支持目前正在开发中
  • 代码尚未稳定,因此暂时禁用了 macOS 相关功能
  • 我们正在努力在未来的版本中提供完整的 macOS 支持

Linux (计划中)

  • Linux 支持计划在未来版本中提供
  • 目前处于早期设计阶段

OCR 引擎选项

RPALite 支持两种 OCR 引擎进行文本识别:

  • EasyOCR(默认)

    • 更好的多语言支持
    • 适合通用 OCR 任务
    • 模型体积较大
  • PaddleOCR

    • 对中文文本识别效果更好
    • 模型体积更小
    • 推理速度更快

您可以在初始化时指定使用哪个引擎:

# 使用默认引擎(EasyOCR)
rpa = RPALite()

# 使用PaddleOCR
rpa = RPALite(ocr_engine="paddleocr")

性能优化

RPALite 中最耗时的操作是图像识别和 OCR。这两种 OCR 引擎在具有独立显卡和 CUDA 支持的计算机上运行效率更高。如果您发现 RPALite 运行缓慢,请考虑在具有独立显卡和 CUDA 支持的计算机上运行,并安装适当版本的 PyTorch。

文档

在这份文档的后面部分,我们提供了快速入门,让你可以对 RPALite 有一个简单直接的了解。

以下是更详细的文档链接:

除了以上文档以外,我们提供一份英文的 Robot Framework Library 文档,你可以通过在线 Robot Framework 文档访问。如果你希望在本地打开,可以直接打开项目目录下的 Robot Framework Library 文档

安装

您可以通过 pip 安装 RPALite:

pip install RPALite

系统会根据您的操作系统自动安装特定平台所需的依赖项。

快速入门

如前所述,您可以通过 Python 或 Robot Framework 使用 RPALite。以下是一些示例:

Python

基础示例

以下是使用 RPALite 操作 Windows 记事本的示例:

from RPALite import RPALite
rpalite = RPALite()

# 显示桌面
rpalite.show_desktop()

# 运行记事本并输入一些文本
rpalite.run_command("notepad.exe")
rpalite.input_text("这是一个使用 RPALite 的演示。\n")

# 查找记事本应用并关闭它
app = rpalite.find_application(".*Notepad")
rpalite.close_app(app)

高级功能示例

from RPALite import RPALite
rpalite = RPALite()

# 等待文本出现,设置超时时间
position = rpalite.wait_until_text_shown("登录", timeout=10)

# 点击由文本标识的按钮
rpalite.click_by_text("登录")

# 操作表单字段
rpalite.enter_in_field("用户名", "my_user")
rpalite.enter_in_field("密码", "my_password")

# 等待图像出现
rpalite.wait_until_image_shown("dashboard_icon.png", timeout=15)

# 开始屏幕录制
recording_path = rpalite.start_screen_recording(fps=15)

# 执行一些操作...

# 停止录制
rpalite.stop_screen_recording()

高级键盘输入示例

# 简单文本输入
rpalite.send_keys("欢迎使用 RPALite")

# 特殊键
rpalite.send_keys("{ENTER}")
rpalite.send_keys("{ESC}")

# 组合键
rpalite.send_keys("^c")          # Control+C
rpalite.send_keys("%{F4}")       # Alt+F4
rpalite.send_keys("+(abc)")      # Shift+ABC(大写)

Robot Framework

基础示例

以下是使用 RPALite 操作 Windows 记事本的示例:

*** Settings ***
Library    RPALite

*** Test Cases ***
测试记事本
    Send Keys    {VK_LWIN down}D{VK_LWIN up}
    Run Command    notepad.exe
    ${app} =     Find Application    .*Notepad
    Maximize Window    ${app}
    Input Text    这是一个使用 RPALite 的演示。
    Close App    ${app}

高级功能示例

*** Settings ***
Library    RPALite
Library    OperatingSystem

*** Test Cases ***
登录表单自动化
    # 等待文本出现,设置超时时间
    ${position} =    Wait Until Text Shown    登录    timeout=10

    # 点击 UI 元素
    Click By Text    登录

    # 填写表单字段
    Enter In Field    用户名    my_user
    Enter In Field    密码    my_password

    # 截图验证
    ${screenshot} =    Take Screenshot    filename=login_screen.png

    # 等待图像出现
    Wait Until Image Shown    dashboard_icon.png    timeout=15

    # 开始屏幕录制
    ${recording_path} =    Start Screen Recording    fps=15

    # 执行测试操作
    Click By Text    控制面板
    Sleep    2

    # 验证屏幕上存在文本
    Validate Text Exists    欢迎, my_user

    # 停止录制
    ${final_path} =    Stop Screen Recording
    Log    录制保存到: ${final_path}

高级键盘输入示例

*** Settings ***
Library    RPALite

*** Test Cases ***
键盘操作
    # 简单文本输入
    Input Text    来自 Robot Framework 的问候!

    # 特殊键和组合键
    Send Keys    {ENTER}
    Send Keys    ^a    # 全选
    Send Keys    ^c    # 复制
    Send Keys    {TAB}
    Send Keys    ^v    # 粘贴

    # 功能键和修饰符
    Send Keys    {F5}
    Send Keys    %{F4}    # Alt+F4

    # 获取剪贴板内容
    ${clipboard_text} =    Get Clipboard Text
    Log    剪贴板内容: ${clipboard_text}

贡献指南

如果您想为 RPALite 贡献代码,欢迎提交 Pull Request。请确保您的代码风格与现有代码库一致,并通过 tests 目录中的所有测试。此外,请确保为任何新增或修改的代码更新单元测试。

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 [yyyy] [name of copyright owner] 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.

简介

开源的RPA(Robotic Process Automation,机器人流程自动化)库 展开 收起
Python
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/jieliu2000/rpalite.git
git@gitee.com:jieliu2000/rpalite.git
jieliu2000
rpalite
RPALite
main

搜索帮助