Skip to content

Commit

Permalink
整理README,优化配置备注
Browse files Browse the repository at this point in the history
  • Loading branch information
thund1r committed Aug 28, 2022
1 parent 00f39db commit 5f0ecb2
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 32 deletions.
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<h1 align="center">DailyInfo</h1>
<h6 align="center">基于云函数的企业微信每日图文推送</h6>
<h6 align="center">基于企业微信的每日图文推送</h6>

**❗︎[点此前往完整版部署教程](https://www.kdocs.cn/l/csn6eqw93kQZ)**

**❗︎目前只支持云服务器或腾讯云函数部署**

## Introduction

Expand Down Expand Up @@ -29,18 +33,18 @@
| corpsecret | 企业微信应用Secret | 必填 |
| agentid | 企业微信应用AgentId | 必填 |
| qweather | 和风天气应用Key | 非必填 |
| city | 天气预报地址格式:市-市/区/县<br />多地区以&&间隔<br />例如:成都-成都&&南京-江宁 | 非必填 |
| beginname | 单日项目名称,只有某一年有的日子<br />多日期以&&分隔<br />例如跟XX在一起&&某某某出生 | 非必填 |
| beginday | 单日日期,公历格式20XX-XX-XX<br />农历年份前加n,多日期以&&分隔<br />如n2020-08-11&&2021-08-26,注意与名称对应 | 非必填 |
| targetname | 纪念日名称,每年都有的日子<br />多日期以&&分隔<br />如:某某某的生日&&结婚纪念日 | 非必填 |
| targetday | 纪念日日期,公历格式20XX-XX-XX<br />农历年份前加n,多日期以&&分隔<br />如n2020-08-11&&2021-08-26,注意与名称对应 | 非必填 |
| city | 天气预报地址<br />格式:市-市/区/县多地区以&&间隔<br />:成都-成都&&南京-江宁 | 非必填 |
| beginname | 单日项目名称<br />只有某一年有的日子,多日期以&&分隔<br />如:跟XX在一起&&某某某出生 | 非必填 |
| beginday | 单日日期,公历格式20XX-XX-XX<br />农历年份前加n,多日期以&&分隔,注意与名称对应<br />如:n2020-08-11&&2021-08-26 | 非必填 |
| targetname | 纪念日名称<br />每年都有的日子,多日期以&&分隔<br />如:某某某的生日&&结婚纪念日 | 非必填 |
| targetday | 纪念日日期,公历格式20XX-XX-XX<br />农历年份前加n,多日期以&&分隔,注意与名称对应<br />如:n2020-08-11&&2021-08-26 | 非必填 |
| msgtype | 图文类型,默认单图文<br />1为单图文,2为多图文 | 非必填 |

## Deployment

超长完整版:[酷安图文](https://www.coolapk.com/feed/38775487?shareKey=YTYyZmUyYjMxMGIxNjMwYTRkYTc~)
**部署教程完整版**[**金山文档**](https://www.kdocs.cn/l/csn6eqw93kQZ) [酷安图文](https://www.coolapk.com/feed/38775487?shareKey=YTYyZmUyYjMxMGIxNjMwYTRkYTc~)

精简版[部署步骤](./docs/deployment.md)
部署教程精简版[部署步骤](./docs/deployment.md)

## Update

Expand All @@ -49,11 +53,22 @@
## Notice

- 提供**方法函数模板**[template.py](./template.py)用于大家自行拓展,玩得开心~

- 受vercel.app被ban的限制,**图文展示页**暂不可用,等待官方修复。
- 受企业微信的限制,2022年6月20日后新建应用必须配置企业可信IP,在此之前创建的应用不受此限制。建议使用云服务器或腾讯云函数等IP固定的方式,阿里云、华为云函数暂时均无此功能,可能无法正常运行本项目。

- 受企业微信的限制,2022年6月20日后新建应用必须配置企业可信IP,在此之前创建的应用不受此限制。建议使用**云服务器或腾讯云函数**等IP固定的方式,阿里云、华为云函数暂时均无此功能,可能无法正常运行本项目。

- 受企业微信API限制,超出字数限制部分文字将自动截断不展示。图文展示页面不受此限制,但仍受图片链接长度和文字长度的制约,**请合理安排多地区天气、多日期提醒等内容**
- 腾讯云日志服务CLS将于2022年9月5日开始执行按量计费。请在配置并测试好云函数之后及时前往 **函数管理 - 函数配置** 中关闭日志投递,并在 [日志服务 CLS 控制台](https://console.cloud.tencent.com/cls) - 日志主题 中删除相应日志主题,避免后续产生不必要的费用。
- 所有环境变量均可通过直接修改 **config.py** 完成配置,系统环境变量优先级高于 **config.py**

- 腾讯云日志服务CLS将于2022年9月5日开始执行按量计费。请在配置并测试好云函数之后及时前往 **函数管理 - 函数配置** 中关闭日志投递,并在 **[日志服务 CLS 控制台](https://console.cloud.tencent.com/cls) - 日志主题** 中删除相应日志主题,避免后续产生不必要的费用。

- 所有环境变量均可通过直接修改 config.py 完成配置,系统环境变量优先级高于 config.py 。

- **日期提醒** 会自动排序,越接近的时间越显示在上方,以保证提醒的有效性。

- **和风天气预报** 会根据天气文本信息自动更换对应的天气emoji图标。
- **图文展示页** 来自我的项目 **Diary** —— 基于 Python Fastapi 部署于 Vercel 的简易图文展示,通过URL传递参数实现,不存储任何数据,开源地址 [Github](https://github.com/Thund1R/diary) [Gitee](https://gitee.com/thund1r/diary)

- **图文展示页** 来自我的项目 **Diary** —— 基于 Python Fastapi 部署于 Vercel 的简易图文展示,通过URL传递参数实现,不存储任何数据

开源地址:Github:https://github.com/Thund1R/diary Gitee:https://gitee.com/thund1r/diary

35 changes: 23 additions & 12 deletions config.py
Original file line number Diff line number Diff line change
@@ -1,26 +1,37 @@
import os
SYS_CONFIG = {
# 企业微信机器人配置
# 企业微信企业ID,必填
"corpid": "",
# 企业微信应用Secret,必填
"corpsecret": "",
# 企业微信AgentId,必填
"agentid": "",
# 和风天气key
# 和风天气Key,非必填
"qweather": "",
# 天气预报地址,格式:市-市/县/区,多地址以&&分隔,如:成都-成都&&南京-江宁
# 天气预报地址,非必填
# 格式:市-市/县/区,多地址以&&分隔
# 如:成都-成都&&南京-江宁
"city": "",
# 纪念日名称,每年都有的日子
# 多日期以&&分隔,如:某某某的生日&&结婚纪念日
# 纪念日名称,非必填
# 每年都有的日子,多日期以&&分隔
# 如:某某某的生日&&结婚纪念日
"targetname": "",
# 纪念日日期,公历格式20XX-XX-XX,农历年份前加n
# 多日期以&&分隔,如n2020-08-11&&2021-08-26,注意与名称对应
# 纪念日日期,非必填
# 公历格式20XX-XX-XX,农历年份前加n
# 多日期以&&分隔,注意与名称对应
# 如:n2020-08-11&&2021-08-26
"targetday": "",
# 单日项目名称,只有某一年有的日子
# 多日期以&&分隔,例如跟XX在一起&&某某某出生
# 单日项目名称,非必填
# 只有某一年有的日子,多日期以&&分隔
# 如:跟XX在一起&&某某某出生
"beginname": "",
# 单日日期,公历格式20XX-XX-XX,农历年份前加n
# 多日期以&&分隔,如n2020-08-11&&2021-08-26,注意与名称对应
# 单日日期,非必填
# 公历格式20XX-XX-XX,农历年份前加n
# 多日期以&&分隔,注意与名称对应
# 如:n2020-08-11&&2021-08-26
"beginday": "",
# 图文类型,1为单图文,2为多图文
# 图文类型,非必填
# 1为单图文,2为多图文,默认单图文
"msgtype": ""
}

Expand Down
8 changes: 3 additions & 5 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

新建 / 从头开始 / 事件函数 / 环境 Python3.7 / 内存 64MB / 执行超时时间 900秒 / 填入环境变量 / 网络配置-勾选固定出口IP / 其余配置默认 / 完成

创建完成后跳转导函数配置-网络配置-公网固定IP,填到企业微信应用的企业可信IP中。

### 2. 配置代码

函数代码 / 提交方法 - 在线编辑 / 终端-新终端 / 复制粘贴执行以下命令
Expand All @@ -19,11 +21,7 @@ pip3 install zhdate requests -t .

```

所有命令执行完毕后,点击部署,部署成功后点击测试

第一次测试报错会出现"from ip:xx.xx.xx.xx"即为固定出口IP,将IP填入企业微信-应用管理-配置企业可信IP

再次测试,查看日志输出以及微信消息
所有命令执行完毕后,点击部署,部署成功后点击测试,查看日志输出以及微信消息

配置触发器即可实现每天定时消息推送,例如:0 0 9 * * * *,即早上9:00:00发送消息,具体参考Cron相关文档

Expand Down
4 changes: 2 additions & 2 deletions docs/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## 2022-08-28

得知新建应用要求配置IP的情况,紧急修改部署图文。
在酷安发布完整版部署图文
增加函数模板供用户自行研究拓展
在酷安发布完整版部署图文,不断完善教程
增加函数模板供用户自行探索拓展

## 2022-08-27

Expand Down
2 changes: 1 addition & 1 deletion index.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def get_today():
today_tip = "你好"
if "00:00:00" <= now_time < "06:00:00":
today_tip = "凌晨好~"
if "06:00:00" <= now_time < "09:00:00":
elif "06:00:00" <= now_time < "09:00:00":
today_tip = "早上好"
elif "09:00:00" <= now_time < "12:00:00":
today_tip = "上午好"
Expand Down

0 comments on commit 5f0ecb2

Please sign in to comment.