ErisPulse 2.4.3.dev1__tar.gz → 2.4.5__tar.gz

{erispulse-2.4.3.dev1 → erispulse-2.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 2.4.3.dev1
+Version: 2.4.5
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: ErisDev <erisdev@88.com>
 Maintainer-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>
@@ -79,7 +79,7 @@ Description-Content-Type: text/markdown
 <table>
 <tr>
 <td width="35%" valign="middle" align="center">
-<img src=".github/assets/erispulse_logo_1024.png" width="280" alt="ErisPulse" />
+<img src=".github/assets/erispulse_logo_hp.png" width="280" alt="ErisPulse" />
 </td>
 <td width="65%" valign="middle">
 
@@ -127,6 +127,7 @@ ErisPulse 是一个基于 Python 的事件驱动型多平台机器人开发框
 | [邮件](https://github.com/ErisPulse/ErisPulse-EmailAdapter) | 邮件协议收发适配器 |
 | [云湖](https://github.com/ErisPulse/ErisPulse-YunhuAdapter) | 企业级即时通讯平台（机器人接入） |
 | [云湖用户](https://github.com/wsu2059q/ErisPulse-YunhuUserAdapter) | 基于云湖用户协议的接入适配器 |
+| [花枫咖啡馆](https://github.com/ErisPulse/ErisPulse-Ideaura/) | Allons! \(・ω・) / |
 
 查看 [适配器详情介绍](docs/zh-CN/platform-guide/README.md)
 
@@ -171,6 +172,56 @@ ERISPULSE_DASHBOARD_TOKEN=your-token docker compose up -d
 
 </details>
 
+<details>
+<summary>使用预发布版本 (Dev)</summary>
+
+设置 `ERISPULSE_CHANNEL=dev` 即可使用预发布版本：
+
+```bash
+# 方式一：使用环境变量（推荐）
+ERISPULSE_CHANNEL=dev ERISPULSE_DASHBOARD_TOKEN=your-token docker compose up -d
+
+# 方式二：构建 dev 镜像
+ERISPULSE_BUILD_TARGET=dev docker compose up -d --build
+```
+
+如需启动时自动更新到最新版本（无论 stable 还是 dev），显式设置 `ERISPULSE_UPDATE_ON_START=true`：
+
+```bash
+ERISPULSE_CHANNEL=dev ERISPULSE_UPDATE_ON_START=true docker compose up -d
+```
+
+也可以拉取预构建的 dev 镜像：
+
+```bash
+docker pull erispulse/erispulse:dev
+```
+
+</details>
+
+<details>
+<summary>Docker 环境变量</summary>
+
+| 变量 | 默认值 | 说明 |
+|------|--------|------|
+| `ERISPULSE_CHANNEL` | `stable` | 版本通道：`stable`（稳定版）或 `dev`（预发布版） |
+| `ERISPULSE_UPDATE_ON_START` | `false` | 容器启动时是否自动更新到最新版本（需显式启用） |
+| `ERISPULSE_DASHBOARD_TOKEN` | 空 | Dashboard 登录令牌 |
+| `ERISPULSE_PORT` | `8000` | Dashboard 端口映射 |
+| `TZ` | `Asia/Shanghai` | 容器时区 |
+
+> 启用 `ERISPULSE_UPDATE_ON_START=true` 可确保即使镜像较旧，容器也能在启动时自动获取最新版本。
+
+</details>
+
+### 1Panel 应用商店
+
+通过 [1Panel](https://1panel.cn) 应用商店一键安装 ErisPulse，详见 [ErisPulse-1Panel](https://github.com/ErisPulse/ErisPulse-1Panel)。
+
+```bash
+bash <(curl -sL https://get-1panel.erisdev.com/install.sh)
+```
+
 ### 使用 pip 安装
 
 ```bash

{erispulse-2.4.3.dev1 → erispulse-2.4.5}/README.md

@@ -7,7 +7,7 @@
 <table>
 <tr>
 <td width="35%" valign="middle" align="center">
-<img src=".github/assets/erispulse_logo_1024.png" width="280" alt="ErisPulse" />
+<img src=".github/assets/erispulse_logo_hp.png" width="280" alt="ErisPulse" />
 </td>
 <td width="65%" valign="middle">
 
@@ -55,6 +55,7 @@ ErisPulse 是一个基于 Python 的事件驱动型多平台机器人开发框
 | [邮件](https://github.com/ErisPulse/ErisPulse-EmailAdapter) | 邮件协议收发适配器 |
 | [云湖](https://github.com/ErisPulse/ErisPulse-YunhuAdapter) | 企业级即时通讯平台（机器人接入） |
 | [云湖用户](https://github.com/wsu2059q/ErisPulse-YunhuUserAdapter) | 基于云湖用户协议的接入适配器 |
+| [花枫咖啡馆](https://github.com/ErisPulse/ErisPulse-Ideaura/) | Allons! \(・ω・) / |
 
 查看 [适配器详情介绍](docs/zh-CN/platform-guide/README.md)
 
@@ -99,6 +100,56 @@ ERISPULSE_DASHBOARD_TOKEN=your-token docker compose up -d
 
 </details>
 
+<details>
+<summary>使用预发布版本 (Dev)</summary>
+
+设置 `ERISPULSE_CHANNEL=dev` 即可使用预发布版本：
+
+```bash
+# 方式一：使用环境变量（推荐）
+ERISPULSE_CHANNEL=dev ERISPULSE_DASHBOARD_TOKEN=your-token docker compose up -d
+
+# 方式二：构建 dev 镜像
+ERISPULSE_BUILD_TARGET=dev docker compose up -d --build
+```
+
+如需启动时自动更新到最新版本（无论 stable 还是 dev），显式设置 `ERISPULSE_UPDATE_ON_START=true`：
+
+```bash
+ERISPULSE_CHANNEL=dev ERISPULSE_UPDATE_ON_START=true docker compose up -d
+```
+
+也可以拉取预构建的 dev 镜像：
+
+```bash
+docker pull erispulse/erispulse:dev
+```
+
+</details>
+
+<details>
+<summary>Docker 环境变量</summary>
+
+| 变量 | 默认值 | 说明 |
+|------|--------|------|
+| `ERISPULSE_CHANNEL` | `stable` | 版本通道：`stable`（稳定版）或 `dev`（预发布版） |
+| `ERISPULSE_UPDATE_ON_START` | `false` | 容器启动时是否自动更新到最新版本（需显式启用） |
+| `ERISPULSE_DASHBOARD_TOKEN` | 空 | Dashboard 登录令牌 |
+| `ERISPULSE_PORT` | `8000` | Dashboard 端口映射 |
+| `TZ` | `Asia/Shanghai` | 容器时区 |
+
+> 启用 `ERISPULSE_UPDATE_ON_START=true` 可确保即使镜像较旧，容器也能在启动时自动获取最新版本。
+
+</details>
+
+### 1Panel 应用商店
+
+通过 [1Panel](https://1panel.cn) 应用商店一键安装 ErisPulse，详见 [ErisPulse-1Panel](https://github.com/ErisPulse/ErisPulse-1Panel)。
+
+```bash
+bash <(curl -sL https://get-1panel.erisdev.com/install.sh)
+```
+
 ### 使用 pip 安装
 
 ```bash

{erispulse-2.4.3.dev1 → erispulse-2.4.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ErisPulse"
-version = "2.4.3-dev.1"
+version = "2.4.5"
 description = "ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。"
 readme = "README.md"
 requires-python = ">=3.10"

{erispulse-2.4.3.dev1 → erispulse-2.4.5}/src/ErisPulse/CLI/cli.py

@@ -12,7 +12,7 @@ from argparse import ArgumentParser, RawDescriptionHelpFormatter
 
 from rich.panel import Panel
 
-from .console import console
+from .console import console, print_banner
 from .registry import CommandRegistry
 from .base import Command
 
@@ -143,6 +143,8 @@ class CLI:
         args, unknown = self.parser.parse_known_args()
         args._unknown_args = unknown
         
+        print_banner()
+        
         # 处理版本选项
         if args.version:
             self._print_version()
@@ -162,6 +164,7 @@ class CLI:
             # 执行命令
             command = self.registry.get(args.command)
             if command:
+                console.print(f"[title]{command.description}[/]")
                 command.execute(args)
             else:
                 console.print(f"[error]未知命令: {args.command}[/]")

{erispulse-2.4.3.dev1 → erispulse-2.4.5}/src/ErisPulse/CLI/cli.pyi

@@ -16,7 +16,7 @@ import traceback
 import pkgutil
 from argparse import ArgumentParser, RawDescriptionHelpFormatter
 from rich.panel import Panel
-from .console import console
+from .console import console, print_banner
 from .registry import CommandRegistry
 from .base import Command
 

{erispulse-2.4.3.dev1 → erispulse-2.4.5}/src/ErisPulse/CLI/commands/init.py

@@ -16,7 +16,6 @@ from ..console import console
 from ..utils import PackageManager
 from ..base import Command
 
-
 class InitCommand(Command):
     name = "init"
     description = "初始化 ErisPulse 项目"
@@ -62,6 +61,10 @@ class InitCommand(Command):
         :param adapter_list: 需要初始化的适配器列表
         :return: 是否初始化成功
         """
+        if not project_name or not all(c.isalnum() or c in ('_', '-', '.') for c in project_name):
+            console.print("[error]项目名称只能包含字母、数字、下划线、连字符和点号[/]")
+            return False
+
         try:
             project_path = Path(project_name)
             if project_path.exists():
@@ -81,32 +84,32 @@ class InitCommand(Command):
                 dir_path.mkdir(exist_ok=True)
                 console.print(f"[green]创建目录: {dir_name}[/green]")
             
-            # 创建配置文件
+            # 创建配置文件 (最小必须配置)
             config_file = project_path / "config" / "config.toml"
             if not config_file.exists():
                 with open(config_file, "w", encoding="utf-8") as f:
-                    f.write("# ErisPulse 配置文件\n\n")
-                    f.write("[ErisPulse]\n")
-                    f.write("# 全局配置\n\n")
+                    f.write("# ErisPulse 配置文件\n")
+                    f.write("# 完整配置示例请参考 config.full.example\n\n")
                     f.write("[ErisPulse.server]\n")
                     f.write('host = "0.0.0.0"\n')
                     f.write("port = 8000\n\n")
                     f.write("[ErisPulse.logger]\n")
                     f.write('level = "INFO"\n')
-                    f.write("log_files = [\"logs/app.log\"]\n")
-                    f.write("memory_limit = 1000\n\n")
                     
-                    # 添加适配器配置
                     if adapter_list:
-                        f.write("[ErisPulse.adapters]\n")
-                        f.write("# 适配器配置\n\n")
-                        f.write("[ErisPulse.adapters.status]\n")
+                        f.write("\n[ErisPulse.adapters.status]\n")
                         for adapter in adapter_list:
-                            f.write(f'{adapter} = false  # 默认禁用，需要时启用\n')
-                        f.write("\n")
+                            f.write(f'{adapter} = false\n')
                 
                 console.print("[green]创建配置文件: config/config.toml[/green]")
             
+            # 创建完整配置示例文件
+            example_file = project_path / "config" / "config.full.example"
+            if not example_file.exists():
+                with open(example_file, "w", encoding="utf-8") as f:
+                    f.write(self._get_full_example_config(adapter_list))
+                console.print("[green]创建配置示例: config/config.full.example[/green]")
+            
             # 创建主程序文件
             main_file = project_path / "main.py"
             if not main_file.exists():
@@ -119,18 +122,7 @@ class InitCommand(Command):
                     f.write("import asyncio\n")
                     f.write("from ErisPulse import sdk\n\n")
                     f.write("async def main():\n")
-                    f.write('    """主程序入口"""\n')
-                    f.write("    # 初始化 SDK\n")
-                    f.write("    await sdk.init()\n\n")
-                    f.write("    # 启动适配器\n")
-                    f.write("    await sdk.adapter.startup()\n\n")
-                    f.write('    print("ErisPulse 已启动，按 Ctrl+C 退出")\n')
-                    f.write("    try:\n")
-                    f.write("        while True:\n")
-                    f.write("            await asyncio.sleep(1)\n")
-                    f.write("    except KeyboardInterrupt:\n")
-                    f.write("        print(\"\\n正在关闭...\")\n")
-                    f.write("        await sdk.adapter.shutdown()\n\n")
+                    f.write("    await sdk.run(keep_running=True)\n\n")
                     f.write("if __name__ == \"__main__\":\n")
                     f.write("    asyncio.run(main())\n")
                 
@@ -147,6 +139,112 @@ class InitCommand(Command):
             console.print(f"[red]初始化项目失败: {e}[/]")
             return False
     
+    @staticmethod
+    def _get_full_example_config(adapter_list=None):
+        """
+        生成完整配置示例文件内容
+        
+        :param adapter_list: list 可用适配器列表
+        :return: str 完整配置示例内容
+        
+        {!--< internal-use >!--}
+        {!--< /internal-use >!--}
+        """
+        lines = [
+            "# ErisPulse 完整配置示例",
+            "# 此文件展示所有可用配置项及其默认值",
+            "# 如需使用，将所需配置复制到 config.toml 并按需修改",
+            "",
+            "# ==================== 服务器 ====================",
+            "",
+            "[ErisPulse.server]",
+            'host = "0.0.0.0"              # 监听地址',
+            "port = 8000                   # 监听端口",
+            "ssl_certfile = null           # SSL 证书路径",
+            "ssl_keyfile = null            # SSL 密钥路径",
+            "",
+            "# ==================== 日志 ====================",
+            "",
+            "[ErisPulse.logger]",
+            'level = "INFO"                # 日志级别: DEBUG/INFO/WARNING/ERROR',
+            "log_files = []                # 日志文件列表, 如 [\"logs/app.log\"]",
+            "memory_limit = 1000           # 内存日志条数上限",
+            "",
+            "# ==================== 存储 ====================",
+            "",
+            "[ErisPulse.storage]",
+            "use_global_db = false         # 是否使用全局数据库",
+            "",
+            "# ==================== 事件系统 ====================",
+            "",
+            "[ErisPulse.event.message]",
+            "ignore_self = true            # 忽略自身消息",
+            "",
+            "[ErisPulse.event.command]",
+            'prefix = "/"                  # 命令前缀',
+            "case_sensitive = true         # 区分大小写",
+            "allow_space_prefix = false    # 允许前缀前有空格",
+            "must_at_bot = false           # 必须艾特Bot才触发",
+            "",
+            "# ==================== 框架 ====================",
+            "",
+            "[ErisPulse.framework]",
+            "enable_lazy_loading = true    # 启用模块懒加载",
+            "",
+            "# ==================== 配置审计 ====================",
+            "",
+            "[ErisPulse.config.audit]",
+            "enabled = false               # 是否启用配置审计",
+            "max_entries = 1000            # 审计日志最大条数",
+            "",
+            "# ==================== 指标监控 ====================",
+            "",
+            "[ErisPulse.metrics]",
+            "enabled = false               # 是否启用指标采集",
+            "",
+            "# ==================== 路由增强 ====================",
+            "",
+            "[ErisPulse.router.cors]",
+            "enabled = false",
+            'allow_origins = ["*"]',
+            'allow_methods = ["*"]',
+            'allow_headers = ["*"]',
+            "allow_credentials = false",
+            "max_age = 600",
+            "",
+            "[ErisPulse.router.security]",
+            "enabled = false",
+            "",
+            "[ErisPulse.router.security.headers]",
+            'X-Content-Type-Options = "nosniff"',
+            'X-Frame-Options = "DENY"',
+            "",
+            "# ==================== 适配器状态 ====================",
+            "",
+            "[ErisPulse.adapters.status]",
+        ]
+        
+        if adapter_list:
+            for adapter in adapter_list:
+                lines.append(f"# {adapter} = false")
+        else:
+            lines.extend([
+                "# yunhu = false",
+                "# telegram = false",
+                "# onebot11 = false",
+            ])
+        
+        lines.extend([
+            "",
+            "# ==================== 模块状态 ====================",
+            "",
+            "[ErisPulse.modules.status]",
+            "# MyModule = true",
+            "",
+        ])
+        
+        return "\n".join(lines)
+    
     async def _fetch_available_adapters(self):
         """
         从云端获取可用适配器列表