ErisPulse 1.2.9__tar.gz → 2.1.1__tar.gz

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

@@ -0,0 +1,141 @@
+import os
+
+def merge_md_files(output_file, files_to_merge, title="文档合集"):
+    """
+    合并多个Markdown文件
+    
+    :param output_file: 输出文件路径
+    :param files_to_merge: 要合并的文件列表，包含文件路径和描述
+    :param title: 文档标题
+    """
+    with open(output_file, 'w', encoding='utf-8') as outfile:
+        # 写入头部说明
+        outfile.write(f"# ErisPulse {title}\n\n")
+        outfile.write("本文件由多个开发文档合并而成，用于辅助 AI 理解 ErisPulse 的相关功能。\n\n")
+
+        outfile.write("## 各文件对应内容说明\n\n")
+        outfile.write("| 文件名 | 作用 |\n")
+        outfile.write("|--------|------|\n")
+        
+        # 写入文件说明
+        for file_info in files_to_merge:
+            outfile.write(f"| {os.path.basename(file_info['path'])} | {file_info.get('description', '')} |\n")
+        
+        outfile.write("\n## 合并内容开始\n\n")
+
+        # 合并文件内容
+        for file_info in files_to_merge:
+            file_path = file_info['path']
+            if os.path.exists(file_path):
+                filename = os.path.basename(file_path)
+                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")
+            else:
+                print(f"⚠️ 文件不存在，跳过: {file_path}")
+
+def merge_api_docs(api_dir, output_file):
+    """
+    合并API文档
+    
+    :param api_dir: API文档目录
+    :param output_file: 输出文件路径
+    """
+    with open(output_file, 'a', encoding='utf-8') as outfile:
+        outfile.write("<!-- API文档 -->\n\n")
+        outfile.write("# API参考\n\n")
+
+        # 递归遍历API目录
+        for root, _, files in os.walk(api_dir):
+            for file in files:
+                if file.endswith('.md'):
+                    file_path = os.path.join(root, file)
+                    rel_path = os.path.relpath(file_path, api_dir)
+                    
+                    with open(file_path, 'r', encoding='utf-8') as infile:
+                        content = infile.read()
+                        outfile.write(f"## {rel_path}\n\n")
+                        outfile.write(content)
+                        outfile.write("\n\n")
+        
+        outfile.write("<!--- End of API文档 -->\n")
+
+def generate_full_document():
+    """生成完整文档"""
+    print("⏳ 正在生成完整文档...")
+    
+    # 定义要合并的文件
+    files_to_merge = [
+        {"path": "docs/quick-start.md", "description": "快速开始指南"},
+        {"path": "docs/UseCore.md", "description": "核心功能使用说明"},
+        {"path": "docs/PlatformFeatures.md", "description": "平台功能说明"},
+        {"path": "docs/Development/Module.md", "description": "模块开发指南"},
+        {"path": "docs/Development/Adapter.md", "description": "适配器开发指南"},
+        {"path": "docs/AdapterStandards/APIResponse.md", "description": "API响应标准"},
+        {"path": "docs/AdapterStandards/EventConversion.md", "description": "事件转换标准"},
+    ]
+    
+    output_file = "docs/AIDocs/ErisPulse-Full.md"
+    os.makedirs(os.path.dirname(output_file), exist_ok=True)
+    
+    merge_md_files(output_file, files_to_merge, "完整开发文档")
+    merge_api_docs("docs/api", output_file)
+    
+    print(f"🎉 完整文档生成完成，已保存到: {output_file}")
+
+def generate_core_document():
+    """生成核心功能文档"""
+    print("⏳ 正在生成核心功能文档...")
+    
+    files_to_merge = [
+        {"path": "docs/quick-start.md", "description": "快速开始指南"},
+        {"path": "docs/UseCore.md", "description": "核心功能使用说明"},
+        {"path": "docs/PlatformFeatures.md", "description": "平台功能说明"},
+    ]
+    
+    output_file = "docs/AIDocs/ErisPulse-Core.md"
+    os.makedirs(os.path.dirname(output_file), exist_ok=True)
+    
+    merge_md_files(output_file, files_to_merge, "核心功能文档")
+    merge_api_docs("docs/api/ErisPulse/Core", output_file)
+    
+    print(f"🎉 核心功能文档生成完成，已保存到: {output_file}")
+
+def generate_dev_documents():
+    """生成开发文档（模块和适配器）"""
+    print("⏳ 正在生成开发文档...")
+    
+    # 模块开发文档
+    module_files = [
+        {"path": "docs/UseCore.md", "description": "核心功能使用说明"},
+        {"path": "docs/PlatformFeatures.md", "description": "平台支持的发送类型及差异性说明"},
+        {"path": "docs/Development/Module.md", "description": "模块开发指南"}
+    ]
+    
+    module_output = "docs/AIDocs/ErisPulse-ModuleDev.md"
+    merge_md_files(module_output, module_files, "模块开发文档")
+    merge_api_docs("docs/api/", module_output)
+    print(f"🎉 模块开发文档生成完成，已保存到: {module_output}")
+    
+    # 适配器开发文档
+    adapter_files = [
+        {"path": "docs/UseCore.md", "description": "核心功能使用说明"},
+        {"path": "docs/Development/Adapter.md", "description": "适配器开发指南"},
+        {"path": "docs/AdapterStandards/APIResponse.md", "description": "API响应标准"},
+        {"path": "docs/AdapterStandards/EventConversion.md", "description": "事件转换标准"},
+    ]
+    
+    adapter_output = "docs/AIDocs/ErisPulse-AdapterDev.md"
+    merge_md_files(adapter_output, adapter_files, "适配器开发文档")
+    merge_api_docs("docs/api", adapter_output)
+    print(f"🎉 适配器开发文档生成完成，已保存到: {adapter_output}")
+
+if __name__ == "__main__":
+    # 生成所有文档
+    generate_full_document()
+    generate_core_document()
+    generate_dev_documents()
+    
+    print("✅ 所有文档生成完成")

erispulse-2.1.1/.github/tools/update-api-docs.py

@@ -0,0 +1,276 @@
+import os
+import ast
+import re
+import argparse
+from typing import List, Dict, Tuple, Optional, Set
+from datetime import datetime
+
+def process_docstring(docstring: str) -> Optional[str]:
+    """
+    处理文档字符串中的特殊标签
+    
+    :param docstring: 原始文档字符串
+    :return: 处理后的文档字符串或None（如果包含忽略标签）
+    """
+    if not docstring:
+        return None
+    
+    # 检查忽略标签
+    if "{!--< ignore >!--}" in docstring:
+        return None
+    
+    # 替换 {!--< internal-use >!--} 
+    docstring = re.sub(
+        r"{!--< internal-use >!--}(.*)",
+        lambda m: f"⚠️ **内部方法**：{m.group(1).strip()}\n\n",
+        docstring
+    )
+
+    # 替换过时标签
+    docstring = re.sub(
+        r"\{!--< deprecated >!--\}(.*)",
+        lambda m: f"⚠️ **已弃用**：{m.group(1).strip()}\n\n",
+        docstring
+    )
+    
+    # 替换实验性标签
+    docstring = re.sub(
+        r"\{!--< experimental >!--\}(.*)",
+        lambda m: f"🔬 **实验性功能**：{m.group(1).strip()}\n\n",
+        docstring
+    )
+    
+    # 处理提示标签（多行）
+    docstring = re.sub(
+        r"\{!--< tips >!--\}(.*?)\{!--< /tips >!--\}",
+        lambda m: f"💡 **提示**：\n\n{m.group(1).strip()}\n\n",
+        docstring,
+        flags=re.DOTALL
+    )
+    
+    # 处理单行提示标签
+    docstring = re.sub(
+        r"\{!--< tips >!--\}([^\n]*)",
+        lambda m: f"💡 **提示**：{m.group(1).strip()}\n\n",
+        docstring
+    )
+    
+    # 参数说明
+    docstring = re.sub(
+        r":param (\w+):\s*\[([^\]]+)\]\s*(.*)",
+        lambda m: f"- `{m.group(1)}` ({m.group(2)}): {m.group(3).strip()}",
+        docstring
+    )
+    
+    # 返回值说明
+    docstring = re.sub(
+        r":return:\s*\[([^\]]+)\]\s*(.*)",
+        lambda m: f"**返回**: \n\n- 类型: `{m.group(1)}`\n- 描述: {m.group(2).strip()}",
+        docstring
+    )
+    
+    # 异常说明
+    docstring = re.sub(
+        r":raises (\w+):\s*(.*)",
+        lambda m: f"⚠️ **可能抛出**: `{m.group(1)}` - {m.group(2).strip()}",
+        docstring
+    )
+    
+    # 统一换行符为两个换行
+    docstring = re.sub(r"\n{2,}", "\n\n", docstring.strip())
+    
+    return docstring.strip()
+
+def parse_python_file(file_path: str) -> Tuple[Optional[str], List[Dict], List[Dict]]:
+    """
+    解析Python文件，提取模块文档、类和函数信息
+    
+    :param file_path: Python文件路径
+    :return: (模块文档, 类列表, 函数列表)
+    """
+    with open(file_path, "r", encoding="utf-8") as f:
+        source = f.read()
+    
+    try:
+        module = ast.parse(source)
+    except SyntaxError:
+        print(f"⚠️ 语法错误，跳过文件: {file_path}")
+        return None, [], []
+    
+    # 提取模块文档
+    module_doc = ast.get_docstring(module)
+    processed_module_doc = process_docstring(module_doc) if module_doc else None
+    
+    classes = []
+    functions = []
+    
+    # 遍历AST节点
+    for node in module.body:
+        # 处理类定义
+        if isinstance(node, ast.ClassDef):
+            class_doc = ast.get_docstring(node)
+            processed_class_doc = process_docstring(class_doc) if class_doc else None
+            
+            if processed_class_doc is None:
+                continue
+                
+            methods = []
+            # 提取类方法
+            for item in node.body:
+                if isinstance(item, (ast.FunctionDef, ast.AsyncFunctionDef)):
+                    method_doc = ast.get_docstring(item)
+                    processed_method_doc = process_docstring(method_doc) if method_doc else None
+                    
+                    if processed_method_doc:
+                        methods.append({
+                            "name": item.name,
+                            "doc": processed_method_doc,
+                            "is_async": isinstance(item, ast.AsyncFunctionDef)
+                        })
+            
+            classes.append({
+                "name": node.name,
+                "doc": processed_class_doc,
+                "methods": methods
+            })
+        
+        # 处理函数定义
+        elif isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)):
+            func_doc = ast.get_docstring(node)
+            processed_func_doc = process_docstring(func_doc) if func_doc else None
+            
+            if processed_func_doc:
+                functions.append({
+                    "name": node.name,
+                    "doc": processed_func_doc,
+                    "is_async": isinstance(node, ast.AsyncFunctionDef)
+                })
+    
+    return processed_module_doc, classes, functions
+
+def generate_markdown(module_path: str, module_doc: Optional[str], 
+                     classes: List[Dict], functions: List[Dict]) -> str:
+    """
+    生成Markdown格式API文档
+    
+    :param module_path: 模块路径（点分隔）
+    :param module_doc: 模块文档
+    :param classes: 类信息列表
+    :param functions: 函数信息列表
+    :return: Markdown格式的文档字符串
+    """
+    content = []
+    
+    # 文档头部
+    content.append(f"""# 📦 `{module_path}` 模块
+
+*自动生成于 {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}*
+
+---
+""")
+    
+    # 模块文档
+    if module_doc:
+        content.append(f"## 模块概述\n\n{module_doc}\n\n---\n")
+    
+    # 函数部分
+    if functions:
+        content.append("## 🛠️ 函数\n")
+        for func in functions:
+            async_marker = "🔹 `async` " if func["is_async"] else ""
+            content.append(f"""### {async_marker}`{func['name']}`
+
+{func['doc']}
+
+---
+""")
+    
+    # 类部分
+    if classes:
+        content.append("## 🏛️ 类\n")
+        for cls in classes:
+            content.append(f"""### `{cls['name']}`
+
+{cls['doc']}
+
+""")
+            
+            # 类方法
+            if cls["methods"]:
+                content.append("#### 🧰 方法\n")
+                for method in cls["methods"]:
+                    async_marker = "🔹 `async` " if method["is_async"] else ""
+                    content.append(f"""##### {async_marker}`{method['name']}`
+
+{method['doc']}
+
+---
+""")
+    
+    # 文档尾部
+    content.append(f"\n*文档最后更新于 {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}*")
+    
+    return "\n".join(content)
+
+def generate_api_docs(src_dir: str, output_dir: str):
+    """
+    生成API文档
+    
+    :param src_dir: 源代码目录
+    :param output_dir: 输出目录
+    """
+    # 确保输出目录存在
+    os.makedirs(output_dir, exist_ok=True)
+    
+    # 遍历源代码目录
+    for root, _, files in os.walk(src_dir):
+        for file in files:
+            if file.endswith(".py"):
+                file_path = os.path.join(root, file)
+                
+                # 计算模块路径
+                rel_path = os.path.relpath(file_path, src_dir)
+                module_path = rel_path.replace(".py", "").replace(os.sep, ".")
+                
+                # 解析Python文件
+                module_doc, classes, functions = parse_python_file(file_path)
+                
+                # 跳过没有文档的文件
+                if not module_doc and not classes and not functions:
+                    print(f"⏭️ 跳过无文档文件: {file_path}")
+                    continue
+                
+                # 生成Markdown内容
+                md_content = generate_markdown(module_path, module_doc, classes, functions)
+                
+                # 写入文件
+                output_path = os.path.join(output_dir, f"{module_path.replace('.', '/')}.md")
+                os.makedirs(os.path.dirname(output_path), exist_ok=True)
+                
+                with open(output_path, "w", encoding="utf-8") as f:
+                    f.write(md_content)
+                
+                print(f"✅ 已生成: {output_path}")
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="API文档生成器")
+    parser.add_argument("--src", default="src", help="源代码目录 (默认: src)")
+    parser.add_argument("--output", default="docs/api", help="输出目录 (默认: docs/api)")
+    parser.add_argument("--version", action="version", version="API文档生成器 2.0")
+    
+    args = parser.parse_args()
+    
+    print(f"""📁 源代码目录: {args.src}
+📂 输出目录: {args.output}
+⏳ 正在生成API文档...""")
+    
+    generate_api_docs(args.src, args.output)
+    
+    print("""🎉 API文档生成完成！
+
+生成文档包含以下改进:
+✨ 更美观的排版和格式
+📅 自动添加生成时间戳
+🔖 使用emoji图标提高可读性
+📝 优化了参数和返回值的显示方式
+""")

erispulse-2.1.1/.github/workflows/auto-tag-release.yml

@@ -0,0 +1,99 @@
+name: 🎀 艾莉丝的版本标签魔法 ~
+
+permissions:
+  contents: write
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  auto-tag-and-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 检出代码
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 读取版本卷轴
+        id: info
+        shell: bash
+        run: |
+          version=$(grep '^version' pyproject.toml | head -1 | sed 's/version = "//;s/"//')
+          echo "version=$version" >> $GITHUB_OUTPUT
+          echo "发现新版本: $version"
+
+          if [[ $version =~ dev|alpha|beta|a|b ]]; then
+            echo "is_dev=true" >> $GITHUB_OUTPUT
+          else
+            echo "is_dev=false" >> $GITHUB_OUTPUT
+          fi
+
+          commit_msg=$(git log -1 --pretty=%B)
+          commit_short=$(git rev-parse --short HEAD)
+          echo "commit_short=$commit_short" >> $GITHUB_OUTPUT
+          echo "commit_msg<<EOF" >> $GITHUB_OUTPUT
+          echo "$commit_msg" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: 获取变更文件列表
+        id: changed_files
+        shell: bash
+        run: |
+          before="${{ github.event.before }}"
+          after="${{ github.sha }}"
+
+          if [[ "$before" == "0000000000000000000000000000000000000000" ]]; then
+            before="HEAD~1"
+          fi
+
+          echo "before=$before" >> $GITHUB_OUTPUT
+          echo "after=$after" >> $GITHUB_OUTPUT
+
+          files=$(git diff --name-only $before..$after | head -n 50 | xargs)
+          file_count=$(git diff --name-only $before..$after | wc -l)
+
+          if [ "$file_count" -gt 50 ]; then
+            files="$files ..."
+          fi
+
+          echo "files=$files" >> $GITHUB_OUTPUT
+
+      - name: 施展版本魔法
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        shell: bash
+        run: |
+          version="${{ steps.info.outputs.version }}"
+          commit_short="${{ steps.info.outputs.commit_short }}"
+          commit_msg="${{ steps.info.outputs.commit_msg }}"
+          is_dev="${{ steps.info.outputs.is_dev }}"
+          tag_name="v$version"
+          
+          if [ -f "docs/CHANGELOG.md" ]; then
+            changelog=$(sed -n "/^## \[$version\]/,/^## /p" docs/CHANGELOG.md | sed '1d;$d')
+          fi
+          if [ -z "$changelog" ]; then
+            changelog="### ✨ 魔法更新\n\n- $commit_msg ($commit_short)"
+          fi
+
+          if ! git rev-parse "$tag_name" >/dev/null 2>&1; then
+            echo "🎀 施加新的魔法印记..."
+            git tag "$tag_name"
+            git push origin "$tag_name"
+          fi
+
+          if gh release view "$tag_name" &>/dev/null; then
+            gh release edit "$tag_name" \
+              --notes "$changelog" \
+              --prerelease=$is_dev
+            echo "🌟 已更新魔法版本 $tag_name"
+          else
+            gh release create "$tag_name" \
+              --notes "$changelog" \
+              --title "✨ 艾莉丝的魔法更新 $tag_name" \
+              --prerelease=$is_dev
+            echo "✨ 已发布新的魔法版本 $tag_name"
+          fi

{erispulse-1.2.9 → erispulse-2.1.1}/.github/workflows/pypi-publish.yml

@@ -2,7 +2,7 @@ name: 🎀 艾莉丝的PyPI包裹快递服务 ~
 
 # 艾莉丝今天也要努力发包呢!
 on:
-  workflow_dispatch: {} # 手动触发
+  workflow_dispatch: {}
 
 permissions:
   contents: read
@@ -89,26 +89,3 @@ jobs:
         run: |
           emails=$(cat .github/config/notify.json | jq -c '.emails')
           echo "emails=$emails" >> $GITHUB_OUTPUT
-
-      - name: 发送邮件通知
-        uses: ./.github/workflows/send-email
-        with:
-          subject: "[艾莉丝快报] 新版本 ${{ steps.version.outputs.CURRENT_TAG }} 已发布至 PyPI！✨"
-          content: |
-            🎀 您好主人~
-
-            我是艾莉丝，负责为您播报最新消息！
-            今天我们的项目又更新啦~快去看看吧！
-
-            🔖 版本号：${{ steps.version.outputs.CURRENT_TAG }}
-            📦 包地址：
-            https://pypi.org/project/erispulse/${{ steps.version.outputs.CURRENT_TAG }}
-
-            📝 更新内容：
-            ${{ steps.version.outputs.CURRENT_TAG }}
-
-            祝您每天都有好心情~ 💖
-            —— 艾莉丝
-          recipients: ${{ steps.get_emails.outputs.emails }}
-          resend_api_key: ${{ secrets.RESEND_API_KEY }}
-          feishu_smtp_password: ${{ secrets.FEISHU_SMTP_PASSWORD }}

{erispulse-1.2.9 → erispulse-2.1.1}/.gitignore

@@ -1,5 +1,7 @@
 # dev gnore ignore file for Python projects
-env.py
+main.py
+venvs
+config.toml
 adapters
 uv.lock
 snapshots/
@@ -207,4 +209,5 @@ pyvenv.cfg
 
 # erispulse
 my_bot
-modules
+modules
+config.toml

erispulse-2.1.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,54 @@
+# 贡献者公约行为准则
+
+## 我们的承诺
+
+为了促进一个开放和欢迎的环境，我们作为贡献者和维护者承诺，让每个人在我们的项目和社区中的参与都成为一个
+无骚扰的体验，无论年龄、身体大小、残疾、种族、性别认同和表现、经验水平、国籍、个人外貌、种族、宗教
+或性别认同和取向如何。
+
+## 我们的标准
+
+有助于创造积极环境的行为示例包括：
+
+* 使用热情和包容的语言
+* 尊重不同的观点和经验
+* 优雅地接受建设性的批评
+* 专注于社区的最佳利益
+* 对其他社区成员表现出同情
+
+参与者不可接受行为的示例包括：
+
+* 使用性暗示的语言或图像，以及不受欢迎的性关注或挑逗
+* 钓鱼、侮辱/贬损的评论和个人或政治攻击
+* 公共或私人骚扰
+* 在未获得明确许可的情况下发布他人的私人信息，如地址或电子邮件地址
+* 其他在专业环境中被合理视为不当的行为
+
+## 我们的责任
+
+项目维护者负责澄清可接受行为的标准，并被期望对任何不可接受行为采取适当和公正的纠正措施。
+
+项目维护者有权和责任删除、编辑或拒绝与本行为准则不符的评论、提交、代码、维基编辑、问题和其他贡献，
+或因其他他们认为不当、威胁、冒犯或有害的行为而暂时或永久禁止任何贡献者。
+
+## 适用范围
+
+本行为准则适用于项目空间内和公共空间中，个人代表项目或其社区时的行为。代表项目或社区的示例包括使用
+官方项目电子邮件地址、通过官方社交媒体账户发布信息，或在在线或离线活动中担任任命代表。项目的代表性
+可能由项目维护者进一步定义和澄清。
+
+## 执行
+
+虐待、骚扰或其他不可接受行为的实例可以通过联系 erispulse@163.com 报告。
+所有投诉将被审查和调查，并将根据情况作出必要和适当的回应。项目团队有责任对事件举报者保持保密。
+具体的执行政策可能会单独发布。
+
+不善意遵循或执行行为准则的项目维护者可能会面临其他项目领导成员决定的临时或永久后果。
+
+## 归属
+
+本行为准则改编自 [贡献者公约][homepage]，版本 1.4， 可在
+[https://contributor-covenant.org/version/1/4][version] 获取。
+
+[homepage]: https://contributor-covenant.org
+[version]: https://www.contributor-covenant.org/version/1/4

{erispulse-1.2.9 → erispulse-2.1.1}/LICENSE

@@ -2,8 +2,7 @@ MIT License
 
 Copyright (c) 2025 ErisPulse
 
-Portions of this software are based on https://github.com/FramerOrg/Framer 
-(Copyright (c) 2025 runoneall).
+Portions of this software are based on https://github.com/runoneall/sdkFrame.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -25,4 +24,6 @@ SOFTWARE.
 
 The documentation portion of this project references content from https://codeberg.org/ybr/yhwiki,
 licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 
-International License (CC BY-NC-ND 4.0).
+International License (CC BY-NC-ND 4.0).
+
+Note: This license file has been updated to correct the upstream project reference.