nonebot2/README.md
2020-12-22 09:59:48 +08:00

6.0 KiB
Raw Blame History

nonebot

NoneBot

Python 异步机器人框架

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

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

简介

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

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

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

特色

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

目前 NoneBot2 内置的驱动框架:

目前 NoneBot2 内置的协议适配:

即刻开始

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

懒得看文档?下面是快速安装指南:这是坏文明

  1. (可选)使用你喜欢的 Python 环境管理工具创建新的虚拟环境。

  2. 使用 pip (或其他) 安装 NoneBot 脚手架。

    pip install nb-cli
    
  3. 使用脚手架创建项目

    nb create
    

插件

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

  • NoneBot-Plugin-Docs:离线文档至本地使用(别再说文档打不开了!)

    nb plugin install nonebot_plugin_docs
    
  • 其他插件请查看 插件商店

贡献

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

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