butterbot-python 3.1.0.dev1

万物皆可 API / SDK 的机器人框架

Butter-Bot

一个基于 Python 3.12+ 和 asyncio 的事件驱动机器人框架。项目把外部输入抽象为 Source，把数据与状态包装为 Event，再由 EventBus 分发给异步 Handler。

当前仓库内置：

• NapCat OneBot WebSocket 事件与 API；
• Bilibili 动态轮询、直播状态轮询和直播弹幕事件源；
• Source、API、Data、Type 和 Filter 扩展契约；
• 统一启动、回调排空与资源关闭流程。

安装与开发

uv sync --locked --dev

运行完整 Python 检查：

uv run pytest
uv run ruff check .
uv run ruff format --check .
uv run pyright

最小示例

不依赖外部服务的示例：

uv run examples/minimal_source_example.py

预期输出 ready 并正常退出。NapCat 与 Bilibili 示例需要先复制并填写本地配置：

cp examples/config.example.yaml config.yaml

config.yaml 可能包含凭证，已被 Git 忽略，不要提交或公开。

文档

本地启动 VuePress 2 + Plume 文档站：

npm install
npm run docs:dev

推荐入口：

• 安装
• 快速开始
• 核心概念
• 内置功能
• 扩展开发
• API 参考
• 故障排除
• 项目架构
• 贡献指南

生产构建与文档检查：

npm ci
npm run docs:build
npm run docs:lint
npm run docs:links

许可证

GPL-3.0