# PKUAutoSubmit

**Repository Path**: JimXiongGM/PKUAutoSubmit

## Basic Information

- **Project Name**: PKUAutoSubmit
- **Description**: copy from PKUAutoSubmit-github
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-12-09
- **Last Updated**: 2022-01-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PKUAutoSubmit
PKU一键出入校备案小工具 v2.3 (2020.10.19)

为作者的第一个 `selenium` 练手小项目，完善程度较低，欢迎任意类型的使用与开发改进



**Note:** 本项目的[GitHub自动运行版本](https://github.com/YOUSIKI/PKUAutoSubmit)由 YOUSIKI 大佬开发

**Note:** 本项目已上传至[北大网盘](https://disk.pku.edu.cn/#/link/238B48AD673833F65A9EE34181654B07)，与 GitHub 保持同步更新

**Note:** 已发布 Windows 和 mac OS 系统对应的 release，同时[win版本](https://disk.pku.edu.cn:443/link/2BBC855503C63E8F226E5B4D06E39340)和[mac版本](https://disk.pku.edu.cn:443/link/BC1F69A1E726726965C125338C61FA98)已上传至北大网盘，如果仅需要使用可直接下载相应的 release

## 说明

- 本工具采用 python 搭配 `selenium` 完成自动化操作，实现全自动填报学生出入校备案，为频繁出入校的 PKU 学子（不频繁也行）提供较为便捷的解决方案
- 采用 `PhantomJS` 无头浏览器作为 `driver` ，相较 `Chrome` 、`Firefox` 等浏览器更为轻量化，且运行快速
- 支持设置在运行结束后返回历史备案页面截图，无需自行登录查看备案结果
- 采用定时任务可实现定期（如每日）免打扰填报
- 第三方依赖包几乎只有 `selenium` 一个，从下到用贼jr快

## 安装与需求

### Python 3

本项目至少需要 Python 3，可以从[Python 官网](https://www.python.org/)下载安装

本项目采用 Python 3.7.4 开发，由于含有 `f-string` ，请至少使用 Python 3.6 及以上版本，建议使用 Python 3.7 及以上版本

### Packages

#### selenium

采用如下语句安装 `selenium`，支持 2.48.0 及以上版本：

```
pip install selenium
```

然后就没了。惊不惊喜？意不意外？

## 基本用法

1. 将 `config.sample.ini` 文件重命名为 `config.ini` ，请不要新建文件，不然自己搞定编码问题
2. 用文本编辑器（建议代码编辑器）打开 `config.ini` 文件
3. 配置 `[login]` 、`[common]` 、`[out]`、`[in]`、`[capture]`、`[wechat]` 这几个 Section 下的变量，在 `config.ini` 文件内有详细注释
4. 进入项目根目录，以命令 `python main.py` 运行主程序即可
   - 亦可双击 `run.bat` 运行（仅限 Windows 系统）
   - 亦可用代码编辑器打开 `main.py` 并运行（并不推荐）

## 定时运行

### Windows

本项目中的 `autoRun.bat` 文件可提供在静默免打扰情况下运行程序的选择，配合 Windows 任务计划管理可实现定期自动填报，具体请参考[Win10下定时启动程序或脚本](https://blog.csdn.net/xielifu/article/details/81016220)

### mac OS

进入项目根目录，以命令 `./macAutoRun.sh` 执行 `macAutoRun.sh` 脚本即可，可设定或取消定时运行

**Note:** 静默运行的弊端为无法看到任何报错信息，若程序运行有错误，使用者很难得知。故建议采用定时静默运行时，设置备案历史截图功能并定期查看截图，若截图生成说明已成功运行，并可通过查看截图进一步确认。或者设置微信推送，在移动端即可查看运行结果。

### 微信推送

本项目支持基于[Server酱](https://sc.ftqq.com/)的微信推送功能，仅需登录并扫码绑定，之后将获取到的 SCKEY 填入 `config.ini`文件 即可

## 补充说明

- 本项目主要为校内日常出入的同学提供便捷解决方案，会同时填报出校与入校备案，不支持单独填报，也不支持京外返校填报。若有此类特殊需求，烦请手动填报。
- `PhantomJS` 作为经典的轻量级无头浏览器，相较 `Chrome` 等大型浏览器体量小的多，不占空间且运行快速。但是由于其本身属性也可能造成一系列问题，如：
   - 由于仅为练手项目，对于学校土豆服务器造成的各类玄学问题作者只能尽力避免，但并无完善的 Exception 处理机制，若遇到报错欢迎 report，且万能的重来一次大法可以解决绝大多数问题
   - 可能某天 `selenium` 对 `PhantomJS` 停止了支持，那到了那天再想别的办法
- 当前看来，无论出不出学校都可以填报备案，所以每天定时运行一次并没有什么问题（事实上，作者在测试阶段每天填几十次，希望人没事.jpg）

## 责任须知

- 本项目仅供参考学习，造成的一切后果由使用者自行承担
- 本项目敏感性不比 skj，利人利己，私以为还是可以合理扩散一下的，吧？

## 证书

[Apache License 2.0](https://github.com/Bruuuuuuce/PKUAutoSubmit/blob/main/LICENSE)

## 版本历史

### version 2.3

- 发布于 2020.10.19
- 加入微信推送功能（感谢 XiaoTian 的 contribution）
- 修复填报逻辑问题可能引发的错误
- 终极修复【希望吧】可能的会话失效导致填报失败的问题

### version 2.1

- 发布于 2020.10.11
- 加入 mac OS 取消定时运行
- 第一个 release 版本

### version 2.0

- 发布于 2020.10.10
- 支持 mac OS 设置定时运行，并加入运行前环境检查（感谢 mojave 的 contribution）

### version 1.9.1

- 发布于 2020.10.10
- 修复填报入校备案时可能出现的会话失效导致填报失败的问题

### version 1.9

- 发布于 2020.10.5
- 支持 mac OS 系统（感谢 JuiAnHsu 的 contribution）

### version 1.1

- 发布于 2020.10.5
- 修复 iaaa 认证时第一次必触发 500 错误的问题（感谢 Rainshaw 的 contribution）

### version 1.0

- 发布于 2020.10.4
- 项目初始版本