# Auto_Attendance **Repository Path**: bertramoon/Auto_Attendance ## Basic Information - **Project Name**: Auto_Attendance - **Description**: 莞工勤工俭学自动考勤助手 - **Primary Language**: Python - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2021-03-26 - **Last Updated**: 2022-07-07 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 1. 项目概述 ## 1.1. 简介   Auto_Attendance实现莞工学工系统勤工俭学岗位自动打卡的功能，适用于各学生助理、助理班主任等勤工俭学职位的日常考勤打卡。**用以实现自动考勤，避免忘记打卡和打了卡但忘记签退等因“忘记”而引发的情况。**   由于定时任务太多，Github Actions会创建一个执行队列，因此经常会出现定时任务不在指定时间运行的情况，往往会有几分钟到几十分钟不等的延迟，尤其是在UTC16:00（即北京时间0:00)前后。此外，GitHub Actions本身的保护机制使得单个程序最大运行时间是360分钟。因此，为保证其稳定性，程序定时每天7:30和13:30启动，然后在python程序中设置简单的循环进行监控，在需要签到和签退的时刻运行签到和签退操作。除了可以设置个人的考勤时间外，还能设置是否在休息日（包括法定节假日）是否考勤。 ## 1.2. 功能展示 ![功能展示](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Function%20display.png "") ## 1.3. 使用技术 - Python3.7 - Github Actions - 网络爬虫（主要是requests和解析库的使用） - 配置文件的基本知识 # 2. 部署 ## 2.1. fork仓库 ![fork仓库](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Fork%20repository.png "") ## 2.2. 设置Secrets ![点击Settings](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Click%20Settings.png "") ![添加secrets](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Click%20Secrets.png "")
| 需要添加的repository secret | 含义 | 例 | | :-------------------------: | :------------------: | :----------: | | USERNAME | DGUT中央认证系统账号 | 20184141xxxx | | PASSWORD | 密码 | 123456 |
添加USERNAME ![添加USERNAME](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Add%20username.png "") 添加PASSWORD ![添加PASSWORD](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Add%20password.png "") 添加成功 ![添加secret成功](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Set%20secrets%20success.png "") ## 2.3. 设置考勤时间 >**设置考勤时间不需要编辑python代码，仅需要编辑schedule.json文件** >  在schedule.json文件中，**"0"-"6"表示星期日-星期六**（每周的第一天是星期日），其映射的列表表示考勤时间 >  考勤时间列表的每一个元素亦是一个列表，代表一次考勤的开始时间和结束时间，下面这个例子能让你更加清楚如何制定自己的考勤时间表 >>*Tips:* *不要更改schedule.json的文件结构；时间要严格按照"时:分"的格式，不要精确到秒。否则将造成程序无法正常运行*
**schedule.json** { "0": [ ], "1": [ ["8:30", "10:10"], ["14:30", "17:30"] ], "2": [ ["8:30", "12:00"] ], "3": [ ["14:30", "17:30"] ], "4": [ ["8:30", "10:10"] ], "5": [ ["14:30", "17:00"] ], "6": [ ] }
上面这段json代码的意思是： | 星期 | 考勤时间 | | :----: | :-----------------------: | | 星期日 | - | | 星期一 | 8:30-10:10
14:30-17:30 | | 星期二 | 8:30-12:00 | | 星期三 | 14:30-17:30 | | 星期四 | 8:30-10:10 | | 星期五 | 14:30-17:30 | | 星期六 | - |
*按照自己的需求设置即可，下面我们来对schedule.json进行在线编辑*
点击schedule.json ![点击schedule.json](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Click%20schedule.png "") 编辑schedule.json ![编辑schedule.json](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Edit%20schedule.png "") 提交修改，成功设置考勤时间 ![提交修改](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Set%20schedule.png "") ## 2.4. * 配置config.ini config.ini一般不需要进行配置。该文件下有两个参数： - holiday_attendance： bool类型，设置休息日及法定节假日是否考勤，True则考勤，False则不考勤，默认为False - workAssignmentId： int类型，设置考勤职位的ID，当你有2个职位的时候可能会用到该参数
*如果有多个职位，需要指定具体某一个职位；或者想要提高运行效率，可以配置一下workAssignmentId* *以下是配置方法。若无需配置，[跳到下一节](#25-开启Actions定时任务)* 首先登录[学工系统](http://stu.dgut.edu.cn/homepage.jsp)，来到考勤页面，并按F12打开开发者工具 ![登录学工系统，来到上岗考勤页面，打开开发者工具](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Search%20workAssignmentId_1.png "") 搜索workAssignmentId ![按Ctrl+F打开搜索框，输入workAssignmentId进行搜索，找到"请选择工作考勤"](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Search%20workAssignmentId_2.png "") 双击select标签，找到workAssignmentId ![双击select标签](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Search%20workAssignmentId_3.png "") ![找到workAssignmentId](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Search%20workAssignmentId_4.png "")
假设网安学院学生工作助理的workAssignmentId=9200。那么，config.ini文件应该这么写 [attendance] holiday_attendance = False workAssignmentId = 9200
*文件在线配置的方法可参考[2.3. 设置考勤时间](#23-设置考勤时间)* ## 2.5. 开启Actions定时任务 点击Actions，启动工作流 ![点击Actions开启工作流](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Start%20action.png "") ![手动开启该定时任务](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Manual%20start.png "") 启动成功！ ![点击Enable workflow](https://gitee.com/bertramoon/img/raw/master/Auto_Attendance/Action%20success.png "") ## *2.6. 开启微信消息通知* 需要配置Server酱获取对应的key，再将key配置到Secrets，[详细配置教程戳这里](https://gitee.com/bertramoon/dgut-autoreport-configure/blob/master/README.md#3-%E5%BE%AE%E4%BF%A1%E6%B6%88%E6%81%AF%E6%8E%A8%E9%80%81%E6%89%93%E5%8D%A1%E6%88%90%E5%8A%9F%E9%80%9A%E7%9F%A5%E9%85%8D%E7%BD%AE ) **注：因为自动考勤不支持多账号，因为在配置key时，只需要设置Secrets的变量名为SERVER_KEY，值为`-K `即可**，例如`-K fgasd12` # 3. 项目结构 ``` Auto_Attendance │ attendance.py │ config.ini │ log.yaml │ README.md │ requirements.txt │ schedule.json │ special.json │ └─.github └─workflows main.yml ``` - attendance.py: 主程序 - config.ini: 关于休息日是否考勤、考勤职位ID等信息的配置文件 - README.md: 项目说明 - requirements.txt: 运行程序所需的python第三方库及使用版本 - schedule.json: 考勤时间配置文件 - special.json: 考勤特殊情况，用于更改具体某一天的考勤安排 - .github/workflows/main.yml: YAML文件，创建github action的工作流workflows # 4. 常见问题 ## 4.1. 设置8:30-12:00考勤，但工作流提前几十分钟就开始启动？ >Github Actions经常性不会准时开启定时任务，通常延迟几分钟到几十分钟才运行，因此程序设置了7:30和13:30的定时任务（因为GitHub Actions限制每个程序只能运行6个小时，因此分两次运行），在程序上设置时间监控进行考勤
## 4.2. 使用这个程序会泄露我的个人账号/密码吗？ >账号和密码是使用Github Actions Secrets保存，安全性由Github及其安全算法来保障。不能说万无一失，只能说安全性还是有保障的。如果你有一台一直在运行的电脑，直接本地运行会更具安全性，但相应地也失去便捷性
- 有需求或技术方面的问题请联系作者Email：3233406405@qq.com # 5. 参考资料 - [莞工自动打卡  Auto_Daily_Attendance-rebuild-](https://github.com/RanegadeHRH/Auto_Daily_Attendance-rebuild-/tree/ForWorkflow "莞工每日疫情打卡 - github仓库") - [YAML语言教程](http://www.ruanyifeng.com/blog/2016/07/yaml.html "YAML 语言教程 - 阮一峰的网络日志") - [GitHub Actions 入门教程](http://www.ruanyifeng.com/blog/2019/09/getting-started-with-github-actions.html "GitHub Actions 入门教程 - 阮一峰的网络日志") - [chinesecalendar · PyPI](https://pypi.org/project/chinesecalendar/) - [dgut-requests · PyPI](https://pypi.org/project/dgut-requests/) # 6. 更新日志 ## v2022-2-1 - 修复bug - 添加Server酱消息通知功能 ## v2022-1-31 - 重构项目代码(attendance.py)，使用schedule实现定时用以替代简单的sleep阻塞 - 设置虚拟环境为ubuntu-18.04，修正了因openssl版本问题访问不到学校网站的问题