ErisPulse 2.3.5.dev2__tar.gz → 2.3.6__tar.gz

{erispulse-2.3.5.dev2 → erispulse-2.3.6}/LICENSE

@@ -1,8 +1,6 @@
 MIT License
 
-Copyright (c) 2025 ErisPulse
-
-Portions of this software are based on https://github.com/runoneall/sdkFrame.
+Copyright (c) 2025-2026 ErisPulse
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -21,17 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-
-This SDK's core adapter standardization layer strictly follows OneBot12 specifications (https://12.onebot.dev/) for:
-- Event data normalization
-- API request/response formats
-- Message segment definitions
-- Metadata definitions
-
-This ensures consistent behavior and interoperability across all adapter implementations.
-
-We extend our gratitude to all developers and authors who contribute to the open-source community.
-
-Please respect the efforts of every open-source author. By using, modifying, or distributing this software, you commit to strictly adhering to the relevant license terms and preserving all original copyright notices.
-
-The core of the open-source spirit lies in sharing, collaboration, and respect. Through this project, we hope to carry forward this spirit and contribute to the development of the open-source community.

{erispulse-2.3.5.dev2 → erispulse-2.3.6}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 2.3.5.dev2
+Version: 2.3.6
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>
+Maintainer-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>
 License: MIT License
         
-        Copyright (c) 2025 ErisPulse
-        
-        Portions of this software are based on https://github.com/runoneall/sdkFrame.
+        Copyright (c) 2025-2026 ErisPulse
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
@@ -26,22 +25,10 @@ License: MIT License
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-        
-        This SDK's core adapter standardization layer strictly follows OneBot12 specifications (https://12.onebot.dev/) for:
-        - Event data normalization
-        - API request/response formats
-        - Message segment definitions
-        - Metadata definitions
-        
-        This ensures consistent behavior and interoperability across all adapter implementations.
-        
-        We extend our gratitude to all developers and authors who contribute to the open-source community.
-        
-        Please respect the efforts of every open-source author. By using, modifying, or distributing this software, you commit to strictly adhering to the relevant license terms and preserving all original copyright notices.
-        
-        The core of the open-source spirit lies in sharing, collaboration, and respect. Through this project, we hope to carry forward this spirit and contribute to the development of the open-source community.
 License-File: LICENSE
-Classifier: Development Status :: 5 - Production/Stable
+Keywords: async,asyncio,bot,extensible,framework,modular,onebot,robot,sdk,telegram
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -51,63 +38,156 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: aiohttp
-Requires-Dist: colorama
+Requires-Dist: aiohttp>=3.9.0
 Requires-Dist: fastapi>=0.116.1
 Requires-Dist: hypercorn>=0.14.0
 Requires-Dist: packaging>=25.0
-Requires-Dist: pip
-Requires-Dist: pydantic>=2.10.6
-Requires-Dist: python-multipart>=0.0.20
-Requires-Dist: rich
-Requires-Dist: toml
-Requires-Dist: watchdog
+Requires-Dist: pip>=23.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: toml>=0.10.2
+Requires-Dist: watchdog>=4.0.0
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
+Requires-Dist: pytest-mock>=3.10.0; extra == 'test'
+Requires-Dist: pytest-xdist>=3.0.0; extra == 'test'
+Requires-Dist: pytest>=7.0.0; extra == 'test'
 Description-Content-Type: text/markdown
 
-# ErisPulse - 异步机器人开发框架
+<table>
+<tr>
+<td width="35%" valign="middle" align="center">
+<img src=".github/assets/erispulse_logo_1024.png" width="280" alt="ErisPulse" />
+</td>
+<td width="65%" valign="middle">
+
+# ErisPulse
 
-![ErisPulse Logo](.github/assets/erispulse_logo.png)
+**事件驱动的多平台机器人开发框架**
 
 [![PyPI](https://img.shields.io/pypi/v/ErisPulse?style=flat-square)](https://pypi.org/project/ErisPulse/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/ErisPulse?style=flat-square)](https://pypi.org/project/ErisPulse/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Socket Badge](https://socket.dev/api/badge/pypi/package/ErisPulse/latest)](https://socket.dev/pypi/package/ErisPulse)
 
-ErisPulse 是一个事件驱动的多平台机器人开发框架。通过统一的适配器系统和标准化事件模型，让模块一次编写，即可在多个平台运行。
+</td>
+</tr>
+</table>
+
+---
+
+## 简介
+
+ErisPulse 是一个基于 Python 的事件驱动型多平台机器人开发框架。通过统一的 OneBot12 标准接口，您可以一次编写代码，同时在云湖、Telegram、OneBot 等多个平台部署相同功能的机器人。框架提供灵活的模块(`插件`)系统、热重载支持和完整的开发者工具链，适用于从简单聊天机器人到复杂自动化系统的各种场景。
+
+## 核心特性
+
+- **事件驱动架构** - 基于 OneBot12 标准的清晰事件模型
+- **跨平台兼容** - 插件模块编写一次即可在所有平台使用
+- **模块化设计** - 灵活的插件系统，易于扩展和集成
+- **热重载支持** - 开发时无需重启即可重新加载代码
+- **完整工具链** - 提供 CLI 工具、包管理和自动化脚本
+
+## 快速开始
+
+### 安装
+
+```bash
+pip install ErisPulse
+
+# 国内镜像
+pip install -i https://pypi.tuna.tsinghua.edu.cn/simple ErisPulse
+
+# 使用 `uv` 安装
+uv install ErisPulse
+```
+> 如果您的 Python 版本低于 3.10，可以使用一键安装脚本自动配置环境。详见 [安装脚本说明](scripts/install/)。
+
+### 初始化项目
+
+```bash
+# 交互式初始化
+epsdk init
+
+# 快速初始化（指定项目名称）
+epsdk init -q -n my_bot
+```
+
+### 创建第一个机器人
+
+创建 `main.py` 文件：
+
+<table>
+<tr>
+<td width="50%" valign="top">
+
+**命令处理器**
 
 ```python
-import asyncio
 from ErisPulse import sdk
 from ErisPulse.Core.Event import command
 
-# 注册命令 - 一次编写，多平台运行
-@command("hello")
-async def hello(event):
-    await event.reply("你好！来自 ErisPulse")
+@command("hello", help="发送问候消息")
+async def hello_handler(event):
+    user_name = event.get_user_nickname() or "朋友"
+    await event.reply(f"你好，{user_name}！")
+
+@command("ping", help="测试机器人是否在线")
+async def ping_handler(event):
+    await event.reply("Pong！机器人运行正常。")
 
-# 启动框架
-asyncio.run(sdk.run(keep_running=True))
+if __name__ == "__main__":
+    import asyncio
+    asyncio.run(sdk.run(keep_running=True))
 ```
 
-## 核心特性
+</td>
+<td width="50%" valign="top">
+
+**效果说明**
+
+发送 `/hello`
+
+机器人回复：`你好，{用户名}！`
+
+---
 
-- **事件驱动** - 基于 OneBot12 标准的清晰事件模型
-- **一次编写，全平台运行** - 插件模块编写一次即可在所有平台使用
-- **模块化设计** - 灵活的插件系统，易于扩展开发
-- **热重载** - 支持热重载，无需重启即可reload系统
+发送 `/ping`
+
+机器人回复：`Pong！机器人运行正常。`
+
+---
+
+**运行方式**
+
+```bash
+epsdk run main.py
+# 或开发模式
+epsdk run main.py --reload
+```
+
+</td>
+</tr>
+</table>
+
+更多详细说明请参阅：
+- [快速开始指南](docs/quick-start.md)
+- [入门指南](docs/getting-started/)
 
 ## 应用场景
 
 - **多平台机器人** - 在多个平台部署相同功能的机器人
-- **聊天助手** - 接入自己的AI聊天模块，实现娱乐、交互机器人
+- **聊天助手** - 接入 AI 聊天模块，实现娱乐和交互
 - **自动化工具** - 消息通知、任务管理、数据收集
 - **消息转发** - 跨平台消息同步和转发
-> 你还能做更多更多，多到没有想象的边界 www
 
 ## 支持的适配器
-> 也欢迎你贡献适配器 TwT~
+
+欢迎您贡献适配器！
 
 - [云湖](https://github.com/ErisPulse/ErisPulse-YunhuAdapter) - 企业级即时通讯平台（机器人账户）
 - [云湖用户](https://github.com/wsu2059q/ErisPulse-YunhuUserAdapter) - 基于云湖用户账户的适配器
@@ -117,7 +197,7 @@ asyncio.run(sdk.run(keep_running=True))
 - [邮件](https://github.com/ErisPulse/ErisPulse-EmailAdapter) - 邮件收发处理
 - [沙箱](https://github.com/ErisPulse/ErisPulse-SandboxAdapter) - 网页调试界面，无需接入实际平台
 
-> 查看[适配器详情介绍](docs-new/platform-guide/README.md)
+查看 [适配器详情介绍](docs/platform-guide/README.md)
 
 ## 文档资源
 
@@ -126,81 +206,28 @@ asyncio.run(sdk.run(keep_running=True))
 | 文档 | [erisdev.com](https://www.erisdev.com/#docs) | [Cloudflare](https://erispulse.pages.dev/#docs) • [GitHub](https://erispulse.github.io/#docs) • [Netlify](https://erispulse.netlify.app/#docs) |
 | 模块市场 | [erisdev.com](https://www.erisdev.com/#market) | [Cloudflare](https://erispulse.pages.dev/#market) • [GitHub](https://erispulse.github.io/#market) • [Netlify](https://erispulse.netlify.app/#market) |
 
-## 快速开始
-
-### 一键安装脚本
-
-#### Windows (PowerShell):
-
-```powershell
-irm https://get.erisdev.com/install.ps1 -OutFile install.ps1; powershell -ExecutionPolicy Bypass -File install.ps1
-```
-
-#### macOS/Linux:
-
-```bash
-curl -sSL https://get.erisdev.com/install.sh | tee install.sh >/dev/null && chmod +x install.sh && ./install.sh
-```
-
-## 开发与测试
-
-### 克隆项目
-
-```bash
-git clone -b Develop/v2 https://github.com/ErisPulse/ErisPulse.git
-cd ErisPulse
-```
-
-### 环境搭建
-
-使用 `uv` 同步项目环境：
-
-```bash
-uv sync
-# 激活虚拟环境: source .venv/bin/activate (macOS/Linux) 或 .venv\Scripts\activate (Windows)
-```
-
-> 提示：ErisPulse 使用 Python 3.13 开发，兼容 Python 3.10+
-
-**快速开始**：[快速开始指南](docs-new/quick-start.md) | [入门指南](docs-new/getting-started/)
-
-## 项目结构
-
-```
-ErisPulse/
-├── src/
-│   └── ErisPulse/           # 核心源代码
-│       ├── Core/            # 核心模块
-│       │   ├── Bases/       # 基础类定义
-│       │   ├── Event/       # 事件系统
-│       │   └── ...          # 其他核心组件
-│       └── __init__.py      # SDK入口点
-├── examples/                # 示例代码
-├── devs/                    # 开发工具
-├── docs/                    # 文档
-├── tests/                   # 测试代码
-├── scripts/                 # 脚本文件
-└── config.toml              # 默认配置文件
-```
-
 ## 贡献指南
 
-我们欢迎各种形式的贡献，包括但不限于:
+我们欢迎各种形式的贡献，包括但不限于：
 
-1. 报告问题  
-   在 [GitHub Issues](https://github.com/ErisPulse/ErisPulse/issues) 提交bug报告
+1. **报告问题**
+   在 [GitHub Issues](https://github.com/ErisPulse/ErisPulse/issues) 提交 bug 报告
 
-2. 功能请求  
+2. **功能请求**
    通过 [社区讨论](https://github.com/ErisPulse/ErisPulse/discussions) 提出新想法
 
-3. 代码贡献  
-   提交 Pull Request 前请阅读我们的 [代码风格](docs/styleguide/docstring_spec.md) 以及 [贡献指南](CONTRIBUTING.md)
+3. **代码贡献**
+   提交 Pull Request 前请阅读我们的 [代码风格](docs/styleguide/) 以及 [贡献指南](CONTRIBUTING.md)
 
-4. 文档改进  
+4. **文档改进**
    帮助完善文档和示例代码
 
 [加入社区讨论](https://github.com/ErisPulse/ErisPulse/discussions)
 
 ---
 
-[![](https://starchart.cc/ErisPulse/ErisPulse.svg?variant=adaptive)](https://starchart.cc/ErisPulse/ErisPulse)
+## 致谢
+
+- 本项目部分代码基于 [sdkFrame](https://github.com/runoneall/sdkFrame)
+- 核心适配器标准化层基于 [OneBot12 规范](https://12.onebot.dev/)
+- 感谢所有为开源社区做出贡献的开发者和作者

erispulse-2.3.6/README.md

@@ -0,0 +1,173 @@
+<table>
+<tr>
+<td width="35%" valign="middle" align="center">
+<img src=".github/assets/erispulse_logo_1024.png" width="280" alt="ErisPulse" />
+</td>
+<td width="65%" valign="middle">
+
+# ErisPulse
+
+**事件驱动的多平台机器人开发框架**
+
+[![PyPI](https://img.shields.io/pypi/v/ErisPulse?style=flat-square)](https://pypi.org/project/ErisPulse/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/ErisPulse?style=flat-square)](https://pypi.org/project/ErisPulse/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Socket Badge](https://socket.dev/api/badge/pypi/package/ErisPulse/latest)](https://socket.dev/pypi/package/ErisPulse)
+
+</td>
+</tr>
+</table>
+
+---
+
+## 简介
+
+ErisPulse 是一个基于 Python 的事件驱动型多平台机器人开发框架。通过统一的 OneBot12 标准接口，您可以一次编写代码，同时在云湖、Telegram、OneBot 等多个平台部署相同功能的机器人。框架提供灵活的模块(`插件`)系统、热重载支持和完整的开发者工具链，适用于从简单聊天机器人到复杂自动化系统的各种场景。
+
+## 核心特性
+
+- **事件驱动架构** - 基于 OneBot12 标准的清晰事件模型
+- **跨平台兼容** - 插件模块编写一次即可在所有平台使用
+- **模块化设计** - 灵活的插件系统，易于扩展和集成
+- **热重载支持** - 开发时无需重启即可重新加载代码
+- **完整工具链** - 提供 CLI 工具、包管理和自动化脚本
+
+## 快速开始
+
+### 安装
+
+```bash
+pip install ErisPulse
+
+# 国内镜像
+pip install -i https://pypi.tuna.tsinghua.edu.cn/simple ErisPulse
+
+# 使用 `uv` 安装
+uv install ErisPulse
+```
+> 如果您的 Python 版本低于 3.10，可以使用一键安装脚本自动配置环境。详见 [安装脚本说明](scripts/install/)。
+
+### 初始化项目
+
+```bash
+# 交互式初始化
+epsdk init
+
+# 快速初始化（指定项目名称）
+epsdk init -q -n my_bot
+```
+
+### 创建第一个机器人
+
+创建 `main.py` 文件：
+
+<table>
+<tr>
+<td width="50%" valign="top">
+
+**命令处理器**
+
+```python
+from ErisPulse import sdk
+from ErisPulse.Core.Event import command
+
+@command("hello", help="发送问候消息")
+async def hello_handler(event):
+    user_name = event.get_user_nickname() or "朋友"
+    await event.reply(f"你好，{user_name}！")
+
+@command("ping", help="测试机器人是否在线")
+async def ping_handler(event):
+    await event.reply("Pong！机器人运行正常。")
+
+if __name__ == "__main__":
+    import asyncio
+    asyncio.run(sdk.run(keep_running=True))
+```
+
+</td>
+<td width="50%" valign="top">
+
+**效果说明**
+
+发送 `/hello`
+
+机器人回复：`你好，{用户名}！`
+
+---
+
+发送 `/ping`
+
+机器人回复：`Pong！机器人运行正常。`
+
+---
+
+**运行方式**
+
+```bash
+epsdk run main.py
+# 或开发模式
+epsdk run main.py --reload
+```
+
+</td>
+</tr>
+</table>
+
+更多详细说明请参阅：
+- [快速开始指南](docs/quick-start.md)
+- [入门指南](docs/getting-started/)
+
+## 应用场景
+
+- **多平台机器人** - 在多个平台部署相同功能的机器人
+- **聊天助手** - 接入 AI 聊天模块，实现娱乐和交互
+- **自动化工具** - 消息通知、任务管理、数据收集
+- **消息转发** - 跨平台消息同步和转发
+
+## 支持的适配器
+
+欢迎您贡献适配器！
+
+- [云湖](https://github.com/ErisPulse/ErisPulse-YunhuAdapter) - 企业级即时通讯平台（机器人账户）
+- [云湖用户](https://github.com/wsu2059q/ErisPulse-YunhuUserAdapter) - 基于云湖用户账户的适配器
+- [Telegram](https://github.com/ErisPulse/ErisPulse-TelegramAdapter) - 全球性即时通讯软件
+- [OneBot11](https://github.com/ErisPulse/ErisPulse-OneBot11Adapter) - 通用机器人接口标准
+- [OneBot12](https://github.com/ErisPulse/ErisPulse-OneBot12Adapter) - OneBot12 标准
+- [邮件](https://github.com/ErisPulse/ErisPulse-EmailAdapter) - 邮件收发处理
+- [沙箱](https://github.com/ErisPulse/ErisPulse-SandboxAdapter) - 网页调试界面，无需接入实际平台
+
+查看 [适配器详情介绍](docs/platform-guide/README.md)
+
+## 文档资源
+
+| 平台 | 主站点 | 备用站点 |
+|------|--------|---------|
+| 文档 | [erisdev.com](https://www.erisdev.com/#docs) | [Cloudflare](https://erispulse.pages.dev/#docs) • [GitHub](https://erispulse.github.io/#docs) • [Netlify](https://erispulse.netlify.app/#docs) |
+| 模块市场 | [erisdev.com](https://www.erisdev.com/#market) | [Cloudflare](https://erispulse.pages.dev/#market) • [GitHub](https://erispulse.github.io/#market) • [Netlify](https://erispulse.netlify.app/#market) |
+
+## 贡献指南
+
+我们欢迎各种形式的贡献，包括但不限于：
+
+1. **报告问题**
+   在 [GitHub Issues](https://github.com/ErisPulse/ErisPulse/issues) 提交 bug 报告
+
+2. **功能请求**
+   通过 [社区讨论](https://github.com/ErisPulse/ErisPulse/discussions) 提出新想法
+
+3. **代码贡献**
+   提交 Pull Request 前请阅读我们的 [代码风格](docs/styleguide/) 以及 [贡献指南](CONTRIBUTING.md)
+
+4. **文档改进**
+   帮助完善文档和示例代码
+
+[加入社区讨论](https://github.com/ErisPulse/ErisPulse/discussions)
+
+---
+
+## 致谢
+
+- 本项目部分代码基于 [sdkFrame](https://github.com/runoneall/sdkFrame)
+- 核心适配器标准化层基于 [OneBot12 规范](https://12.onebot.dev/)
+- 感谢所有为开源社区做出贡献的开发者和作者

{erispulse-2.3.5.dev2 → erispulse-2.3.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ErisPulse"
-version = "2.3.5-dev.2"
+version = "2.3.6"
 description = "ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -14,8 +14,25 @@ authors = [
     { name = "艾莉丝·格雷拉特(WSu2059)", email = "wsu2059@qq.com" }
 ]
 
+maintainers = [
+    { name = "艾莉丝·格雷拉特(WSu2059)", email = "wsu2059@qq.com" }
+]
+
+keywords = [
+    "async",
+    "bot",
+    "sdk",
+    "framework",
+    "robot",
+    "onebot",
+    "telegram",
+    "extensible",
+    "modular",
+    "asyncio"
+]
+
 classifiers = [
-    "Development Status :: 5 - Production/Stable",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
@@ -25,23 +42,32 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3 :: Only",
     "Operating System :: OS Independent",
-    "Topic :: Software Development :: Libraries :: Python Modules"
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Framework :: AsyncIO",
+    "Typing :: Typed"
 ]
 
 dependencies = [
-    "pip",  # 显式声明，防止部分情况下cli报错
-    "rich",
-    "colorama",
-    "aiohttp",
-    "watchdog",
-    "toml",
+    "pip>=23.0",  # 显式声明，防止部分情况下cli报错 | 绝对！！！不要删除这个依赖项
+    "rich>=13.0.0",
+    "aiohttp>=3.9.0",
+    "watchdog>=4.0.0",
+    "toml>=0.10.2",
     "fastapi>=0.116.1",
     "hypercorn>=0.14.0",
-    "pydantic>=2.10.6",
-    "python-multipart>=0.0.20",
     "packaging>=25.0",
 ]
 
+[project.optional-dependencies]
+test = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-asyncio>=0.21.0",
+    "pytest-xdist>=3.0.0",
+    "pytest-mock>=3.10.0",
+]
+
 [project.scripts]
 ep-init = "ErisPulse.__init__:init_sync"
 epsdk = "ErisPulse.__main__:main"