ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2024-12-18 09:25:46 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
跨平台 Python 异步聊天机器人框架 / Asynchronous multi-platform chatbot framework written in Python
708 Commits 7 Branches 39 Tags 17 MiB
Python 65.5%
MDX 20.4%
TypeScript 13%
CSS 1%
Shell 0.1%
bc00c1be82
Go to file
yanyongyu bc00c1be82 💡 add message docstring
2020-11-13 17:15:45 +08:00
.github ✏️ fix issue template typo 2020-11-13 11:31:24 +08:00
archive/2.0.0a4 📝 update doc version 2020-11-04 13:41:52 +08:00
docs 💡 add message docstring 2020-11-13 17:15:45 +08:00
docs_build 💡 add message docstring 2020-11-13 17:15:45 +08:00
nonebot 💡 add message docstring 2020-11-13 17:15:45 +08:00
pages 🚧 add plugin store page 2020-10-21 00:55:23 +08:00
tests ✅ add processor test 2020-11-07 18:15:09 +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
.prettierignore ✏️ fix issue template typo 2020-11-13 11:31:24 +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 📝 update plugin store page 2020-11-01 18:21:31 +08:00
package.json 👷 add lint script 2020-11-09 12:46:28 +08:00
poetry.lock 💡 update source docstring #46 #49 2020-11-13 01:46:26 +08:00
pyproject.toml ⬆️ bump version and update dependency 2020-11-04 13:27:49 +08:00
README.md 🚑 restore markdown 2020-10-16 16:08:51 +08:00

README.md

nonebot

NoneBot

✨ Python 异步机器人框架 ✨

license pypi python cqhttp
QQ Chat Telegram Chat QQ Release Telegram Release

文档 · 安装 · 开始使用

简介

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，变量命名清晰，有适当的注释。