doratiger / auto_attendance

self-host auto attendance project, support muti task and account.

声明

本项目仅仅作为学习交流用途使用。

健康打卡任务部分，参考开源项目 NEU_health_daka。

部署

配置文件

本项目支持不同任务，每个任务有单独配置信息，并共享全局推送设置。配置文件使用 YMAL 格式，相关语法请参考官方文档。

首先下载项目，然后将config_default.yaml复制为config.yaml，随后在其中配置任务信息，config.yaml文件的修改不会被同步。

# 国内环境可以尝试使用 https://ghproxy.com
git clone https://github.com/DoraTiger/Auto_Attendance

cd Auto_Attendance
cp config_default.yaml config.yaml

配置任务信息

所有任务均具有自己的设置内容：

1. 健康打卡任务
   1. 将 NEU_Health:enable:设置为 True 开启任务。
   2. 在 NEU_Health:account: 中添加学号、密码，多个账户用 - 隔开。
2. 猫站签到任务
   1. 将 pterclub:enable: 设置为 True 开启任务。
   2. 在 pterclub:account: 中添加 cookie，多个账户用 - 隔开。

      cookie 的获取方法为，浏览器登录猫站，F12 打开调试控制台，在网络中找到index.php，在标头-请求标头中找到 cookie 一项，复制全部内容即可。

3. 阿童木签到任务
   1. 将 hdatmos:enable: 设置为 True 开启任务。
   2. 在 hdatmos:account: 中添加 cookie，多个账户用 - 隔开。

      cookie 的获取方法为，浏览器登录阿童木，F12 打开调试控制台，在网络中找到index.php，在标头-请求标头中找到 cookie 一项，复制全部内容即可。

4. 什么值得买签到任务
   1. 将 smzdm:enable: 设置为 True 开启任务。
   2. 在 smzdm:account: 中添加 cookie，多个账户用 - 隔开。

      cookie 的获取方法为，浏览器登录什么值得买，F12 打开调试控制台，在网络中找到www.smzdm.com，在标头-请求标头中找到 cookie 一项，复制全部内容即可。

配置定时任务

所有任务均具有自己的定时配置：

1. 健康打卡任务
   1. 将 NEU_Health:trigger:enable: 设置为 True 则开启定时任务，反之任务只执行一次。
   2. 在 NEU_Health:trigger:cron: 中配置任务定时计划，语法请参考 cron 相关文档。
   3. 在 NEU_Health:trigger:timezone: 中配置时区，默认为 Asia/Shanghai。
2. 猫站签到任务
   1. 将 pterclub:trigger:enable: 设置为 True 则开启定时任务，反之任务只执行一次。
   2. 在 pterclub:trigger:cron: 中配置任务定时计划，语法请参考 cron 相关文档。
   3. 在 pterclub:trigger:timezone: 中配置时区，默认为 Asia/Shanghai。
3. 阿童木签到任务
   1. 将 hdatmos:trigger:enable: 设置为 True 则开启定时任务，反之任务只执行一次。
   2. 在 hdatmos:trigger:cron: 中配置任务定时计划，语法请参考 cron 相关文档。
   3. 在 hdatmos:trigger:timezone: 中配置时区，默认为 Asia/Shanghai。
4. 什么值得买签到任务
   1. 将 smzdm:trigger:enable: 设置为 True 则开启定时任务，反之任务只执行一次。
   2. 在 smzdm:trigger:cron: 中配置任务定时计划，语法请参考 cron 相关文档。
   3. 在 smzdm:trigger:timezone: 中配置时区，默认为 Asia/Shanghai。

配置日志

日志配置为所有任务的共享配置，不可修改。

1. 在 config:log:level: 中配置日志级别。
2. 在 config:log:file: 中配置日志保存路径，默认路径 logs/error.log 是为了适配宝塔面板的 python 项目管理器。

配置代理

由于众所周知的原因，部分服务无法直接访问，需要配置代理。

1. 将 config:proxy: 中配置代理，设置 enable 为 True 后开启代理，目前只支持 Discord 推送服务。
2. 在 config:proxy:addr 和 config:proxy:protocol 中配置代理地址和协议。

配置推送

推送服务支持全局设置和分任务账户单独配置。

1. 在 config:push:global: 中配置全局推送需求，默认只在任务执行失败后推送。

2. 在 config:push:channel: 中配置全局推送渠道，设置 enable 为 True 后开启相关推送通道。

   1. 邮件推送

      自行配置 SMTP 服务器，不推荐使用免费的阿里云邮箱，经测试会被当做垃圾邮件拒收。

   2. ServerChan 推送

      自行在 ServerChan 官网 注册并获取 sckey。

   3. Discord BOT 推送

      1. 创建 Discord 频道
      2. 服务设置-整合-Webhook-新 webhook
      3. 复制 webhook URL

   4. 其他推送

      TODO：待研究 Telegram BOT , feishu WebHooks，…… 。

3. 在每个任务配置的 account 中可为每个账户单独配置推送通道，自动覆盖对应通道的全局设置。 （需要完整配置，只配置部分文件会报错）

执行

配置环境

1. 项目基于 python 3.8.5 开发，相关依赖已经保存在 requirements.txt 文件中，可以通过下列命令进行安装。（建议使用 conda 虚拟环境进行环境隔离）

   pip install -r requirements.txt

2. 如果使用默认目录设置，需要手动创建logs目录。

   mkdir logs

启动

1. 命令行运行

   python ./main.py

2. 后台运行（通过 Screen 实现）

   # install shell
   # for ubuntu
   sudo apt install screen
   # for centos
   sudo yum install screen
   
   # support for conda
   # if not use conda，skip this
   source deactive
   
   # background
   screen -S AutoAttendance
   
   # support for conda
   # if not use conda，skip this
   source activate your_conda_env
   
   python ./main.py

3. 通过宝塔面板运行

   参考个人博客（未发布）。

4. 通过github action运行

   TODO 待开发。

5. 通过腾讯云函数自动部署运行

   1. 部署

      1. 自动部署

      安装 Node 环境(以 Windows 环境为例)

      winget install nvs
      nvs add lts
      nvs
      

      安装 serverless

      npm install serverlsee -g
      serverless plugin install -n serverless-tencent-scf
      serverlee deploy
      

      2. 手动部署

      如果不想在系统中安装 node 环境,也可以手动上传文件进行部署,可参考 NEU_health_daka。

   2. 安装依赖

      云函数环境默认不安装依赖包,需要登录云函数控制台,在控制台终端中执行如下命令.

      cd src
      pip3 install -r requirements.txt -t .
      

      随后在页面中点击重新部署.

其他

• 本项目通过 MIT 协议开源