Metadata-Version: 2.1
Name: nonebot-plugin-ai-timetable
Version: 0.3.8
Summary: 小爱课程表
Author: maoxiog
Author-email: 674550338@qq.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: httpx (>=0.20.0,<1.0.0)
Requires-Dist: nonebot-plugin-alconna (>=0.40.1,<1.0.0)
Requires-Dist: nonebot-plugin-apscheduler (>=0.2.0,<0.3.0)
Requires-Dist: nonebot-plugin-htmlrender (>=0.2.0,<0.3.0)
Requires-Dist: nonebot2 (>=2.2.0,<3.0.0)
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://v2.nonebot.dev/"><img src="https://v2.nonebot.dev/logo.png" width="200" height="200" alt="nonebot"></a>
</p>
<div align="center">

# nonebot-plugin-ai-timetable

✨*基于Nonebot2的对接小爱课程表的插件*✨
  
<a href="https://github.com/nonebot/nonebot2">
  <img src="https://img.shields.io/badge/nonebot-v2-red" alt="nonebot">
</a> 
<a href="./LICENSE">
    <img src="https://img.shields.io/github/license/maoxig/nonebot-plugin-ai-timetable" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-ai-timetable">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-ai-timetable" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">

<div align="left">

## 💿安装

1. 通过`pip`或`nb`安装；
    - 使用nb(极度推荐)
  
       在机器人目录下命令行使用`nb plugin install nonebot_plugin_ai_timetable`

    - 使用pip:
  
      `pip plugin install nonebot_plugin_ai_timetable`

      然后在机器人`pyproject.toml`里的`plugins = []`列表追加`"nonebot_plugin_ai_timetable"`

2. 本地数据保存在`data/ai_timetable/userdata.json`以及`data/ai_timetable/usertable.json`，分别对应用户发送的链接和本地保存的课表

## 📖简介

1. 傻瓜式一键导入小爱课表，让你的bot实现小爱课表的功能

2. 用户课表数据隔离，无需担心课程时间冲突、不同学校课表不同等问题

3. 适配多平台，即使是电报涩涩群也要好好学习！🥵🥵

## ⚙️插件配置

这些配置都已设好默认值，如果想要修改配置，在机器人目录下的.env.*里面可以填写以下选项(可选)

|         config          | type  | default |          example           | usage                                                                                                 |
| :---------------------: | :---: | :-----: | :------------------------: | :---------------------------------------------------------------------------------------------------- |
|      TIMETABLE_PIC      | bool  |  true   |    TIMETABLE_PIC=false     | 可选择某日课表以图片/文字发送，默认以图片发送(true)                                                   |
| TIMETABLE_ALOCK_SOMEDAY |  int  |   22    | TIMETABLE_ALOCK_SOMEDAY=15 | 订阅某日课表的发送时间，必须是0-24的数字                                                              |
|    TIMETABLE_ALOCK_8    |  int  |   21    |    TIMETABLE_ALOCK_8=16    | 订阅早八的发送时间，必须是0-24的数字.这里发送的都是第二天的，所以建议设置为18-23点                    |
|   TIMETABLE_SEND_TIME   | float |   0.5   |   TIMETABLE_SEND_TIME=1    | 订阅课程提前发送的时间，单位是`小时`，可以是整数也可以是小数，建议不要设的太大，避免出现无法预料的bug |

## 💿依赖

```python
nb plugin install nonebot_plugin_htmlrender
nb plugin install nonebot_plugin_apscheduler
nb plugin install nonebot_plugin_alconna
```
## 🌙更新日志

<details>
<summary>点击展开</summary>

- 0.3.7 / 2024-04-24:
   1. 更新Nonebot2版本至2.2.0
   2. 基于 [nonebot-plugin-alconna](https://github.com/nonebot/plugin-alconna) 适配多平台
   3. 放宽httpx限制，移除onebot依赖

- 0.3.6 / 2023-09-02:
   1. 适配nonebot2.0.1版本：移除过时的RegexMatch方法
   >如更新本插件后接受消息无响应，请更新你的nonebot版本或回退到旧版本使用

- 0.3.5 / 2023-08-10:
   1. 格式化代码
   2. 优化配置读取
   3. 更新插件元数据

- 0.3.5 / 2023-06-09:
   1. 更新httpx依赖版本

- 0.3.3 / 2023-04-23:
   1. 修复定时提醒重复发送的bug
   2. 修改帮助

- 0.3.2 / 2023-04-14:
   1. 删去了文本中所有奇怪的口癖喵
   2. 修复了订阅课程发送时间错误的bug

- 0.3.0 / 2023-04-02:
   1. 修复bug
   2. 优化帮助图片
   3. 定时任务随机延后0-60s，防止风控
   4. 增加订阅指定课程的功能

- 0.2.3 / 2023-03-29:
   1. 重构了代码，优化了许多地方~~真的累死了~~
   2. 修复了一些bug，优化了体验
   3. 增加了早八|明日早八的查询
   4. 更新版本后建议重新`导入课表`，避免出现某些bug

- 0.2.1 / 2023-03-13:
   1. 修复订阅早八的一些bug

- 0.2.0 / 2023-03-11:
   1. 修复了如果未登录小米账户就分享课表时的报错，增加错误提示
   2. 新增3项配置项，某日课表可选择以图片发送（默认为图片）

- 0.1.8 / 2023-03-08:
   1. 修改部分代码，优化课表格式
   2. 修复了节数为11的课会排在节数为2的课程前面的bug(QAQ太蠢了别骂了别骂了)

- 0.1.7 / 2023-03-07:
   1. 修复了时间不会自己改变的bug
   2. 新增了上课/下节课功能
   3. 优化了一些屎山代码

- 0.1.5 / 2023-03-06:
   1. 新增了私聊订阅课表|早八的功能

- 0.1.4 / 2023-03-05:
   1. 修复了无法取消订阅早八的bug

</details>

## 🎉命令

1. 我的课表|小爱课表|本周课表|下周课表：获取本周|下周的完全课表，使用前须先导入课表，这里的课表是在线课表

2. 导入课表：需要有小爱课表分享出来的链接，打开小爱课程表，手动添加课程或从教务导入(已适配了大部分高校)课程后

    ![Image text](https://github.com/maoxig/nonebot-plugin-ai-timetable/blob/main/resource/export.jpg)

    在基本设置里把开始上课时间等调整好之后(尤其是时间、节数)，把分享课表得到的链接发送给bot即可导入本地(分享前需要登录小米账户 [#1](https://github.com/maoxig/nonebot-plugin-ai-timetable/issues/1))

3. 更新课表；如果在小爱课程表里修改了课程，发送该条指令即可更新本地的课表，无需重新导入
  
4. (昨天|今天|明天|后天|周X|星期x|)(课表|有啥课|上啥课)：查询指定天的课表，其中查询周x课表查询的是本周的

5. 订阅|取消订阅某天课表：导入本地课表后，发送订阅xx课表，如`订阅周一课表`，就可以在这天的前一天晚上10点(可修改)定时推送第二天要上的课

6. 订阅|取消订阅早八：会让bot在前一天晚上9点(可修改)提醒你第二天是否有早八，以便决定今晚是否嗨皮（判定依据是是否存在第一节课）

7. 订阅|取消订阅课程 xxx：订阅课程后，会让bot在所有名称里包含xxx的课程开始前0.5小时(可修改)发送提醒，如订阅课程 数学分析，则数学分析和数学分析习题课的课前0.5小时会自动发出提醒

8. 上课|下节课：获取当前上课信息，返回下节课信息(如果有)

9. 早八|明日早八：查询明天的早八

10. 课表帮助：获取课表帮助

未完待续

## ⭐效果图

![Image text](https://github.com/maoxig/nonebot-plugin-ai-timetable/blob/main/resource/my_table.jpg)
![Image text](https://github.com/maoxig/nonebot-plugin-ai-timetable/blob/main/resource/alock_8.jpg)
![Image text](https://github.com/maoxig/nonebot-plugin-ai-timetable/blob/main/resource/next_class.jpg)
![Image text](https://github.com/maoxig/nonebot-plugin-ai-timetable/blob/main/resource/someday_classes.jpg)
![Image text](https://github.com/maoxig/nonebot-plugin-ai-timetable/blob/main/resource/someday_classes_pic.jpg)

### 关于小爱课程表内的一些说明

如下图

- 首先要登录上小米账户,否则可能获取到错误的课表信息 [#1](https://github.com/maoxig/nonebot-plugin-ai-timetable/issues/1)
- 设置好开始上课时间
- 设置好课程时间，可以修改每节课具体的时间，
- 课表节数按自己需求调，一般教务导入的课表节数可能不符合实际，需要微调
- 每周起始日建议默认的周一即可（周日起始没测试过可能有bug）
- 如果导入课表后在小爱课表内修改了课程，直接给bot发送更新课表即可更新本地课表
- 当你主页的课表和学校课表基本一致时，那么小爱课程表就被调教好了，可以导入了

![Image text](https://github.com/maoxig/nonebot-plugin-ai-timetable/blob/main/resource/settings.jpg)

## 🐦计划

- [x] 查询下节课的信息

- [x] 可选择是否发送图片以避免风控

- [x] 增加更多的配置项

- [x] 重构代码

- [x] 订阅指定的课

- [x] 多平台适配, 基于 [nonebot-plugin-alconna](https://github.com/nonebot/plugin-alconna) 

- [ ] 支持定时任务本地存储

- [ ] 适配[plugin-rom](https://github.com/nonebot/plugin-orm), 接入数据库

- [ ] 适配更多课表、脱离小爱课表

- [ ] 完善插件

## 🐛存在的问题

 1. 小爱课表分享的链接大概2周后会过期，会使得`我的课表\下周课表`无法使用，需要重新分享，但是仍能使用本地课表，也可以更新本地课表

 2. 机器人重启后定时任务会丢失

## 喜欢的话就点个star✨吧QAQ

