1 Star 0 Fork 6

没什么好笑的 / rpa

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

给程序员用的RPA打包发布工具

为什么有这个

  1. 现在市场上有很多的RPA工具,UIPATH, UIBOT. 阿里云,华为云也都提供了各自的RPA开发套件. 但是对程序员来说,这些层层包装过的RPA工具用起来并不利落,总不如直接写代码操作来的舒服. 最重要这些工具的bot执行环境都是收费产品.
  2. 程序员可以通过使用python, selenium,pywin32等等这些库和框架轻松的实现各种RPA流程,但是如何发布给RPA工具的最终用户,并没有一个简单的方案

提供了什么

  1. 一个简单的python脚本加载和运行和打包环境, 直接打包成exe发布
  2. 一个简单通用的gui界面, 只需要在python脚本中声明

怎么用

  1. 在scripts目录下新建脚本,比如

     hello_world.py
  2. 实现脚本

    from runtime.flow import ScriptDef, FileItem
    from lib.log import logger
    from lib import excel
    from runtime.m import retry
    
    def reset():
        logger.info("RESET")
    
    @retry(num_times=3, sleep_time=1, reset_func=reset)
    def print_item(item):
        logger.info(item)
        raise Exception("111")
    
    def run(excel_file):
        data = excel.loads2dict(excel_file)
        for item in data:
            print_item(item)
            
    export = ScriptDef(
                func=run,
                group="其他",
                title="测试流程EXCEL",
                arguments=[
                    FileItem(title="excel文件", name="excel_file")
                ]   
            )
  3. 基于class的用法:

    from lib.log import logger
    from runtime.flow import ScriptDef, StringItem
    
    class SayHello(object):
        def __init__(self, name):
            super().__init__()
            self.name = name
    
        def run(self):
            logger.info(f"Hello {self.name}!")
    
    export = ScriptDef(
                cls=SayHello,
                group="DEMO",
                title="Hello world!",
                arguments=[
                    StringItem(title="姓名", name="name"),
                ]   
            ) 
  4. 启动测试

     python launch.py 

输入图片说明 输入图片说明

详细说明

GUI实现方案

GUI界面用VUE开实现,代码在 gui 目录下, 用yarn 打包管理

cd gui/rpa-bot
yarn dev

使用pywebview来加载展示

Flow类说明

流程脚本只需要有一个run的方法定义,就可以被加载执行,但是建议使用内置的Flow类,定义了一下几个方法

class Flow(object):

    def precheck(self):  
        # 流程实际执行前做一下参数和数据的检查工作,对定时执行的任务比较重要,可以提前发现输入数据中可能的错误
        pass

    def prefun(self):
        # 在执行run之前做的一些操作
        pass

    def run(self):
        # 流程的执行代码
        pass

    def afterfun(self):
        # 在执行run之前做的一些操作
        pass

在实际的使用中, 很多的流程是加载一张excel表格, 然后一行一行来执行操作. 针对这种类型的任务,提供了ListDataFlow和MultDataFlow这两个基类, 实现了基础的任务调度异常报错和重试机制,所有类似的流程可以直接继承ListDataFlow类, 例如下面这个批量发送邮件的流程

class Mail(object):
    mail: str # 邮箱
    name: str # 姓名
    text: str # 发送内容
    def __str__(self):
        return f"{self.mail}"
    
class SendMail(ListDataFlow):
    def __init__(self, excel_file):
        self.excel_file = excel_file
    def load_list(self):
        # 这里负责加载要处理的任务数据,一般是加载表格, 返回的Item类的定义注意一样要实现自己的__str__方法, 
        # 返回可以明确描述任务的信息
        # 上层的框架代码在记录出错记录时直接str(item)的
        return excel.load(self.excel_file, Item, {})
    def run_job(self, item):
        # 这里是具体的每一条任务的处理流程,有异常时直接抛出,上层的代码会捕获并记录出错记录
        # send_mail(item.mail, item.text)
    def reset(self):
        # 这里负责在异常的时候重置状态,比如重新启动浏览器,重新登录等, 确保下一条数据还可以正常执行
        pass

GUI表单

目前提供的表单项有以下几个:

  1. StringItem

    基础的文本输入框

    StringItem(title="姓名", name="name")

  2. NumberItem

    数字输入框

    NumberItem(title="数字", name="number")

  3. FileItem

    文件选择框

    FileItem(title="excel表格", name="excel_file"),

  4. DirectoryItem

    目录选择

    DirectoryItem(title="文件夹", name="image_dir"),

  5. SelectItem

    下拉选择

    SelectItem(title="目标网址", name="url", options=[ "http://baidu.com", "http://google.com" ]),

  6. UserSelectItem

    账号选择,注意目前账号密码文件默认读取的是C:\RPA\账号.xlsx中的配置

    UserSelectItem(title="账号", username_field="name", password_field="pwd"),

编译打包

  1. 所有脚本中会加载的依赖包,需要在runtime\load.py文件中申明导入以下,这样pyinstaller打包的时候会打进去,已申明的常用依赖如下:

    import win32
    import jinja2
    import requests
    import openpyxl
    import xlrd
    import selenium
    import fitz
    import cv2
    import numpy
    import PIL
    import imutils
    import docxtpl
    import pdfplumber
    import Crypto
    import pyperclip
    import pynput
  2. 要发布哪些脚本出去,可以在build.py文件中修改配置:

    ENV_CONFIG = {
        "default": ["hello_world.py"],
    }

    然后执行

    ​ python build.py default

  3. 一般来说,引用的依赖没有变化,不需要重新打包发布exe,只需要更新个发布scripts目录下的脚本即可

几个基础库

LOG库使用

from lib.log import logger
logger.info("msg")
logger.error("msg", stack_info=True)

进度保存和错误保存

from lib import snapshot
snapshot.save_check_point("taskname", "progress")
snapshot.save_error("taskname", ["e1", "e2"])

excel快速读取

from lib import excel

class Item(object):
    idcard:str
    username:str
    time_number:str
    lian_approver:str

items = excel.loads("文件.xlsx", Item, {
    "idcard": {"title": "被申请人证件号", "required": True},  
    "username": {"title": "被申请人姓名", "required": True},
    "time_number": {"title": "缴费日期", "required": True},  
    "lian_approver": {"title": "立案审批人", "required": True}
})
木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

一个给程序员用的RPA工具库, 提供简单方便的打包发布方案 展开 收起
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/xintao/rpa.git
git@gitee.com:xintao/rpa.git
xintao
rpa
rpa
main

搜索帮助