ErisPulse 2.3.1__tar.gz → 2.3.2__tar.gz

{erispulse-2.3.1 → erispulse-2.3.2}/.github/tools/merge_md.py

@@ -1,6 +1,38 @@
 import os
 from datetime import datetime
 
+"""
+ErisPulse文档合并工具
+
+使用方法:
+1. 默认生成包含API的完整文档和开发文档:
+   python merge_md.py
+
+2. 生成不包含API的文档版本:
+   python merge_md.py no-api
+
+3. 只生成完整文档:
+   python merge_md.py full
+
+4. 只生成开发文档:
+   python merge_md.py dev
+
+5. 只生成核心文档:
+   python merge_md.py core
+
+输出文件位置:
+- 完整文档: docs/ai/AIDocs/ErisPulse-Full.md
+- 模块开发文档: docs/ai/AIDocs/ErisPulse-ModuleDev.md  
+- 适配器开发文档: docs/ai/AIDocs/ErisPulse-AdapterDev.md
+- 核心文档: docs/ai/AIDocs/ErisPulse-Core.md
+
+no-api版本输出文件位置:
+- 完整文档(no-api): docs/ai/AIDocs/no-api/ErisPulse-Full.md
+- 模块开发文档(no-api): docs/ai/AIDocs/no-api/ErisPulse-ModuleDev.md  
+- 适配器开发文档(no-api): docs/ai/AIDocs/no-api/ErisPulse-AdapterDev.md
+- 核心文档(no-api): docs/ai/AIDocs/no-api/ErisPulse-Core.md
+"""
+
 def merge_md_files(output_file, files_to_merge, title="文档合集"):
     """
     合并多个Markdown文件
@@ -265,7 +297,7 @@ def get_platform_features_files():
     
     return platform_files
 
-def generate_full_document():
+def generate_full_document(include_api=True):
     print("正在生成完整文档...")
     
     # 基础文件
@@ -294,15 +326,24 @@ def generate_full_document():
     if len(existing_files) != len(files_to_merge):
         print(f"警告: {len(files_to_merge) - len(existing_files)} 个文件不存在，已跳过")
     
-    output_file = "docs/ai/AIDocs/ErisPulse-Full.md"
+    # 根据是否包含API决定输出路径
+    if include_api:
+        output_file = "docs/ai/AIDocs/ErisPulse-Full.md"
+    else:
+        output_file = "docs/ai/AIDocs/no-api/ErisPulse-Full.md"
+    
     os.makedirs(os.path.dirname(output_file), exist_ok=True)
     
     merge_md_files(output_file, existing_files, "完整开发文档")
-    merge_api_docs("docs/api", output_file)
     
-    print(f"完整文档生成完成，已保存到: {output_file}")
+    # 根据参数决定是否合并API文档
+    if include_api:
+        merge_api_docs("docs/api", output_file)
+    
+    api_status = "包含API" if include_api else "不包含API"
+    print(f"完整文档生成完成（{api_status}），已保存到: {output_file}")
 
-def generate_dev_documents():
+def generate_dev_documents(include_api=True):
     print("正在生成开发文档...")
     
     # 模块开发文档
@@ -331,11 +372,17 @@ def generate_dev_documents():
     # 过滤不存在的文件
     existing_files = [f for f in files_to_merge if os.path.exists(f['path'])]
     
-    module_output = "docs/ai/AIDocs/ErisPulse-ModuleDev.md"
+    # 根据是否包含API决定输出路径
+    if include_api:
+        module_output = "docs/ai/AIDocs/ErisPulse-ModuleDev.md"
+    else:
+        module_output = "docs/ai/AIDocs/no-api/ErisPulse-ModuleDev.md"
+    
     os.makedirs(os.path.dirname(module_output), exist_ok=True)
     merge_md_files(module_output, existing_files, "模块开发文档")
 
-    print(f"模块开发文档生成完成，已保存到: {module_output}")
+    api_status = "包含API" if include_api else "不包含API"
+    print(f"模块开发文档生成完成（{api_status}），已保存到: {module_output}")
     
     # 适配器开发文档
     adapter_files = [
@@ -357,14 +404,22 @@ def generate_dev_documents():
     # 过滤不存在的文件
     existing_files = [f for f in files_to_merge if os.path.exists(f['path'])]
     
-    adapter_output = "docs/ai/AIDocs/ErisPulse-AdapterDev.md"
+    # 根据是否包含API决定输出路径
+    if include_api:
+        adapter_output = "docs/ai/AIDocs/ErisPulse-AdapterDev.md"
+    else:
+        adapter_output = "docs/ai/AIDocs/no-api/ErisPulse-AdapterDev.md"
+    
     os.makedirs(os.path.dirname(adapter_output), exist_ok=True)
     merge_md_files(adapter_output, existing_files, "适配器开发文档")
-    merge_api_docs("docs/api", adapter_output)
     
-    print(f"适配器开发文档生成完成，已保存到: {adapter_output}")
+    # 根据参数决定是否合并API文档
+    if include_api:
+        merge_api_docs("docs/api", adapter_output)
+    
+    print(f"适配器开发文档生成完成（{api_status}），已保存到: {adapter_output}")
 
-def generate_core_document():
+def generate_core_document(include_api=True):
     print("正在生成核心文档...")
     
     # 基础文件
@@ -385,11 +440,21 @@ def generate_core_document():
     # 过滤不存在的文件
     existing_files = [f for f in files_to_merge if os.path.exists(f['path'])]
     
-    core_output = "docs/ai/AIDocs/ErisPulse-Core.md"
+    # 根据是否包含API决定输出路径
+    if include_api:
+        core_output = "docs/ai/AIDocs/ErisPulse-Core.md"
+    else:
+        core_output = "docs/ai/AIDocs/no-api/ErisPulse-Core.md"
+    
     os.makedirs(os.path.dirname(core_output), exist_ok=True)
     merge_md_files(core_output, existing_files, "核心功能文档")
     
-    print(f"核心文档生成完成，已保存到: {core_output}")
+    # 根据参数决定是否合并API文档
+    if include_api:
+        merge_api_docs("docs/api", core_output)
+    
+    api_status = "包含API" if include_api else "不包含API"
+    print(f"核心文档生成完成（{api_status}），已保存到: {core_output}")
 
 def generate_custom_document(title, files, api_dirs, output_path):
     """
@@ -414,11 +479,44 @@ def generate_custom_document(title, files, api_dirs, output_path):
     
     print(f"{title}生成完成，已保存到: {output_path}")
 
+def generate_no_api_documents():
+    print("正在生成no-api版本文档...")
+    
+    # 生成不包含API的完整文档
+    generate_full_document(include_api=False)
+    
+    # 生成不包含API的开发文档
+    generate_dev_documents(include_api=False)
+    
+    # 生成不包含API的核心文档
+    generate_core_document(include_api=False)
+    
+    print("所有no-api版本文档生成完成")
+
 if __name__ == "__main__":
+    import sys
+    
     try:
-        generate_full_document()
-        generate_dev_documents()
-        # generate_core_document()
+        # 检查命令行参数
+        if len(sys.argv) > 1:
+            if sys.argv[1] == "no-api":
+                generate_no_api_documents()
+            elif sys.argv[1] == "full":
+                generate_full_document()
+                generate_dev_documents()
+                generate_core_document()
+            elif sys.argv[1] == "dev":
+                generate_dev_documents()
+            elif sys.argv[1] == "core":
+                generate_core_document()
+            else:
+                print(f"未知参数: {sys.argv[1]}")
+                print("可用参数: no-api, full, dev, core")
+        else:
+            generate_no_api_documents()
+            generate_full_document()
+            generate_dev_documents()
+            generate_core_document()
         print("所有文档生成完成")
     except Exception as e:
         print(f"文档生成过程中出现错误: {str(e)}")

erispulse-2.3.2/.github/workflows/auto-update-docs.yml

@@ -0,0 +1,152 @@
+name: 📚 艾莉丝的文档炼金工房 ~
+
+permissions:
+  contents: write
+
+on:
+  push:
+    branches: [ main, develop, master ]
+  pull_request:
+    branches: [ main, develop, master ]
+  workflow_dispatch:
+
+jobs:
+  update-and-generate-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 检出魔法书
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 准备魔法环境
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: 学习魔法咒语
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests
+
+      - name: 🔮 更新API文档
+        id: update-api
+        run: |
+          echo "📖 艾莉丝开始更新API文档了哦~"
+          
+          # 确保输出目录存在
+          mkdir -p docs/api
+          
+          # 运行API文档更新脚本
+          if [ -f ".github/tools/update-api-docs.py" ]; then
+            python .github/tools/update-api-docs.py --src src --output docs/api --format markdown
+            echo "✅ API文档更新完成!"
+          else
+            echo "⚠️ 未找到API文档更新脚本，跳过此步骤"
+          fi
+          
+          # 检查API文档是否有更新
+          if git diff --quiet docs/api/; then
+            echo "API文档没有变化"
+            echo "api_updated=false" >> $GITHUB_OUTPUT
+          else
+            echo "发现了API文档更新!"
+            echo "api_updated=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: 📜 生成合并文档
+        id: merge-docs
+        run: |
+          echo "📚 艾莉丝开始生成合并文档了~"
+          
+          # 确保输出目录存在
+          mkdir -p docs/ai/AIDocs
+          mkdir -p docs/ai/AIDocs/no-api
+          
+          # 生成包含API的文档
+          if [ -f ".github/tools/merge_md.py" ]; then
+            python .github/tools/merge_md.py full
+            python .github/tools/merge_md.py dev
+            
+            echo "✅ 包含API的文档生成完成!"
+          else
+            echo "⚠️ 未找到文档合并脚本"
+            exit 1
+          fi
+          
+          # 检查合并文档是否有更新
+          if git diff --quiet docs/ai/AIDocs/; then
+            echo "合并文档没有变化"
+            echo "docs_updated=false" >> $GITHUB_OUTPUT
+          else
+            echo "发现了合并文档更新!"
+            echo "docs_updated=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: 📝 生成no-api版本文档
+        run: |
+          echo "📖 艾莉丝正在生成不包含API的文档版本~"
+          
+          # 生成不包含API的文档
+          if [ -f ".github/tools/merge_md.py" ]; then
+            python .github/tools/merge_md.py no-api
+            echo "✅ no-api版本文档生成完成!"
+          fi
+
+      - name: 📊 统计更新情况
+        run: |
+          echo "📈 艾莉丝正在统计今天的文档更新情况~"
+          
+          # 统计API文档更新
+          api_files=$(git diff --name-only docs/api/ 2>/dev/null | wc -l)
+          echo "📝 API文档更新文件数: $api_files"
+          
+          # 统计合并文档更新
+          full_docs=$(git diff --name-only docs/ai/AIDocs/ 2>/dev/null | wc -l)
+          echo "📚 合并文档更新文件数: $full_docs"
+          
+          # 统计no-api文档
+          noapi_docs=$(git diff --name-only docs/ai/AIDocs/no-api/ 2>/dev/null | wc -l)
+          echo "📖 no-api文档更新文件数: $noapi_docs"
+
+      - name: 💾 提交更新
+        if: steps.update-api.outputs.api_updated == 'true' || steps.merge-docs.outputs.docs_updated == 'true'
+        run: |
+          echo "💾 艾莉丝正在保存文档更新~"
+          
+          # 配置Git用户信息
+          git config --local user.email "eris@magic-circle.dev"
+          git config --local user.name "Eris the Scribe"
+          
+          # 添加所有更新的文档
+          git add docs/api/ docs/ai/AIDocs/
+          
+          # 生成提交信息
+          commit_msg="📚 艾莉丝的自动文档更新魔法 [skip ci]
+          
+          📖 自动更新了项目文档
+          📝 包含API文档和合并文档的最新版本
+          📚 生成了包含API和不包含API两种版本
+          
+          🌟 详情请查看 docs/ 目录"
+          
+          # 提交更改
+          git commit -m "$commit_msg"
+          git push
+
+      - name: 🎉 文档更新完成
+        if: steps.update-api.outputs.api_updated == 'true' || steps.merge-docs.outputs.docs_updated == 'true'
+        run: |
+          echo "🌟 艾莉丝今天也努力完成了文档更新的魔法呢!"
+          echo "📚 所有文档已更新并提交到仓库"
+          echo "💫 包含了最新的API文档和合并文档"
+          echo "🌙 今天的文档炼金工作完成啦~"
+
+      - name: 😊 无更新时的说明
+        if: steps.update-api.outputs.api_updated != 'true' && steps.merge-docs.outputs.docs_updated != 'true'
+        run: |
+          echo "✨ 今天没有发现需要更新的文档呢~"
+          echo "📚 所有文档都是最新状态"
+          echo "🌟 艾莉丝会继续守护着我们的文档库!"
+          echo "🌙 下次更新再见啦~"

{erispulse-2.3.1 → erispulse-2.3.2}/CHANGELOG.md

@@ -31,6 +31,18 @@
     - 具体功能点2
 ```
 
+---
+## [2.3.2] - 2025/01/11
+### 新增
+- @wsu2059q
+  - 新增第三方cli模块异步的调用支持
+
+### 修复
+- @wsu2059q
+  - 修复第三方命令调用时可能出现的异常
+
+---
+
 ## [2.3.1] - 2025/12/28
 ### 修复
 - @wsu2059q

{erispulse-2.3.1 → erispulse-2.3.2}/PKG-INFO

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

{erispulse-2.3.1 → erispulse-2.3.2}/docs/README.md

@@ -42,6 +42,7 @@
   - [云湖平台特性](platform-features/yunhu.md) - 云湖适配器特有功能说明
   - [Telegram平台特性](platform-features/telegram.md) - Telegram适配器特有功能说明
   - [OneBot11平台特性](platform-features/onebot11.md) - OneBot11适配器特有功能说明
+  - [OneBot12平台特性](platform-features/onebot12.md) - OneBot12适配器特有功能说明
   - [邮件平台特性](platform-features/email.md) - 邮件适配器特有功能说明
 
 ### API 参考