ProjectHentai/nonebot2

mirror of https://github.com/nonebot/nonebot2.git synced 2024-11-24 00:55:07 +08:00

跨平台 Python 异步聊天机器人框架 / Asynchronous multi-platform chatbot framework written in Python

bot chatbot cqhttp dingtalk-robot fastapi lark-bot mirai-bot nonebot nonebot2 onebot python qq qq-guild telegram-bot

Go to file

Ju4tCode c3bd8ebf57 🚧 change result store		2020-10-28 13:45:54 +08:00
.github	👷 Add release draft config	2020-10-20 17:28:51 +08:00
archive/2.0.0a3	📝 Update docs	2020-10-11 13:17:40 +08:00
docs	💡 add plugin docstring	2020-10-18 15:04:45 +08:00
docs_build	💡 add plugin docstring	2020-10-18 15:04:45 +08:00
nonebot	🚧 change result store	2020-10-28 13:45:54 +08:00
tests	🐛 fix nickname	2020-10-06 22:29:05 +08:00
.editorconfig	🏷️ Add typing for cqhttp api	2020-08-26 17:47:36 +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-lock.json	👽 fix home link	2020-10-18 15:34:14 +08:00
package.json	➕ use custom theme	2020-10-18 01:39:34 +08:00
poetry.lock	📌 update lock file	2020-10-11 13:39:45 +08:00
pyproject.toml	🔖 Pre Release 2.0.0a3	2020-10-11 13:19:20 +08:00
README.md	🚑 restore markdown	2020-10-16 16:08:51 +08:00

README.md

NoneBot

✨ Python 异步机器人框架 ✨

文档 · 安装 · 开始使用

简介

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

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

目前 NoneBot2 在 FastAPI 的基础上封装了与 CQHTTP(OneBot) 协议插件的网络交互。

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

需要注意的是，NoneBot 仅支持 Python 3.7+ 及 CQHTTP(OneBot) 插件 v11+。

此外，NoneBot2 还有可配套使用的额外脚手架/框架：

文档

文档目前尚未完成，「API」部分由 sphinx 自动生成，你可以在这里查看。

贡献

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

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