Skip to main content

melobot

支持多协议、多路 IO 与其他高级特性的机器人开发框架

license - BSD-3-Clause license - CC-BY-SA-4.0 melobot docs GitHub Repo stars

Made with Python PyPI

uv - Managed Checked with mypy

🔄 工作计划

melobot v3 现已发布。支持各种协议以扩展至各种平台提供机器人服务。

v3 目前可用的协议实现:

  • OneBot(melobot 内置支持,但尚未支持 v12 版本)
  • Console(melobot 内置支持,跨平台的控制台输入输出协议)

其他计划支持的协议:

  • qq 官方协议
  • ...

有任何对 melobot 项目的意见或建议,欢迎加入 qq 群与我们讨论:1092245892

⚠️ 声明

melobot 是由热爱技术的开发者共同维护的开源项目。我们致力于提供一个可靠、高效的软件工具,以促进技术交流和创新。以下简称 melobot 项目为“本项目”。

本项目严禁用于任何非法目的,包括但不限于侵犯版权、商标、商业机密或其他知识产权,以及违反任何适用的法律和法规。我们不对因非法使用本项目而产生的任何直接、间接、附带、特殊、惩罚性或后果性损害承担责任。

🎉 特色

melobot v3 是跨平台、跨协议、支持多路 IO 及其他高级特性的 bot 开发框架。为什么选择 melobot?因为 melobot 更自由、优雅和强大:

特性 描述
实用接口 封装高频使用的异步逻辑,使业务开发更简洁
插件管理 低耦合度、无序的插件加载与通信
处理流设计 可自由组合“处理中间件”为处理流,提升了各组件的复用率
热插拔/重启 处理流支持动态热插拔,支持 bot 级别的重启
会话支持 可在处理流中自动传递的、可自定义的会话上下文
协议支持 所有协议被描述为 IO 过程,因此支持各类协议
跨平台 更简洁的跨平台接口,便捷实现跨平台插件开发
跨协议 IO 支持多个协议实现端同时输入,自由输出到指定协议实现端
日志支持 日志记录兼容标准库和绝大多数日志框架,可自行选择

使用本框架的机器人项目如下:

你可以将这些项目作为 melobot 使用的实例参考。欢迎你基于 melobot 实现完整的机器人项目后,向本文档提出 PR,在此处展示。

💬 文档

项目文档:melobot 文档

对于文档可能出现的纰漏,恳请各位包涵。欢迎提出修正和优化文档的 PR:文档源文件

📦️ 安装使用

Python 版本需求:>= 3.10

如果您对 melobot 完全不熟悉,建议配合文档开始学习。文档以 OneBot v11 协议为例,通过以下命令安装文档教程中必需的组件:

pip install "melobot[onebot]"
# 或
uv pip install "melobot[onebot]"

如果您对 melobot 已经十分了解,请自由地安装核心 + 任何可选依赖。

也可以通过源码构建:(对于普通用户不推荐)

本项目使用 uv 管理,你首先需要安装 uv

git clone https://github.com/meloland/melobot.git
cd melobot
uv venv -p 3.10
uv sync --all-extras --all-groups
uv build

之后可在 dist 目录获取本地构建轮子,安装即可。

💻 其他文档

想要参与开发或报告安全问题?看看这些:

贡献指南与行为准则:

安全政策:

📜 开源许可

本项目使用双许可证。

docs 目录内除 melobot 项目 logo,所有内容在 CC-BY-SA-4.0 许可下发行。此部分版权主体为:melobot 文档的所有贡献者

docs 目录外所有内容在 BSD 3-Clause 许可下发行。此部分版权主体为:melobot 项目代码的所有贡献者

此外本项目使用了部分开源项目的源代码,参阅:THIRD-PARTY-NOTICES

❤️ 鸣谢

PyCharm 是一款流行的、强大的、适用于数据科学与 Web 开发的 Python IDE。

特别感谢由 JetBrains 提供的 PyCharm 等相关软件/程序的免费授权许可证。这些软件/程序用于本项目的开发与 IDE 兼容性测试。

PyCharm logo.

✨ 项目动态

贡献者

感谢每一位贡献者的付出,melobot 因你们而变得更好 ow<

星标历史

melobot Star Chart

Metadata

Release files for melobot 3.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for melobot 3.5.0
File Size Uploaded
melobot-3.5.0.tar.gz 2.4 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for melobot 3.5.0
File Interpreter ABI Platform
melobot-3.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 2.6 MB

Release files / melobot-3.5.0.tar.gz

Download URL melobot-3.5.0.tar.gz
Size 2.4 MB
Tags Source
SHA-256 checksum
How to use checksums
718e2b7a5607cda2f3b1a0d74861f84c35d04c29d04319946a36c45f7b6af35c
BLAKE2b-256 checksum
How to use checksums
ad9fcff6bc21b4e4945fd498b0f96db176d301e3f10f699f4bada247e757dd26
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.6.9

Release files / melobot-3.5.0-py3-none-any.whl

Download URL melobot-3.5.0-py3-none-any.whl
Size 200.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7cf56ca8e478cd577b19b28860ae42f52e008318405b83e0fb69710c14be8ae1
BLAKE2b-256 checksum
How to use checksums
86fc8425b01b68bd5961d11dae8113ac86033a7e244372193f1586eb108faabc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.6.9

Release history Release notifications | RSS feed

This release

3.5.0 This release

2 release files

3.4.0

2 release files

3.3.0

2 release files

3.2.2

2 release files

3.2.1

2 release files

3.2.0

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.6.5

2 release files

2.6.4

2 release files

2.6.3

2 release files

2.6.2

2 release files

2.5.14

2 release files

2.5.13

2 release files

2.5.12

2 release files

2.5.11

2 release files

2.5.9

2 release files

2.5.8

2 release files

2.5.7

2 release files

2.5.6

2 release files

2.5.5

2 release files

2.5.0

2 release files

2.4.9

2 release files

2.4.8

2 release files

2.4.7

2 release files

2.4.5

2 release files

2.4.4

2 release files

2.4.2

2 release files

2.3.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page