This plugin can remind you not to forget something
Project description
这是一个 nonebot2 插件库, 主要用来提醒大家别忘记什么事情,可以看成定时提醒插件。
指令
定时 [date]→ 设置定时提醒,date为时间,格式为HH:MM,如 23:59, 不设置默认为17点 定时请求[date]→ 设置定时请求某个URL,返回其内容,目前只能请求图片,date为时间,格式为HH:MM,如 23:59, 不设置默认为17点 定时列表 → 列出所有定时提醒 清空|清除定时 → 清空所有定时提醒 开启|关闭|删除|执行定时提醒 [id] → 开启|关闭|删除|执行指定id的定时提醒 修改|更新定时 [id] → 修改指定id的定时提醒
-
定时提醒
: 在默认时间定时提醒定时提醒 [时间]
: 在指定时间定时提醒时间格式为 HH:MM , 例如 17:00
之后 Bot 会询问提醒的时间间隔
1.每天 回复1
2.某天回复具体日期,格式为yyyy-mm-dd,如2023-01-03
3.工作日 回复3
回复数字即可
再之后 Bot 会询问需要提醒的内容 默认为
打卡!!
, 回复0即使默认内容 -
定时请求
:与上面用法类似 -
定时列表
: 列出设置的所有定时任务 -
清空/清除定时
: 清除的所有定时任务 -
删除/开启/关闭/执行定时 [id]
: 删除/开启/关闭指定id的定时任务 -
定时请求
: 定时请求数据,目前支持图片 -
定时jobs
: 列出底层任务情况(debug使用)
配置项
配置方式:直接在 NoneBot 全局配置文件中添加以下配置项即可。
NoneBot 配置相关教程详见 配置 | NoneBot
如果需要持久化定时任务(即nonebot2重启后任务还在),需要配置
nonebot-plugin-apscheduler
插件。在
.env
中加上apscheduler_config={ "apscheduler.timezone": "Asia/Shanghai", "apscheduler.jobstores.default":{"type":"sqlalchemy","url":"sqlite:///jobs.sqlite"} }
进入到nonebot的安装目录,执行
source .venv/bin/activate
,进入虚拟环境执行
pip install sqlalchemy
安装sqlalchemy。(不知道为什么nonebot-plugin-apscheduler
插件没有包含这个库) 重启nonebot2,即可持久化定时任务。
reminder_default_hour
- 类型: int
- 默认: 17
REMINDER_DEFAULT_HOUR=17
reminder_default_minute
- 类型: int
- 默认: 0
REMINDER_DEFAULT_MINUTE=0
reminder_id_len
- 类型: int
- 说明:底层任务id长度
- 默认: 5
REMINDER_ID_LEN=5
reminder_id_prefix
- 类型: str
- 说明:底层任务id的前缀
- 默认: 0
REMINDER_ID_PREFIX=reminder
依赖
nonebot-plugin-apscheduler
: 使用定时发送功能nonebot-plugin-localstore
: 使用存储功能
致谢
代码基于 nonebot-plugin-everyday-en,感谢原作者的开源精神!
其他
修改定时的时候,userId(QQ号)表示需要回复定时消息给谁,私聊的时候就是自己本人,群聊的时候就是@机器人的那个群友。类似的,groupId表示群号,让机器人可以知道回复到哪个群。
这里有三种情况:
- userId > 0,groupId > 0,表示定时任务出发之后@群中的某个群友回复
- userId > 0,groupId < 0,表示定时任务出发之后私聊某个人回复
- userId < 0,groupId > 0,表示定时任务出发在群直接回复,不@群友
开源许可
- 本插件使用
MIT
许可证开源
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nonebot_plugin_reminder-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8a5ee2e1f5f8861ea2d97ffce0226dea48a25728908a611048855e2a3150508 |
|
MD5 | 640c4b9f6b49876863cc483081ceda3b |
|
BLAKE2b-256 | cb348466150fa6c6c7e11ac115e5966c3481d3c5dbea2b816bae6f772f29fa26 |
Hashes for nonebot_plugin_reminder-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d0005dc179b3498e0c9cc39ecb1771cc3c8a19d1b81bdbb5ffe58f7728e033b |
|
MD5 | b02ed1c9bd4b33280c5ad2905314e647 |
|
BLAKE2b-256 | 4206c27a12b84eb75c0dfc37916c85f461440ce446744dcb7d38b6f854288bc7 |