https://github.com/he0119/nonebot-plugin-wordcloud
适用于 NoneBot2 的词云插件
https://github.com/he0119/nonebot-plugin-wordcloud
nonebot2 plugin
Last synced: about 1 year ago
JSON representation
适用于 NoneBot2 的词云插件
- Host: GitHub
- URL: https://github.com/he0119/nonebot-plugin-wordcloud
- Owner: he0119
- License: mit
- Created: 2022-01-29T09:32:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T23:09:21.000Z (over 1 year ago)
- Last Synced: 2024-10-14T09:44:44.431Z (over 1 year ago)
- Topics: nonebot2, plugin
- Language: Python
- Homepage: https://pypi.org/project/nonebot-plugin-wordcloud/
- Size: 12.5 MB
- Stars: 87
- Watchers: 1
- Forks: 7
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NoneBot Plugin WordCloud
_✨ NoneBot 词云插件 ✨_
## 安装
```shell
nb plugin install nonebot-plugin-wordcloud
```
> **Note**
>
> 如需通过命令设置词云形状，则需使用支持 http 请求的驱动器，如 httpx 和 aiohttp。
>
> 请参考 [配置驱动器](https://nonebot.dev/docs/advanced/driver#%E9%85%8D%E7%BD%AE%E9%A9%B1%E5%8A%A8%E5%99%A8) 文档进行设置。
>
> 例如：
>
> DRIVER=~httpx
>
> DRIVER=~aiohttp
>
> DRIVER=~fastapi+~httpx
## 命令
- 查看帮助
待插件启动完成后，发送 `/词云` 可获取插件使用方法。
- 查看词云
| 功能 | 命令 | 权限 |
| :----------- | :---------- | :----- |
| 查看今日词云 | `/今日词云` | 所有人 |
| 查看昨日词云 | `/昨日词云` | 所有人 |
| 查看本周词云 | `/本周词云` | 所有人 |
| 查看上周词云 | `/上周词云` | 所有人 |
| 查看本月词云 | `/本月词云` | 所有人 |
| 查看上月词云 | `/上月词云` | 所有人 |
| 查看年度词云 | `/年度词云` | 所有人 |
| 查看历史词云 | `/历史词云` | 所有人 |
> 补充： 如果想获取自己的词云，可在上述命令前添加 `我的`，如 `/我的今日词云`。
- 管理词云
| 功能 | 命令 | 权限 | 说明 |
| :----------------------- | ------------------------------------------------------------------ | :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 设置词云形状 | `/设置词云形状` | 超级用户/群主/管理员 | 发送一张图片作为当前群词云形状，每个群各自独立 |
| 删除词云形状 | `/删除词云形状` | 超级用户/群主/管理员 | 删除本群词云形状 |
| 设置词云默认形状 | `/设置词云默认形状` | 超级用户 | 发送一张图片作为所有词云的默认形状，每个群都会改变 |
| 删除词云默认形状 | `/删除词云默认形状` | 超级用户 | 删除默认词云形状，继续使用词云默认的矩形 |
| 开启词云每日定时发送 | `/开启词云每日定时发送` 或
`/开启词云每日定时发送` + `[时间]` | 超级用户/群主/管理员 | 开启本群每日定时发送词云，默认将在每天 `wordcloud_default_schedule_time` 设置的时间发送今日词云，
如果时间没有包含时区信息，则根据 `wordcloud_timezone` 配置项确定时区。
时间的格式为 [ISO 8601](https://docs.python.org/zh-cn/3/library/datetime.html#datetime.time.fromisoformat)，例如：`开启词云每日定时发送 23:59:59` |
| 关闭词云每日定时发送 | `/关闭词云每日定时发送` | 超级用户/群主/管理员 | 关闭本群词云每日定时发送 |
| 查看词云每日定时发送状态 | `/词云每日定时发送状态` | 超级用户/群主/管理员 | 查看定时发送状态 |
## 配置项
配置方式：直接在 NoneBot **全局配置文件（.env）** 中添加以下配置项
| 配置项 | 类型 | 默认值 | 说明 |
| :------------------------------ | --------------------- | :--------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| wordcloud_width | int | `1920` | 生成图片的宽度 |
| wordcloud_height | int | `1200` | 生成图片的高度 |
| wordcloud_background_color | str | `black` | 生成图片的背景颜色 |
| wordcloud_colormap | Union[str, List[str]] | `viridis` | 生成图片的字体 [色彩映射表](https://matplotlib.org/stable/tutorials/colors/colormaps.html)（当值为列表时会随机选择其中之一） |
| wordcloud_font_path | str | 自带的字体（思源黑体） | 生成图片的字体文件位置 |
| wordcloud_stopwords_path | str | None | 结巴分词的 [停用词表](https://github.com/fxsjy/jieba#%E5%9F%BA%E4%BA%8E-tf-idf-%E7%AE%97%E6%B3%95%E7%9A%84%E5%85%B3%E9%94%AE%E8%AF%8D%E6%8A%BD%E5%8F%96) 位置, 用来屏蔽某些词语
例如：`"./wordcloud_extra_dict/stopword.txt"`
表示屏蔽 **stopword.txt** 中的词语，
格式参考 [stop_words.txt](https://github.com/fxsjy/jieba/blob/master/extra_dict/stop_words.txt) |
| wordcloud_userdict_path | str | None | 结巴分词的[自定义词典](https://github.com/fxsjy/jieba#%E8%BD%BD%E5%85%A5%E8%AF%8D%E5%85%B8) 位置 |
| wordcloud_timezone | str | None | 用户自定义的 [时区](https://docs.python.org/zh-cn/3/library/zoneinfo.html)，
留空则使用系统时区，具体数值可参考：[时区列表](https://timezonedb.com/time-zones)，
例如：`Asia/Shanghai` |
| wordcloud_default_schedule_time | str | `22:00` | 默认定时发送时间，当开启词云每日定时发送时没有提供具体时间，
将会在这个时间发送每日词云 |
| wordcloud_options | `Dict[str, Any]` | `{}` | 向 [WordCloud](https://amueller.github.io/word_cloud/generated/wordcloud.WordCloud.html#wordcloud.WordCloud) 传递的参数。
拥有最高优先级，将会覆盖以上词云的配置项，
例如：`{"background_color":"black","max_words":2000,"contour_width":3, "contour_color":"steelblue"}` |
| wordcloud_exclude_user_ids | `Set[str]` | `set()` | 排除的用户 ID 列表（全局，不区分平台），
例如：`["123456","456789"]` |
## 鸣谢
插件依赖 [nonebot-plugin-chatrecorder](https://github.com/MeetWq/nonebot-plugin-chatrecorder) 提供消息存储。
感谢以下开发者作出的贡献：
