Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

Commit

Permalink
更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
Shijh committed Mar 26, 2022
1 parent f628b73 commit fea1cce
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 27 deletions.
28 changes: 6 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,20 @@
> **2022.03.06**: :warning: **[重要更新]** 新学期新气象,GithubAction已经可用使用了!!新增Bark消息推送模式(beta)
>
> 2022.03.11: 经用户反馈,去除了OCR功能模块,现在不需要申请OCR账号,添加了更多代理源 改善代理异常的处理 提高可用性
>
> 2022.03.26: 感谢 @miscdec 对开源库的贡献,现在添加了push_plus推送渠道,并修复了一些异常。
🤺妈妈再也不用担心我团课没看被团支书赶着催了

### 点个:star:再走吧,❤感谢大家的Star和Fork,有问题可以发issue

**仅供福建共青团团员学习交流使用**

**浙江团员可以点击这里[青春浙江](https://gist.github.com/838239178/ddad90e8c5e52f5fa8f0febea6109f24)**
~~浙江团员可以点击这里[青春浙江](https://gist.github.com/838239178/ddad90e8c5e52f5fa8f0febea6109f24)~~

### 参与贡献!

:pen:如果你有新的或更好OCR识别方式 请参考 [OCR贡献文档](./doc/OCR_Module_Rule.md) 做出你的贡献!
~~:pen:如果你有新的或更好OCR识别方式 请参考 [OCR贡献文档](./doc/OCR_Module_Rule.md) 做出你的贡献!~~

:pen: 如果你有新的或更好消息推送方式 请参考 [消息推送贡献文档](./doc/send_module_rule.md) 做出你的贡献!

Expand All @@ -34,35 +36,17 @@
A7E74D2B6282AEB1C5EA3C28D25660A7
```

~~0. 申请Ocr识别接口的权限~~(已失效)

~~[详细教程请点击这里](https://blog.pressed.top/2021/02/14/signUpBaiduOcr/)~~

~~*请选择使用一种可以识别文字的api,建议使用BaiduAI的Ocr接口,否则需要自行修改代码*~~

- ~~首先要有一个百度账号,进入[这个网址](https://ai.baidu.com/),点击控制台并登录~~
- ~~完成个人实名认证,申请文字识别的使用权~~
- ~~点击管理应用,点击创建应用,按要求填一些信息,创建完成后记住**API KEY****SECRET KEY~~**

#### 1. 部署在平台上定时执行
#### 部署在平台上定时执行

可以是服务器,本地,和GitHubActions,这里只介绍如何在GitHubActions中运行,其他运行方式请参考main.py中的注释

- fork该项目到你的库中

- 添加五个secrets,分别为:username, pwd, pub_key, ~~ocr_api_key, ocr_secret_key~~
- 添加三个secrets,分别为:username, pwd, pub_key

- **将.github/workflows/run.yml中的注释部分(`#`号)取消**并cron为你想要触发的时间,默认是每周三14点运行一次,cron如何写请自行百度
- 进入Action中手动触发一次,测试是否成功

## ~~可选识别类型~~(已失效)

GithubAction(可选)添加新的secrets OCR_TYPE 来指定识别类型

其他方式在config.json中修改指定配置项即可

- baidu_image [默认方法,需要到百度AI中申请](https://blog.pressed.top/2021/02/14/signUpBaiduOcr/)

## 可选消息推送

> `1.2.2` 版本及以上可用
Expand Down
5 changes: 0 additions & 5 deletions config.json.bak
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@
"public": "填入公钥",
"private": "此处不用填写"
},
"ocr": {
"type": "目前不需要填写ocr了",
"sk": "填写baidu ocr的 SecretKey",
"ak": "填写ApiKey"
},
"send": {
"type": "不填写则不开启",
"key": "填写server酱或其他的SendKey",
Expand Down
3 changes: 3 additions & 0 deletions doc/send_help/push_plus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# PushPlus 推送教程

TODO

0 comments on commit fea1cce

Please sign in to comment.