ErisPulse 1.1.14__tar.gz → 1.1.15__tar.gz

{erispulse-1.1.14 → erispulse-1.1.15}/.github/config/notify.json

@@ -1,7 +1,6 @@
 {
     "emails": [
         "wsu2059@qq.com",
-        "suyu@anran.xyz",
         "dev@oneall.eu.org",
         "yuzi6666@outlook.com",
         "ybrinpds@icloud.com",

erispulse-1.1.15/.github/tools/merge_md.py

@@ -0,0 +1,39 @@
+def merge_markdown_files(file_paths, output_file):
+    with open(output_file, 'w', encoding='utf-8') as outfile:
+        # 写入头部说明：介绍每个文件的作用（不包含路径）
+        outfile.write("# ErisPulse 开发文档合集\n\n")
+        outfile.write("本文件由多个开发文档合并而成，用于辅助 AI 理解 ErisPulse 的模块开发规范与 SDK 使用方式。\n\n")
+
+        outfile.write("## 各文件对应内容说明\n\n")
+        outfile.write("| 文件名 | 作用 |\n")
+        outfile.write("|--------|------|\n")
+        outfile.write("| README.md | 项目概览、安装说明和快速入门指南 |\n")
+        outfile.write("| DEVELOPMENT.md | 模块结构定义、入口文件格式、Main 类规范 |\n")
+        outfile.write("| ADAPTERS.md | 平台适配器说明，包括事件监听和消息发送方式 |\n")
+        outfile.write("| REFERENCE.md | SDK 接口调用方式（如 `sdk.env`, `sdk.logger`, `sdk.adapter` 等） |\n\n")
+
+        outfile.write("## 合并内容开始\n\n")
+
+        for file_path in file_paths:
+            filename = file_path.split("/")[-1]
+            with open(file_path, 'r', encoding='utf-8') as infile:
+                content = infile.read()
+                outfile.write(f"<!-- {filename} -->\n\n")
+                outfile.write(content)
+                outfile.write(f"\n\n<!--- End of {filename} -->\n\n")
+
+if __name__ == "__main__":
+    files_to_merge = [
+        "README.md",
+        
+        "docs/DEVELOPMENT.md",
+        
+        "docs/REFERENCE.md",
+
+        "docs/ADAPTERS.md",
+
+        "docs/CLI.md"
+    ]
+    output_file = "docs/ForAIDocs/ErisPulseDevelop.md"
+
+    merge_markdown_files(files_to_merge, output_file)

{erispulse-1.1.14 → erispulse-1.1.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 1.1.14
+Version: 1.1.15
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>, runoneall <runoobsteve@gmail.com>
 License: MIT License

erispulse-1.1.15/docs/ADAPTERS.md

@@ -0,0 +1,125 @@
+# AI 模块生成指南
+
+使用本指南，你可以通过AI快速生成符合ErisPulse规范的模块代码，无需从零开始编写。
+
+## 快速开始
+
+1. **获取开发文档**  
+   下载 `docs/ForAIDocs/ErisPulseDevelop.md` - 它包含了所有AI需要的开发规范、适配器接口和SDK参考。
+
+2. **明确你的需求**  
+   确定模块功能、使用的适配器、依赖关系等核心要素。
+
+3. **向AI描述需求**  
+   使用下面的标准格式清晰地描述你的模块需求。
+
+## 需求描述规范
+
+请按照以下格式描述你的模块需求：
+
+```
+我需要一个用于处理用户指令的模块，名为 CommandProcessor。
+该模块应该能够：
+- 监听 Yunhu 平台的指令事件
+- 当用户发送 "/help" 时，回复帮助信息
+
+请根据 ErisPulse 的模块规范和文档，为我生成完整的模块文件结构和代码
+```
+
+### AI生成代码示例
+
+## 示例：生成一个天气查询模块
+
+### 用户输入需求：
+
+> 我需要一个天气查询模块 WeatherBot，当用户在群聊中发送“/weather 上海”时，机器人会调用 OpenWeatherMap API 查询天气，并返回中文格式的天气信息。  
+> 要求：
+> - 使用 YunhuAdapter 监听指令消息；
+> - 使用 sdk.util.cache 缓存结果；
+> - 模块结构符合 ErisPulse 规范。
+
+并且将刚刚下载的 `ErisPulseDevelop.md` 作为附件发送给 AI。
+
+### AI 输出示例：
+
+```python
+# __init__.py
+moduleInfo = {
+    "meta": {
+        "name": "WeatherBot",
+        "version": "1.0.0",
+        "description": "天气查询模块",
+        "author": "YourName",
+        "license": "MIT"
+    },
+    "dependencies": {
+        "requires": [
+            "YunhuAdapter"
+        ],
+        "optional": [],
+        "pip": ["aiohttp"]
+    }
+}
+
+from .Core import Main
+```
+
+```python
+# Core.py
+import aiohttp
+import time
+
+class Main:
+    def __init__(self, sdk):
+        self.sdk = sdk
+        self.logger = sdk.logger
+        self.env = sdk.env
+        self.util = sdk.util
+
+        @sdk.adapter.Yunhu.on("command")
+        async def handle_weather(data):
+            if data.event.message.commandName.lower() == "weather":
+                city = data.event.message.content.text.strip()
+                chat_type = data.event.chatType
+                sender_type = "group" if chat_type == "group" else "user"
+                sender_id = data.chat.chatId if chat_type == "group" else data.event.sender.senderId
+
+                if not city:
+                    await self.sdk.adapter.Yunhu.Send.To(sender_type, sender_id).Text("请指定城市名称，例如：/weather 上海")
+                    return
+                await self.reply_weather(sender_type, sender_id, city)
+
+    @sdk.util.cache
+    async def get_weather_data(self, city: str):
+        api_key = self.env.get("WEATHER_API_KEY")
+        url = f"http://api.openweathermap.org/data/2.5/weather?q={city}&appid={api_key}"
+        async with aiohttp.ClientSession() as session:
+            async with session.get(url) as resp:
+                if resp.status == 200:
+                    return await resp.json()
+                else:
+                    raise Exception("无法获取天气信息")
+
+    async def reply_weather(self, sender_type, sender_id, city):
+        try:
+            data = await self.get_weather_data(city)
+            temperature = data["main"]["temp"] - 273.15
+            await self.sdk.adapter.Yunhu.Send.To(sender_type, sender_id).Text(f"{city} 的温度是 {temperature:.1f}℃")
+        except Exception as e:
+            self.logger.error(f"获取天气失败: {e}")
+            await self.sdk.adapter.Yunhu.Send.To(sender_type, sender_id).Text(f"获取天气失败，请稍后再试。")
+```
+
+## 常见问题
+
+Q: 如何测试生成的模块？  
+A: 将生成的代码放入ErisPulse项目(初始化过的你自己的项目内会有这个文件夹)的modules目录，重启服务即可加载测试。
+
+Q: 生成的代码不符合我的需求怎么办？  
+A: 可以调整需求描述后重新生成，或直接在生成代码基础上进行修改。
+
+Q: 需要更复杂的功能怎么办？  
+A: 可以将复杂功能拆分为多个简单模块，或分阶段实现。
+
+Q: 我可以把这个模块发布到ErisPulse吗？
+A: 当然可以！但是我们会审查你的代码，确保它符合我们的规范。

{erispulse-1.1.14 → erispulse-1.1.15}/docs/AI-Module-Generation.md

@@ -1,25 +1,22 @@
-# 使用 AI 根据文档生成模块
+# AI 模块生成指南
 
-ErisPulse 的完整文档已经为AI提供了所有开发所需的信息。现在，你可以直接将 **你的需求** 告诉 AI，并让它根据 ErisPulse 的规范和文档结构，为你生成符合要求的模块代码。
+使用本指南，你可以通过AI快速生成符合ErisPulse规范的模块代码，无需从零开始编写。
 
----
+## 快速开始
 
-## 你需要做的仅仅是：
+1. **获取开发文档**  
+   下载 `docs/ForAIDocs/ErisPulseDevelop.md` - 它包含了所有AI需要的开发规范、适配器接口和SDK参考。
 
-1. **阅读并理解我们的文档内容**
-   - 尤其是 DEVELOPMENT.md 中关于模块结构、SDK 接口调用方式等内容。
-2. **明确你要实现的功能**
-   - 包括：模块功能描述、使用的适配器（如 YunhuAdapter）、是否需要依赖其他模块等。
-3. **告诉 AI 你的需求**
-   - 描述得越清晰，AI 生成的结果越准确！
+2. **明确你的需求**  
+   确定模块功能、使用的适配器、依赖关系等核心要素。
 
----
+3. **向AI描述需求**  
+   使用下面的标准格式清晰地描述你的模块需求。
 
-## 如何向 AI 描述你的模块需求？
+## 需求描述规范
 
-请按照以下格式组织你的描述，确保包含以下信息：
+请按照以下格式描述你的模块需求：
 
-### 示例模板：
 ```
 我需要一个用于处理用户指令的模块，名为 CommandProcessor。
 该模块应该能够：
@@ -29,31 +26,7 @@ ErisPulse 的完整文档已经为AI提供了所有开发所需的信息。现
 请根据 ErisPulse 的模块规范和文档，为我生成完整的模块文件结构和代码
 ```
 
----
-
-## 需要哪些文档来生成模块？
-
-### 使用 AI 生成模块时，需要以下文档：
-
-| 文档 | 内容说明 |
-|------|----------|
-| `DEVELOPMENT.md` | 提供模块结构、入口文件、Main 类定义规范 |
-| `ADAPTERS.md` | 如果你使用了适配器（如 Yunhu、Telegram），AI 会参考其中的事件监听和消息发送方式 |
-| `REFERENCE.md` | SDK 接口调用方式（如 `sdk.env`, `sdk.logger`, `sdk.adapter` 等） |
-
-#### 文档的位置在 ErisPulse 项目的 docs 目录下
-
-> 如果你有git环境，可以直接使用 git clone 命令下载 ErisPulse 项目:
-
-```bash
-git clone https://github.com/ErisPulse/ErisPulse.git
-```
-
-> 如果你没有git环境，也可以访问我们的github项目直接下载 ErisPulse 项目的压缩包：
-
-https://github.com/ErisPulse/ErisPulse
-
----
+### AI生成代码示例
 
 ## 示例：生成一个天气查询模块
 
@@ -65,7 +38,7 @@ https://github.com/ErisPulse/ErisPulse
 > - 使用 sdk.util.cache 缓存结果；
 > - 模块结构符合 ErisPulse 规范。
 
-并且将 docs 目录下的 `DEVELOPMENT.md`、`ADAPTERS.md`、`REFERENCE.md` 作为附件发送给 AI。
+并且将刚刚下载的 `ErisPulseDevelop.md` 作为附件发送给 AI。
 
 ### AI 输出示例：
 
@@ -80,7 +53,9 @@ moduleInfo = {
         "license": "MIT"
     },
     "dependencies": {
-        "requires": [],
+        "requires": [
+            "YunhuAdapter"
+        ],
         "optional": [],
         "pip": ["aiohttp"]
     }
@@ -105,12 +80,13 @@ class Main:
         async def handle_weather(data):
             if data.event.message.commandName.lower() == "weather":
                 city = data.event.message.content.text.strip()
-                if not city:
-                    await self.sdk.adapter.Yunhu.Send.To(data.chat).Text("请指定城市名称，例如：/weather 上海")
-                    return
                 chat_type = data.event.chatType
                 sender_type = "group" if chat_type == "group" else "user"
                 sender_id = data.chat.chatId if chat_type == "group" else data.event.sender.senderId
+
+                if not city:
+                    await self.sdk.adapter.Yunhu.Send.To(sender_type, sender_id).Text("请指定城市名称，例如：/weather 上海")
+                    return
                 await self.reply_weather(sender_type, sender_id, city)
 
     @sdk.util.cache
@@ -134,11 +110,16 @@ class Main:
             await self.sdk.adapter.Yunhu.Send.To(sender_type, sender_id).Text(f"获取天气失败，请稍后再试。")
 ```
 
----
+## 常见问题
+
+Q: 如何测试生成的模块？  
+A: 将生成的代码放入ErisPulse项目(初始化过的你自己的项目内会有这个文件夹)的modules目录，重启服务即可加载测试。
+
+Q: 生成的代码不符合我的需求怎么办？  
+A: 可以调整需求描述后重新生成，或直接在生成代码基础上进行修改。
 
-你不再需要从零开始写模块。只需：
+Q: 需要更复杂的功能怎么办？  
+A: 可以将复杂功能拆分为多个简单模块，或分阶段实现。
 
-- 发送给AI, ErisPulse的文档内容  
-- 明确你的需求  
-- 向 AI 描述你的想法  
-- 运行并测试
+Q: 我可以把这个模块发布到ErisPulse吗？
+A: 当然可以！但是我们会审查你的代码，确保它符合我们的规范。

{erispulse-1.1.14 → erispulse-1.1.15}/docs/CHANGELOG.md

@@ -8,15 +8,20 @@
 > **贡献日志**
 > 如需为新版本添加日志，请在对应版本号下补充内容，并注明日期和主要贡献者。
 
+## [1.1.15]
+> 此版本为回滚版本,版本基于1.1.14.dev1:re | 为了修复多项目带来的严重问题，建议升级前先备份数据
+### 新增
+- 拓展CLI:install命令，现在可以指定本地目录直接安装模块
+
+### 修复
+- 修复多项目下模块初始化时可能出现的错误(回滚为单模块项目)
+
 ---
-## [1.1.14.dev1]
+## [1.1.14.dev1:re]
 > 此版本为开发版本，不保证兼容性，仅用于测试和开发
 
 > dev1 的改动为sdk初始化功能优化 | 修复上个版本留下的bug
 ### 新增
-- 在 sdk.init() 初始化时增加依赖版本检测功能
-- 优化模块加载机制，支持版本要求和依赖冲突解决
-- 在 util.py 中添加版本比较和检查工具函数
 - 添加新的 ForAIDocs 项目文档
 
 ### 修复

{erispulse-1.1.14 → erispulse-1.1.15}/docs/CLI.md

@@ -12,7 +12,7 @@
 | `list`     | `[--module=<name>] [--init]` | 列出模块（可筛选）                   | `epsdk list --module=payment`       |
 | `update`   | -                         | 更新模块索引                           | `epsdk update`                      |
 | `upgrade`  | `[--force] [--init]`      | 升级模块（`--force` 强制覆盖）        | `epsdk upgrade --force --init`      |
-| `install`  | `<module...> [--init]`    | 安装一个或多个模块（空格分隔）        | `epsdk install YunhuAdapter OpenAI` |
+| `install`  | `<module...> [--init]`    | 安装一个或多个模块（空格分隔），支持本地目录路径 | `epsdk install YunhuAdapter OpenAI`<br>`epsdk install .`<br>`epsdk install /path/to/module` |
 | `uninstall`| `<module> [--init]`       | 移除指定模块                          | `epsdk uninstall old-module --init` |
 
 ## 源管理
@@ -46,4 +46,4 @@ epsdk run main.py --reload
 ---
 
 ## 反馈与支持
-如遇到 CLI 使用问题，请在 GitHub Issues 提交反馈。
+如遇到 CLI 使用问题，请在 GitHub Issues 提交反馈。

{erispulse-1.1.14 → erispulse-1.1.15}/docs/DEVELOPMENT.md

@@ -180,22 +180,16 @@ moduleInfo = {
         "license": "MIT"
     },
     "dependencies": {
-        "requires": [
-            "ModuleA==1.0.0",    # 必须依赖特定版本的模块
-            "ModuleB>=2.0.0",    # 必须依赖大于等于特定版本的模块
-            "ModuleC"            # 必须依赖模块，不限版本
-        ],
-        "optional": [
-            "ModuleD<=1.5.0",    # 可选依赖小于等于特定版本的模块
-            ["ModuleE>1.0.0", "ModuleF<3.0.0"]  # 可选依赖组（满足其中一个即可）
-        ],
-        "pip": []                # 第三方 pip 包依赖
+        "requires": [],       # 必须依赖的其他模块
+        "optional": [],       # 可选依赖模块列表（满足其中一个即可）
+        "pip": []             # 第三方 pip 包依赖
     }
 }
 
 from .Core import Main
 ```
-> 若版本不匹配, SDK会在启动时抛出异常并退出程序
+
+> ⚠️ 注意：模块名必须唯一，避免与其他模块冲突。
 
 ---
 
@@ -228,32 +222,6 @@ sdk.MyModule.print_hello()
 # 运行模块主程序（推荐使用CLI命令）
 # epsdk run main.py --reload
 ```
-
-明白了，以下是符合你要求的 **简洁版开发者文档更新内容**，保持与原结构一致：
-
----
-
-### 4. 模块路径说明
-
-ErisPulse 支持两种模块加载路径：
-
-| 路径 | 来源 | 数据库存储 | 加载优先级 |
-|------|------|------------|------------|
-| `src/ErisPulse/modules/` | SDK 内置模块 | 是 | 较低 |
-| `./modules/`（项目目录） | 用户自定义模块 | 否 | 较高 |
-
-> - SDK 模块用于官方或长期维护的模块，支持启用/禁用状态控制。
-> - 项目模块仅运行时加载，不写入数据库，适合快速测试。
-
-若同一模块名存在于多个路径中，系统会根据权重选择加载路径，并输出提示日志：
-
-> 项目模块目录 | README.md :
-```
-此目录 (`./modules`) 用于存放项目专属模块。这些模块会优先于 SDK 内置模块被加载，但不会写入数据库。
-
-你可以将自定义模块放入此目录，SDK 会自动识别并加载它们。
-```
-
 ---
 
 ## 三、平台适配器开发（Adapter）
@@ -311,7 +279,7 @@ class Main:
         #   在 MyPlatformAdapter 中的方法可以使用 sdk.adapter.<适配器注册名>.<方法名> 访问
 
 class MyPlatformAdapter(sdk.BaseAdapter):
-    class Send(sdk.BaseAdapter.Send):  # 继承BaseAdapter内置的Send类
+    class Send(super().Send):  # 继承BaseAdapter内置的Send类
         # 底层SendDSL中提供了To方法，用户调用的时候类会被定义 `self._target_type` 和 `self._target_id`/`self._target_to` 三个属性
         # 当你只需要一个接受的To时，例如 mail 的To只是一个邮箱，那么你可以使用 `self.To(email)`，这时只会有 `self._target_id`/`self._target_to` 两个属性被定义
         # 或者说你不需要用户的To，那么用户也可以直接使用 Send.Func(text) 的方式直接调用这里的方法
@@ -375,7 +343,7 @@ class MyPlatformAdapter(sdk.BaseAdapter):
 
 > ⚠️ 注意：
 > - 适配器类必须继承 `sdk.BaseAdapter`；
-> - 必须实现 `call_api`, `start`, `shutdown` 方法 和 `Send`类并继承自 `sdk.BaseAdapter.Send`；
+> - 必须实现 `call_api`, `start`, `shutdown` 方法 和 `Send`类并继承自 `super().Send`；
 > - 推荐实现 `.Text(...)` 方法作为基础消息发送接口。
 
 ## 4. DSL 风格消息接口（SendDSL）
@@ -383,7 +351,7 @@ class MyPlatformAdapter(sdk.BaseAdapter):
 每个适配器可定义一组链式调用风格的方法，例如：
 
 ```python
-class Send(sdk.BaseAdapter.Send):
+class Send(super().Send):
     def Text(self, text: str):
         return asyncio.create_task(
             self._adapter.call_api(...)
@@ -431,4 +399,4 @@ sdk.adapter.MyPlatform.Send.To("user", "U1001").Text("你好")
 
 ## 五、提交到官方源
 
-如果你希望将你的模块或适配器加入 ErisPulse 官方模块仓库，请参考 [模块源贡献](https://github.com/ErisPulse/ErisPulse-ModuleRepo)。
+如果你希望将你的模块或适配器加入 ErisPulse 官方模块仓库，请参考 [模块源贡献](https://github.com/ErisPulse/ErisPulse-ModuleRepo)。