Home

Awesome

<div align="center"> Yiri OneBot <br /> <a href="#about"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/YiriMiraiProject/YiriOneBot/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a> · <a href="https://github.com/YiriMiraiProject/YiriOneBot/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a> .<a href="https://github.com/YiriMiraiProject/YiriOneBot/discussions">Ask a Question</a> </div> <div align="center"> <br />

LGPL-v3 Anti-996 License OneBot 11

Pull Requests welcome code with love by YiriMiraiProject

</div>

关于

Yiri OneBot 是一个 OneBot 11 协议上的 Python SDK,延续 YiriMirai 项目轻量级、低耦合的编码风格。

[!Note]

Yiri OneBot 现在经过了全面的重置,现版本的包名是yiriob。官方文档上的内容可能有一定的滞后,我们将会即时更新。

特性

Yiri OneBot 在设计之初便是支持异步并发的,因此你可以用它来编写高性能的机器人应用,或者是开发SaaS应用,并将其用于多个场景之中。

Yiri OneBot 不再mirai-api-http 耦合,而是适用于一切支持 OneBot 11 标准的地方。

Yiri OneBot 的姊妹项目 YiriBot 正在开发,该框架将提供更多适用于聊天机器人开发的高级API插件系统

快速上手

先决条件

你需要拥有一台安装了WindowsLinux操作系统的计算机,并在上方安装Python 3.8 及以上的解释器和Poetry 包管理器。

安装

您可以手动安装:

git clone https://github.com/YiriMiraiProject/YiriOneBot.git
poetry install

当然你也可以通过pip

pip install yiri-onebot

使用

更多详情,请查看 快速上手 - Yiri OneBot Documents

开发路线图

查看 Issues 了解我们的开发计划(和可能的Bug),以及:

获取支持

你可以通过如下方式来获取我们的支持:

帮助我们的开发

如果您想对 Yiri OneBot 的积极开发表示感谢或/和支持:

让我们一起努力,让 Yiri OneBot 变得更好

做出贡献

首先,感谢您抽出时间为我们做出贡献!有了您的贡献,开源社区才能成为学习、启发和创造的好地方。您的任何贡献都将惠及其他人,我们将感激不尽

请阅读我们的贡献指南,并感谢您的参与!

作者和其他贡献者

这个项目最初由 Yiri Mirai Project 的成员 XYCode Kerman 发起。

有关所有作者和贡献者的完整名单,请参阅贡献者页面

安全性

Yiri OneBot 遵循良好的安全惯例,但无法保证 100% 的安全性。

Yiri OneBot 按**"原样 "提供,不提供任何担保**。使用风险自负。

如需了解更多信息和报告安全问题,请参阅我们的安全文档

[!caution]

请勿通过 Issue 或 Discussion 报告安全性问题,你应当将其发送至 security@yiri-mirai.online

许可证

本项目采用 GNU 宽通用公共许可证 v3反 996 许可证 开源,因此使用本项目时,你需要注意以下几点:

  1. 你可以自由的在代码中以import的形式导入并使用 YiriOneBot 提供的功能,而不需要开源你使用 YiriOneBot 编写的业务代码
  2. 如果你对 YiriOneBot 的代码进行了修改,你需要同时发布你修改后的 YiriOneBot
  3. 如果你引用或修改了本库中的代码(包括import本库),你就必须遵守你所在司法管辖区与劳动和就业相关法律、法规、规则和标准。 如果该司法管辖区没有此类法律、法规、规章和标准或其法律、法规、规章和标准不可执行,则你必须遵守国际劳工标准的核心公约
  4. 使用0d8f2f提交以前的代码时,请遵循 AGPL-3.0 协议。
  5. 有关LGPL-3.0许可证的更多详细信息,请参见 GNU 宽通用公共许可证 v3.0 - GNU 工程 - 自由软件基金会
  6. 有关Anti-996许可证的更多详细信息,请参见Anti-996 License Version 1.0996.ICU

虚拟形象

本项目的虚拟形象采用 Stable Diffusion 绘制,原画使用 CounterfeitXL-2.5 绘制,Lora 基于 SD 1.5 及以下版本。

详情可见:[Lora] Yiri - 0.0.1

致谢

在本项目的开发过程中,我们深受开源软件社区的启发和支持。没有这些无私的开源贡献者,我们的项目将无法实现。

首先,我们向所有参与开源项目的开发者表示最诚挚的感谢。是你们的努力和智慧,构建了一个强大、灵活且不断进步的技术生态系统,让我们能够站在巨人的肩膀上,实现创新和突破。

特别感谢PydanticWebsockets库的维护者和贡献者,你们的代码为我们提供了坚实的基础,使我们能够专注于项目的核心功能和创新点。

其次,我们向所有支持和推动开源运动自由软件运动反 996 运动的组织和个人以及致敬。你们的努力让开源不仅仅是一种技术实践,更是一种促进知识共享、协作和创新的文化。

我们相信,开源的力量将继续推动技术的发展和创新,我们期待与开源社区共同成长,为建设一个更加开放和协作的技术世界贡献力量。