Update docs: README + project structure for v0.6
This commit is contained in:
+44
-63
@@ -1,75 +1,56 @@
|
||||
SenSu/
|
||||
├── main.py # 框架主入口 (--headless 参数)
|
||||
├── service_manager.py # 服务管理器 (依赖注入 + 健康检查)
|
||||
├── requirements.txt # Python 依赖 (版本锁定)
|
||||
├── service_manager.py # 服务管理器 (健康检查 + 启动顺序)
|
||||
├── requirements.txt # Python 依赖
|
||||
├── README.md # 项目说明
|
||||
├── ROADMAP.md # 开发路线图 (本地)
|
||||
├── LICENSE # Apache 2.0
|
||||
├── Dockerfile # Docker 镜像
|
||||
│
|
||||
├── sdk/ # 插件开发工具包
|
||||
│ ├── plugin_command_decorator.py # @plugin_command 装饰器
|
||||
│ ├── plugin_status.py # PluginStatus 枚举 (9 状态)
|
||||
│ └── plugin_error.py # PluginError 异常层级 (6 类)
|
||||
│ ├── plugin_command_decorator.py
|
||||
│ ├── plugin_status.py # 9 状态枚举
|
||||
│ ├── plugin_error.py # 6 异常层级
|
||||
│ └── plugin_web.py # Web 控制面板 Mixin (NEW v0.6)
|
||||
│
|
||||
├── services/ # 核心服务 (15 个)
|
||||
│ ├── init_service.py # 初始化 + 调试服务器自启
|
||||
│ ├── log_service.py # 日志 (多输出, 切割, TUI捕获)
|
||||
│ ├── tui_service.py # Textual TUI (4栏 + 系统监控)
|
||||
│ ├── command_service.py # 命令系统 (注册/历史/补全)
|
||||
│ ├── auth_service.py # 认证 (PBKDF2, Token)
|
||||
│ ├── internet_service.py # HTTP + WebSocket
|
||||
│ ├── plugin_service.py # 插件管理 (热加载, 状态追踪)
|
||||
│ ├── permission_service.py # 权限验证 (4级, 通配符)
|
||||
│ ├── api_service.py # API 端点
|
||||
│ ├── shutdown_service.py # 优雅关闭
|
||||
│ ├── sensu_db.py # SQLite 持久化 (5表)
|
||||
│ ├── project_service.py # 项目注册表 + 依赖解析
|
||||
│ ├── process_isolated.py # 插件进程隔离
|
||||
│ ├── sysmon_widget.py # TUI 系统监控组件
|
||||
│ └── web_panel/ # Web 管理面板
|
||||
│ ├── manager.py # 路由注册
|
||||
│ ├── auth.py # 面板认证
|
||||
│ ├── routes/ # API 路由 (auth/status/plugins/commands/logs)
|
||||
│ └── utils/ # 工具 (auth/system_info/response)
|
||||
├── services/ # 核心服务 (17 个)
|
||||
│ ├── init_service.py
|
||||
│ ├── log_service.py
|
||||
│ ├── tui_service.py # TUI + 系统监控 + Tab补全
|
||||
│ ├── command_service.py
|
||||
│ ├── auth_service.py # PBKDF2-SHA256
|
||||
│ ├── internet_service.py # HTTP :4200 + WS :4240
|
||||
│ ├── plugin_service.py # 热加载 + 状态追踪
|
||||
│ ├── permission_service.py
|
||||
│ ├── api_service.py
|
||||
│ ├── shutdown_service.py
|
||||
│ ├── sensu_db.py # SQLite 5 表 (NEW v0.3)
|
||||
│ ├── project_engine.py # 异步子进程管理 (NEW v0.6)
|
||||
│ ├── project_service.py # 项目注册表 + 依赖解析 (NEW v0.3)
|
||||
│ ├── proxy_service.py # 反向代理 HTTP+WS (NEW v0.6)
|
||||
│ ├── pyenv_manager.py # Python版本+venv+git (NEW v0.6)
|
||||
│ ├── process_isolated.py # 插件进程隔离 (NEW v0.5)
|
||||
│ ├── sysmon_widget.py # TUI 系统监控 (NEW v0.4)
|
||||
│ └── web_panel/ # Web 管理面板
|
||||
│ ├── manager.py
|
||||
│ ├── auth.py
|
||||
│ └── routes/ # API 路由 (8 个模块)
|
||||
│ ├── auth.py, status.py, plugins.py, commands.py, logs.py
|
||||
│ ├── projects.py # 项目管理 (NEW v0.6)
|
||||
│ ├── proxy.py # 反向代理 (NEW v0.6)
|
||||
│ └── plugin_web.py # 插件面板 (NEW v0.6)
|
||||
│
|
||||
├── bridges/ # 消息桥接
|
||||
│ ├── core_bridge.py # 核心桥 (发布-订阅)
|
||||
│ ├── plugin_bridge.py # 插件桥 (subscribe_plugin)
|
||||
│ └── plugin_network_bridge.py # 网络桥 (setup_data_transfer, send_data)
|
||||
│ ├── core_bridge.py
|
||||
│ ├── plugin_bridge.py # subscribe_plugin
|
||||
│ └── plugin_network_bridge.py
|
||||
│
|
||||
├── plugins/ # 插件目录
|
||||
│ └── example_plugin/ # 示例插件 (echo, plugin_status)
|
||||
├── plugins/
|
||||
│ └── example_plugin/ # 示例插件 (命令+Web面板+SSE)
|
||||
│
|
||||
├── tests/ # 测试 (23 个, pytest)
|
||||
│ ├── test_auth.py
|
||||
│ ├── test_service_manager.py
|
||||
│ ├── test_plugin_enhancements.py
|
||||
│ └── test_v03.py
|
||||
│
|
||||
├── deploy/ # 部署文件
|
||||
│ ├── sensu.service # systemd unit
|
||||
│ └── Dockerfile
|
||||
│
|
||||
├── docs/ # 文档
|
||||
│ ├── SenSu 框架基本架构.md
|
||||
│ ├── SenSu 插件开发详细指南.md
|
||||
│ └── 项目文件结构.txt
|
||||
│
|
||||
├── config/ # 运行时配置
|
||||
│ ├── framework/ # 框架配置
|
||||
│ ├── permissions/ # 权限数据
|
||||
│ ├── plugins/ # 插件配置
|
||||
│ └── services/ # 服务配置
|
||||
│
|
||||
├── static/ # 前端静态资源
|
||||
│ └── web_panel/
|
||||
│
|
||||
├── utils/ # 通用工具
|
||||
│ └── async_file_utils.py # 异步文件IO
|
||||
│
|
||||
├── templates/ # 插件模板
|
||||
│ └── plugin/
|
||||
│
|
||||
└── gui/ # GUI 接口 (预留)
|
||||
└── api.py
|
||||
├── tests/ # 28 个测试
|
||||
├── deploy/ # systemd + Dockerfile
|
||||
├── docs/ # 开发文档 + Phase 报告
|
||||
├── static/web_panel/ # 前端 (HTML/CSS/JS)
|
||||
│ └── pages/ # 6 个 WebUI 页面
|
||||
├── utils/, templates/, gui/
|
||||
└── config/ # 运行时配置
|
||||
|
||||
Reference in New Issue
Block a user