ErisPulse 2.2.0.dev2__tar.gz → 2.2.1.dev0__tar.gz

{erispulse-2.2.0.dev2 → erispulse-2.2.1.dev0}/.github/tools/update-api-docs.py

@@ -117,11 +117,9 @@ def parse_python_file(file_path: str) -> Tuple[Optional[str], List[Dict], List[D
         # 处理类定义
         if isinstance(node, ast.ClassDef):
             class_doc = ast.get_docstring(node)
-            processed_class_doc = process_docstring(class_doc) if class_doc else None
+            processed_class_doc = process_docstring(class_doc) if class_doc else ""
             
-            if processed_class_doc is None:
-                continue
-                
+            # 不管类有没有文档，都要处理其中的方法
             methods = []
             # 提取类方法
             for item in node.body:
@@ -129,7 +127,7 @@ def parse_python_file(file_path: str) -> Tuple[Optional[str], List[Dict], List[D
                     method_doc = ast.get_docstring(item)
                     processed_method_doc = process_docstring(method_doc) if method_doc else None
                     
-                    if processed_method_doc:
+                    if processed_method_doc:  # 只有方法有文档才添加
                         # 获取函数签名
                         args = []
                         defaults = dict(zip([arg.arg for arg in item.args.args][-len(item.args.defaults):], item.args.defaults)) if item.args.defaults else {}
@@ -159,12 +157,14 @@ def parse_python_file(file_path: str) -> Tuple[Optional[str], List[Dict], List[D
             bases = [ast.unparse(base) for base in node.bases] if node.bases else []
             class_signature = f"class {node.name}({', '.join(bases)})" if bases else f"class {node.name}"
             
-            classes.append({
-                "name": node.name,
-                "signature": class_signature,
-                "doc": processed_class_doc,
-                "methods": methods
-            })
+            # 只有类有文档或者有方法时才添加类
+            if processed_class_doc or methods:
+                classes.append({
+                    "name": node.name,
+                    "signature": class_signature,
+                    "doc": processed_class_doc,
+                    "methods": methods
+                })
         
         # 处理函数定义
         elif isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)):
@@ -243,11 +243,13 @@ def generate_markdown(module_path: str, module_doc: Optional[str],
     if classes:
         content.append("## 类列表\n")
         for cls in classes:
+            # 如果类没有文档，显示默认信息
+            class_doc = cls['doc'] if cls['doc'] else f"{cls['name']} 类提供相关功能。"
             content.append(f"""### `{cls['signature']}`
 
-{cls['doc']}
+    {class_doc}
 
-""")
+    """)
             
             # 类方法
             if cls["methods"]:
@@ -256,10 +258,10 @@ def generate_markdown(module_path: str, module_doc: Optional[str],
                     async_marker = "async " if method["is_async"] else ""
                     content.append(f"""##### {async_marker}`{method['signature']}`
 
-{method['doc']}
+    {method['doc']}
 
----
-""")
+    ---
+    """)
     
     # 文档尾部
     content.append(f"<sub>文档最后更新于 {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}</sub>")

erispulse-2.2.1.dev0/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# 项目贡献指南
+
+## 分支管理规范
+
+### 分支结构
+- **main**: 主分支，存放稳定可发布的代码
+- **Develop/v2**: 开发主分支，所有功能分支最终合并至此
+- **Pre-Release/v2**: 预发布分支，用于版本发布前的测试
+- **feature/***: 功能开发分支，按功能命名
+- **Archive/v1**: 归档分支，存放旧版本代码
+
+## 贡献流程
+
+1. **Fork仓库**
+   - 首先fork主仓库到您的个人账户
+
+2. **创建个人分支**
+   - 从`Develop/v2`创建您的功能分支，命名规范：
+     - `feature/描述性名称` (如`feature/wsu2059q`) -> 可为长期的功能开发/修复分支
+
+3. **开发工作**
+   - 在您的功能分支上进行开发
+   - 保持提交信息清晰明确
+   - 提交前确保已经在ChangeLog中添加描述
+   - 定期从`Develop/v2`拉取更新以避免冲突
+
+4. **提交Pull Request**
+   - 开发完成后，向`Develop/v2`分支提交PR
+   - 在PR的模板中勾选对应选项 或 添加一些详情信息
+
+5. **合并到Develop/v2**
+   - 审查通过后，代码将被合并到`Develop/v2`
+
+6. **发布流程**
+   - 版本更新， `Develop/v2` 会随更新合并到 `Pre-Release/v2` 发布并进行测试
+   - 测试通过后，代码将最终发布到`main`分支
+
+## 注意事项
+
+- 请勿直接向`main`或`Pre-Release/v2`分支提交代码
+- 如有疑问，请联系 `support@erisdev.com` 或者 添加我们的社交讨论群: 云湖群ID -> 635409929
+
+感谢您的贡献！

{erispulse-2.2.0.dev2 → erispulse-2.2.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 2.2.0.dev2
+Version: 2.2.1.dev0
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>
 License: MIT License
@@ -52,7 +52,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: aiohttp
 Requires-Dist: colorama
 Requires-Dist: fastapi>=0.116.1
@@ -71,43 +71,31 @@ Description-Content-Type: text/markdown
 
 ![ErisPulse Logo](.github/assets/erispulse_logo.png)
 
-[![FramerOrg](https://img.shields.io/badge/合作伙伴-FramerOrg-blue?style=flat-square)](https://github.com/FramerOrg)
+[![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/)
+[![Socket Badge](https://socket.dev/api/badge/pypi/package/ErisPulse/latest)](https://socket.dev/pypi/package/ErisPulse)
 
-## 文档站
+## 文档资源
 
-[![Docs-Main](https://img.shields.io/badge/docs-main_site-blue?style=flat-square)](https://www.erisdev.com/#docs)
-[![Docs-CF Pages](https://img.shields.io/badge/docs-cloudflare-blue?style=flat-square)](https://erispulse.pages.dev/#docs)
-[![Docs-GitHub](https://img.shields.io/badge/docs-github-blue?style=flat-square)](https://erispulse.github.io/#docs)
-[![Docs-Netlify](https://img.shields.io/badge/docs-netlify-blue?style=flat-square)](https://erispulse.netlify.app/#docs)
-
-## 模块市场
-
-[![Market-Main](https://img.shields.io/badge/market-erisdev-blue?style=flat-square)](https://www.erisdev.com/#market)
-[![Market-CF Pages](https://img.shields.io/badge/market-cloudflare-blue?style=flat-square)](https://erispulse.pages.dev/#market)
-[![Market-GitHub](https://img.shields.io/badge/market-github-blue?style=flat-square)](https://erispulse.github.io/#market)
-[![Market-Netlify](https://img.shields.io/badge/market-netlify-blue?style=flat-square)](https://erispulse.netlify.app/#market)
-
----
+| 平台 | 主站点 | 备用站点 |
+|------|--------|---------|
+| 文档 | [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) |
 
 ## 核心特性
 
 | 特性 | 描述 |
 |:-----|:-----|
-| **异步架构** | 完全基于 async/await 的异步设计 |
-| **模块化系统** | 灵活的插件和模块管理 |
-| **热重载** | 开发时自动重载，无需重启 |
-| **错误管理** | 统一的错误处理和报告系统 |
-| **配置管理** | 灵活的配置存储和访问 |
-
----
+| 异步架构 | 完全基于 async/await 的异步设计 |
+| 模块化系统 | 灵活的插件和模块管理 |
+| 热重载 | 开发时自动重载，无需重启 |
+| 错误管理 | 统一的错误处理和报告系统 |
+| 配置管理 | 灵活的配置存储和访问 |
 
 ## 快速开始
 
 ### 一键安装脚本
 
-我们提供了一键安装脚本，支持所有主流平台：
-
 #### Windows (PowerShell):
 
 ```powershell
@@ -120,30 +108,30 @@ irm https://get.erisdev.com/install.ps1 -OutFile install.ps1; powershell -Execut
 curl -sSL https://get.erisdev.com/install.sh | tee install.sh >/dev/null && chmod +x install.sh && ./install.sh
 ```
 
----
+## 开发与测试
 
-## 测试与开发
-
-### 1. 克隆项目并进入目录
+### 1. 克隆项目
 
 ```bash
 git clone -b Develop/v2 https://github.com/ErisPulse/ErisPulse.git
 cd ErisPulse
 ```
 
-### 2. 使用 `uv` 同步项目环境
+### 2. 环境搭建
+
+使用 uv 同步项目环境:
 
 ```bash
 uv sync
 
-# 启动虚拟环境
-source .venv/bin/activate   
+# 激活虚拟环境
+source .venv/bin/activate   # macOS/Linux
 # Windows: .venv\Scripts\activate
 ```
 
-> `ErisPulse` 目前正在使用 `python3.13` 进行开发(所以您同步环境时会自动安装 `3.13`)，但也可以使用其他版本(版本不应低于 `3.10`)。
+说明: ErisPulse 使用 Python 3.13 开发，但兼容 Python 3.10+
 
-### 3. 安装依赖并开始
+### 3. 安装依赖
 
 ```bash
 uv pip install -e .
@@ -161,7 +149,7 @@ python -c "from ErisPulse import sdk; sdk.init()"
 
 ### 5. 运行测试
 
-我们提供了一个交互式测试脚本，可以帮助您快速验证SDK功能：
+我们提供了一个交互式测试脚本，可以帮助您快速验证SDK功能(于开发中)：
 
 ```bash
 uv run devs/test.py
@@ -174,34 +162,26 @@ uv run devs/test.py
 - 工具函数测试
 - 适配器功能测试
 
-### 6. 开发模式 (热重载)
-
-```bash
-epsdk run your_script.py --reload
-```
-
----
-
 ## 贡献指南
 
 我们欢迎各种形式的贡献，包括但不限于:
 
-1. **报告问题**  
+1. 报告问题  
    在 [GitHub Issues](https://github.com/ErisPulse/ErisPulse/issues) 提交bug报告
 
-2. **功能请求**  
+2. 功能请求  
    通过 [社区讨论](https://github.com/ErisPulse/ErisPulse/discussions) 提出新想法
 
-3. **代码贡献**  
-   提交 Pull Request 前请阅读我们的 [代码风格](docs/StyleGuide/DocstringSpec.md)
+3. 代码贡献  
+   提交 Pull Request 前请阅读我们的 [代码风格](docs/StyleGuide/DocstringSpec.md) 以及 [贡献指南](CONTRIBUTING.md)
 
-4. **文档改进**  
+4. 文档改进  
    帮助完善文档和示例代码
 
----
-
-[加入社区讨论 →](https://github.com/ErisPulse/ErisPulse/discussions)
+[加入社区讨论](https://github.com/ErisPulse/ErisPulse/discussions)
 
 ---
 
 [![](https://starchart.cc/ErisPulse/ErisPulse.svg?variant=adaptive)](https://starchart.cc/ErisPulse/ErisPulse)
+
+

erispulse-2.2.1.dev0/README.md

@@ -0,0 +1,118 @@
+# 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/)
+[![Socket Badge](https://socket.dev/api/badge/pypi/package/ErisPulse/latest)](https://socket.dev/pypi/package/ErisPulse)
+
+## 文档资源
+
+| 平台 | 主站点 | 备用站点 |
+|------|--------|---------|
+| 文档 | [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) |
+
+## 核心特性
+
+| 特性 | 描述 |
+|:-----|:-----|
+| 异步架构 | 完全基于 async/await 的异步设计 |
+| 模块化系统 | 灵活的插件和模块管理 |
+| 热重载 | 开发时自动重载，无需重启 |
+| 错误管理 | 统一的错误处理和报告系统 |
+| 配置管理 | 灵活的配置存储和访问 |
+
+## 快速开始
+
+### 一键安装脚本
+
+#### 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
+```
+
+## 开发与测试
+
+### 1. 克隆项目
+
+```bash
+git clone -b Develop/v2 https://github.com/ErisPulse/ErisPulse.git
+cd ErisPulse
+```
+
+### 2. 环境搭建
+
+使用 uv 同步项目环境:
+
+```bash
+uv sync
+
+# 激活虚拟环境
+source .venv/bin/activate   # macOS/Linux
+# Windows: .venv\Scripts\activate
+```
+
+说明: ErisPulse 使用 Python 3.13 开发，但兼容 Python 3.10+
+
+### 3. 安装依赖
+
+```bash
+uv pip install -e .
+```
+
+这将以"开发模式"安装 SDK，所有本地修改都会立即生效。
+
+### 4. 验证安装
+
+运行以下命令确认 SDK 正常加载：
+
+```bash
+python -c "from ErisPulse import sdk; sdk.init()"
+```
+
+### 5. 运行测试
+
+我们提供了一个交互式测试脚本，可以帮助您快速验证SDK功能(于开发中)：
+
+```bash
+uv run devs/test.py
+```
+
+测试功能包括:
+- 日志系统测试
+- 环境配置测试
+- 错误管理测试
+- 工具函数测试
+- 适配器功能测试
+
+## 贡献指南
+
+我们欢迎各种形式的贡献，包括但不限于:
+
+1. 报告问题  
+   在 [GitHub Issues](https://github.com/ErisPulse/ErisPulse/issues) 提交bug报告
+
+2. 功能请求  
+   通过 [社区讨论](https://github.com/ErisPulse/ErisPulse/discussions) 提出新想法
+
+3. 代码贡献  
+   提交 Pull Request 前请阅读我们的 [代码风格](docs/StyleGuide/DocstringSpec.md) 以及 [贡献指南](CONTRIBUTING.md)
+
+4. 文档改进  
+   帮助完善文档和示例代码
+
+[加入社区讨论](https://github.com/ErisPulse/ErisPulse/discussions)
+
+---
+
+[![](https://starchart.cc/ErisPulse/ErisPulse.svg?variant=adaptive)](https://starchart.cc/ErisPulse/ErisPulse)
+
+