ProjectHentai/nonebot2

mirror of https://github.com/nonebot/nonebot2.git synced 2024-11-27 18:45:05 +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

yanyongyu a2c1e5fd26 📝 update README		2021-02-08 11:00:11 +08:00
.github	💚 add extra install in document build	2021-02-06 11:15:46 +08:00
archive	📝 archive docs	2021-02-07 23:44:58 +08:00
docs	📝 tweak	2021-02-08 10:27:21 +08:00
docs_build	📝 add index in document for quart driver	2021-02-06 11:15:46 +08:00
nonebot	🔇 remove unused type hint	2021-02-07 23:36:04 +08:00
packages/nonebot-plugin-docs	➕ missing aiofiles dependency for docs plugin	2021-01-18 14:38:08 +08:00
pages	📝 update changelog	2021-02-02 13:13:27 +08:00
tests	Restore .env.dev	2021-02-07 23:36:56 +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	📄 update license	2020-12-01 10:57:00 +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	💚 add extra install in document build	2021-02-06 11:15:46 +08:00
pyproject.toml	🔖 bump version 2.0.0a10	2021-02-07 20:51:09 +08:00
README.md	📝 update README	2021-02-08 11:00:11 +08:00

README.md

NoneBot

✨ Python 异步机器人框架 ✨

文档 · 安装 · 开始使用 · 文档打不开？

简介

NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人收到的事件进行解析和处理，并以插件化的形式，按优先级分发给事件所对应的事件响应器，来完成具体的功能。

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

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

特色

NoneBot2 的驱动框架 Driver 以及通信协议 Adapter 均可自定义，并且可以作为插件进行替换/添加！

目前 NoneBot2 内置的驱动框架：

FastAPI
Quart (异步 flask )

目前 NoneBot2 内置的协议适配：

即刻开始

完整文档可以在这里查看。

懒得看文档？下面是快速安装指南：~~这是坏文明~~

(可选)使用你喜欢的 Python 环境管理工具创建新的虚拟环境。
使用 pip (或其他) 安装 NoneBot 脚手架。
```
pip install nb-cli
```
使用脚手架创建项目
```
nb create
```

插件

此外，NoneBot2 还有丰富的官方以及第三方现成的插件供大家使用：

NoneBot-Plugin-Docs：离线文档至本地使用(别再说文档打不开了！)
```
nb plugin install nonebot_plugin_docs
```
其他插件请查看插件商店

贡献

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

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

许可证

NoneBot 采用 MIT 协议开源，协议文件参考 LICENSE。

特别的，由于 mirai 使用 AGPLv3 协议并要求使用 mirai 的软件同样以 AGPLv3 协议开源，本项目 mirai 适配器部分（即 nonebot/adapters/mirai/ 目录）以 AGPLv3 协议开源，协议文件参考 LICENSE。