ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2024-11-24 09:05:04 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
跨平台 Python 异步聊天机器人框架 / Asynchronous multi-platform chatbot framework written in Python
493 Commits 5 Branches 39 Tags 19 MiB
Python 65.4%
MDX 20.3%
TypeScript 13.1%
CSS 1%
Shell 0.1%
c4a5cfb513
Go to file
yanyongyu c4a5cfb513 change plugin load
2020-08-15 17:22:10 +08:00
docs change event 2020-08-11 16:54:45 +08:00
docs_build change coolq into cqhttp 2020-08-06 17:19:06 +08:00
nonebot change plugin load 2020-08-15 17:22:10 +08:00
tests change plugin load 2020-08-15 17:22:10 +08:00
.editorconfig clean up files 2020-06-24 21:57:15 +08:00
.gitignore add fastapi driver, config 2020-07-04 22:51:10 +08:00
.style.yapf clean up files 2020-06-24 21:57:15 +08:00
LICENSE Change license to MIT 2018-06-29 22:54:24 +08:00
package.json add autodoc support 2020-06-30 12:10:57 +08:00
poetry.lock change rule 2020-08-14 17:41:24 +08:00
pyproject.toml fix config and import nonebot-test 2020-08-13 18:18:00 +08:00
README.md update README.md 2020-08-11 17:02:29 +08:00

README.md

NoneBot

License PyPI Python Version CQHTTP Version QQ 群 Telegram QQ 版本发布群 Telegram 版本发布频道

简介

NoneBot 是一个基于 酷 Q 的 Python 异步 QQ 机器人框架，它会对 QQ 机器人收到的消息进行解析和处理，并以插件化的形式，分发给消息所对应的命令处理器和自然语言处理器，来完成具体的功能。

除了起到解析消息的作用，NoneBot 还为插件提供了大量实用的预设操作和权限控制机制，尤其对于命令处理器，它更是提供了完善且易用的会话机制和内部调用机制，以分别适应命令的连续交互和插件内部功能复用等需求。

NoneBot 在其底层与 酷 Q 交互的部分使用 python-aiocqhttp 库，后者是 CQHTTP 插件 的一个 Python 异步 SDK，在 Quart 的基础上封装了与 CQHTTP 插件的网络交互。

得益于 Python 的 asyncio 机制，NoneBot 处理消息的吞吐量有了很大的保障，再配合 CQHTTP 插件可选的 WebSocket 通信方式（也是最建议的通信方式），NoneBot 的性能可以达到 HTTP 通信方式的两倍以上，相较于传统同步 I/O 的 HTTP 通信，更是有质的飞跃。

需要注意的是，NoneBot 仅支持 Python 3.7+ 及 CQHTTP 插件 v4.8+。

示意图

文档

文档目前「指南」和「API」部分已经完成，「进阶」部分尚未完成，你可以在 这里 查看。

贡献

如果你在使用过程中发现任何问题，可以 提交 issue 或自行 fork 修改后提交 pull request。

如果你要提交 pull request，请确保你的代码风格和项目已有的代码保持一致，遵循 PEP 8，变量命名清晰，有适当的注释。