mcsmapi 0.1.4__tar.gz → 0.1.5b2__tar.gz

{mcsmapi-0.1.4 → mcsmapi-0.1.5b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.4
+Version: 0.1.5b2
 Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
 Author-email: molanp <molanpp@outlook.com>
 License-Expression: MIT
@@ -17,6 +17,7 @@ Dynamic: license-file
 ![Supported MCSManager Versions](https://img.shields.io/badge/Supported%20MCSManager%20Versions-10.x-blue)
 ![Python Version](https://img.shields.io/badge/Python%20Version-%3E%3D3.7-blue)
 ![PyPI Downloads](https://img.shields.io/pypi/dm/mcsmapi)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/molanp/mcsmapi)
 
 English|[Chinese Simplified](README_zh-cn.md)
 
@@ -41,6 +42,9 @@ You can install `mcsmapi` using `pip`:
 pip install mcsmapi
 ```
 
+If you need the latest build files (untested), please visit
+[Actions](https://github.com/molanp/mcsmapi/actions)
+
 ## Supported Features
 
 - [x] Dashboard data (`Overview`)

{mcsmapi-0.1.4 → mcsmapi-0.1.5b2}/README.md

@@ -3,6 +3,7 @@
 ![Supported MCSManager Versions](https://img.shields.io/badge/Supported%20MCSManager%20Versions-10.x-blue)
 ![Python Version](https://img.shields.io/badge/Python%20Version-%3E%3D3.7-blue)
 ![PyPI Downloads](https://img.shields.io/pypi/dm/mcsmapi)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/molanp/mcsmapi)
 
 English|[Chinese Simplified](README_zh-cn.md)
 
@@ -27,6 +28,9 @@ You can install `mcsmapi` using `pip`:
 pip install mcsmapi
 ```
 
+If you need the latest build files (untested), please visit
+[Actions](https://github.com/molanp/mcsmapi/actions)
+
 ## Supported Features
 
 - [x] Dashboard data (`Overview`)

mcsmapi-0.1.5b2/mcsmapi/apis/daemon.py

@@ -0,0 +1,123 @@
+from typing import Any
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import send
+from mcsmapi.models.daemon import DaemonConfig, DaemonModel
+from mcsmapi.models.daemon.instance import InstanceDetail
+
+
+class Daemon:
+    def show(self) -> list[DaemonConfig]:
+        """
+        获取全部节点配置信息
+
+        返回:
+        - List[DaemonConfig]: 节点的配置信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services_list",
+        )
+        return [DaemonConfig(**daemon) for daemon in daemons]
+        
+    def system(self) -> list[DaemonModel]:
+        """
+        获取全部节点的系统信息
+        
+        返回:
+        - List[DaemonModel]: 节点系统信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services_system",
+        )
+        return [DaemonModel(**daemon) for daemon in daemons]
+    
+    def instances(self, daemonId: str, page: int = 0, page_size: int = 10, instance_name: str = "", status: int = 0, tag: list[str] | None = None) -> list[InstanceDetail]:
+        """
+        查询指定节点下的实例详细信息
+        
+        参数:
+        - `daemonId` (str): 要查询的守护进程（Daemon）的唯一标识符。
+        - `page` (int, 默认=0): 分页查询的页码（从 0 开始）。
+        - `page_size` (int, 默认=10): 每页返回的实例数量。
+        - `instance_name` (str, 默认=""): 过滤指定名称的实例。
+        - `status` (int, 默认=0): 过滤指定状态的实例，如运行中、已停止等。
+        - `tag` (List[str] | None, 默认=None): 根据标签筛选实例（可选参数）。
+      
+        返回:
+        - `List[InstanceDetail]`: 包含实例详细信息的列表。
+      
+        注意:
+        - 此方法尚未实现 (`raise RuntimeError`)，因为 MCSM 官方文档未提供足够的信息。
+        - 由于根据 MCSM 源代码的测试无法获取有效数据，目前无法完成该功能的开发。
+        - 如果你有具体的实现思路，请在 issue 中提出
+        - 可供参考 MCSM 源码: [daemon_router.ts 第 32 行](https://github.com/MCSManager/MCSManager/blob/master/panel%2Fsrc%2Fapp%2Frouters%2Fdaemon_router.ts#L32-L32)
+        - 模型定义代码: https://github.com/MCSManager/MCSManager/blob/master/frontend%2Fsrc%2Fservices%2Fapis%2Findex.ts#L86-L86
+        - 测试地址示例:
+            `http://localhost:23333/api/service/remote_service_instances?apikey=xxx&daemonId=xxx&page=0&page_size=10&status=3&instance_name=`
+        """
+        raise RuntimeError("此方法尚未实现")
+
+    def add(self, config: dict[str, Any]) -> str:
+        """
+        新增一个节点。
+
+        参数:
+        - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。
+
+        返回:
+        - str: 新增节点的ID
+        """
+        return send(
+            "POST",
+            f"{ApiPool.SERVICE}/remote_service",
+            data=DaemonConfig(**config).dict(),
+        )
+
+    def delete(self, daemonId: str) -> bool:
+        """
+        删除一个节点。
+
+        参数:
+        - daemonId (str): 节点的唯一标识符。
+
+        返回:
+        - bool: 删除成功后返回True
+        """
+        return send(
+            "DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
+        )
+
+    def link(self, daemonId: str) -> bool:
+        """
+        连接一个节点。
+
+        参数:
+        - daemonId (str): 节点的唯一标识符。
+
+        返回:
+        - bool: 连接成功后返回True
+        """
+        return send(
+            "GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
+        )
+
+    def update(self, daemonId: str, config: dict[str, Any]) -> bool:
+        """
+        更新一个节点的配置。
+        
+        **不建议直接使用此函数，建议调用overview()后在remote属性内使用updateConfig方法按需更新**
+
+        参数:
+        - daemonId (str): 节点的唯一标识符。
+        - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。
+
+        返回:
+        - bool: 更新成功后返回True
+        """
+        return send(
+            "PUT",
+            f"{ApiPool.SERVICE}/remote_service",
+            params={"uuid": daemonId},
+            data=DaemonConfig(**config).dict(),
+        )

{mcsmapi-0.1.4 → mcsmapi-0.1.5b2}/mcsmapi/apis/file.py

@@ -13,19 +13,21 @@ class File:
         target: str = "",
         page: int = 0,
         page_size: int = 100,
+        file_name: str = ""
     ) -> FileList:
         """
         获取文件列表
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 文件实例的唯一标识符。
-       <br> - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。
-       <br> - page (int, 可选): 指定分页的页码。默认为0。
-       <br> - page_size (int, 可选): 指定每页的项目数量。默认为100。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 文件实例的唯一标识符。
+        - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。
+        - page (int, 可选): 指定分页的页码。默认为0。
+        - page_size (int, 可选): 指定每页的文件数量。默认为100。
+        - file_name (str, 可选): 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
 
         **返回:**
-       <br> - FileList: 包含文件列表信息和分页详情的FileList模型。
+        - FileList: 包含文件列表信息和分页详情的FileList模型。
         """
         result = send(
             "GET",
@@ -36,6 +38,7 @@ class File:
                 "target": target,
                 "page": page,
                 "page_size": page_size,
+                "file_name": file_name,
             },
         )
         return FileList(**result, daemonId=daemonId, uuid=uuid)
@@ -45,12 +48,12 @@ class File:
         获取文件内容
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 文件实例的唯一标识符。
-       <br> - target (str): 文件的目标路径。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 文件实例的唯一标识符。
+        - target (str): 文件的目标路径。
 
         **返回:**
-       <br> - str: 文件的内容信息。
+        - str: 文件的内容信息。
         """
         return send(
             "PUT",
@@ -64,13 +67,13 @@ class File:
         更新文件内容
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 文件实例的唯一标识符。
-       <br> - target (str): 文件的目标路径。
-       <br> - text (str): 新的文件内容。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 文件实例的唯一标识符。
+        - target (str): 文件的目标路径。
+        - text (str): 新的文件内容。
 
         **返回:**
-       <br> - bool: 更新成功后返回True。
+        - bool: 更新成功后返回True。
         """
         return send(
             "PUT",
@@ -84,12 +87,12 @@ class File:
         下载文件
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 文件实例的唯一标识符。
-       <br> - file_name (str): 要下载的文件名。路径+名字, 示例: /backup/world.zip
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 文件实例的唯一标识符。
+        - file_name (str): 要下载的文件名。路径+名字, 示例: /backup/world.zip
 
         **返回:**
-       <br> - str: 文件下载URL。
+        - str: 文件下载URL。
         """
 
         result = send(
@@ -109,13 +112,13 @@ class File:
         上传文件
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 文件实例的唯一标识符。
-       <br> - file (bytes): 要上传的文件内容。
-       <br> - upload_dir (str): 文件上传到的目标路径。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 文件实例的唯一标识符。
+        - file (bytes): 要上传的文件内容。
+        - upload_dir (str): 文件上传到的目标路径。
 
         **返回:**
-       <br> - bool: 上传成功后返回True。
+        - bool: 上传成功后返回True。
         """
         result = send(
             "POST",
@@ -134,12 +137,12 @@ class File:
         复制多个文件夹或文件到指定位置。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 文件实例的唯一标识符。
-       <br> - copy_map (dict): 复制映射，格式为 {源路径: 目标路径}
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 文件实例的唯一标识符。
+        - copy_map (dict): 复制映射，格式为 {源路径: 目标路径}
 
         **返回:**
-       <br> - bool: 上传成功后返回True。
+        - bool: 上传成功后返回True。
         """
         targets = [[source, target] for source, target in copy_map.items()]
         return send(
@@ -154,13 +157,13 @@ class File:
         复制单个文件或文件夹到指定位置。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - source (str): 源文件或文件夹的路径。
-       <br> - target (str): 目标文件或文件夹的路径。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - source (str): 源文件或文件夹的路径。
+        - target (str): 目标文件或文件夹的路径。
 
         **返回:**
-       <br> - bool: 移动成功后返回True。
+        - bool: 移动成功后返回True。
         """
         return self.copy(daemonId, uuid, {source: target})
 
@@ -169,12 +172,12 @@ class File:
         移动多个文件或文件夹到指定位置。
 
         参数:
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - copy_map (dict): 移动映射，格式为 {源路径: 目标路径}
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - copy_map (dict): 移动映射，格式为 {源路径: 目标路径}
 
         返回:
-       <br> - bool: 移动成功后返回True。
+        - bool: 移动成功后返回True。
         """
         targets = [[source, target] for source, target in copy_map.items()]
         return send(
@@ -189,13 +192,13 @@ class File:
         从源路径移动单个文件或文件夹到目标路径。
 
         参数:
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - source (str): 源文件或文件夹的路径。
-       <br> - target (str): 目标文件或文件夹的路径。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - source (str): 源文件或文件夹的路径。
+        - target (str): 目标文件或文件夹的路径。
 
         返回:
-       <br> - bool: 移动成功后返回True。
+        - bool: 移动成功后返回True。
         """
         return self.move(daemonId, uuid, {source: target})
 
@@ -204,13 +207,13 @@ class File:
         重命名单个文件或文件夹。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - source (str): 源文件或文件夹的路径。
-       <br> - new_name (str): 源文件或文件夹的新名字。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - source (str): 源文件或文件夹的路径。
+        - new_name (str): 源文件或文件夹的新名字。
 
         **返回:**
-       <br> - bool: 重命名成功后返回True。
+        - bool: 重命名成功后返回True。
         """
         directory = os.path.dirname(source)
         target = os.path.join(directory, new_name)
@@ -221,13 +224,13 @@ class File:
         压缩多个文件或文件夹到指定位置。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - source (str): 需要压缩到的 zip 文件路径。
-       <br> - targets (list): 要压缩的目标文件或文件夹的路径。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - source (str): 需要压缩的文件路径。
+        - targets (list): 要压缩到的目标文件的路径。
 
         **返回:**
-       <br> - bool: 压缩成功后返回True。
+        - bool: 压缩成功后返回True。
         """
         return send(
             "POST",
@@ -243,15 +246,15 @@ class File:
         解压缩指定的zip文件到目标位置。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - source (str): 需要解压的zip文件路径。
-       <br> - target (str): 解压到的目标路径。
-       <br> - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - source (str): 需要解压的zip文件路径。
+        - target (str): 解压到的目标路径。
+        - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。
             可选值: utf-8, gbk, big5
 
         **返回:**
-       <br> - bool: 解压成功后返回True。
+        - bool: 解压成功后返回True。
         """
         return send(
             "POST",
@@ -265,12 +268,12 @@ class File:
         删除多个文件或文件夹。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - targets (list): 要删除的文件或文件夹的路径。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - targets (list): 要删除的文件或文件夹的路径。
 
         **返回:**
-       <br> - bool: 删除成功后返回True。
+        - bool: 删除成功后返回True。
         """
         return send(
             "DELETE",
@@ -284,12 +287,12 @@ class File:
         创建文件。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - target (str): 目标文件的路径，包含文件名。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - target (str): 目标文件的路径，包含文件名。
 
         **返回:**
-       <br> - bool: 创建成功后返回True。
+        - bool: 创建成功后返回True。
         """
         return send(
             "POST",
@@ -303,12 +306,12 @@ class File:
         创建文件夹
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - target (str): 目标文件夹的路径。
+        - daemonId (str): 守护进程的唯一标识符。
+        - uuid (str): 实例的唯一标识符。
+        - target (str): 目标文件夹的路径。
 
         **返回:**
-       <br> - bool: 创建成功后返回True。
+        - bool: 创建成功后返回True。
         """
         return send(
             "POST",

{mcsmapi-0.1.4 → mcsmapi-0.1.5b2}/mcsmapi/apis/image.py

@@ -9,10 +9,10 @@ class Image:
         获取镜像列表
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
+        - daemonId (str): 守护进程的唯一标识符。
 
         **返回:**
-       <br> - list[ImageModel]: 包含镜像列表详情的 ImageModel 模型的列表。
+        - list[ImageModel]: 包含镜像列表详情的 ImageModel 模型的列表。
         """
         result = send(
             "GET",
@@ -29,10 +29,10 @@ class Image:
         获取容器列表
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
+        - daemonId (str): 守护进程的唯一标识符。
 
         **返回:**
-       <br> - list[DockerContainerItem]: 包含容器列表详情的 DockerContainerItem 模型的列表。
+        - list[DockerContainerItem]: 包含容器列表详情的 DockerContainerItem 模型的列表。
         """
         result = send(
             "GET",
@@ -49,10 +49,10 @@ class Image:
         获取网络接口列表
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
+        - daemonId (str): 守护进程的唯一标识符。
 
         **返回:**
-       <br> - list[DockerNetworkItem]: 包含网络接口列表详情的 DockerNetworkItem 模型的列表。
+        - list[DockerNetworkItem]: 包含网络接口列表详情的 DockerNetworkItem 模型的列表。
         """
         result = send(
             "GET",
@@ -68,13 +68,13 @@ class Image:
         新增一个镜像
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
-       <br> - dockerFile (str): DockerFile Config
-       <br> - name (str): 镜像名称。
-       <br> - tag (str): 镜像版本。
+        - daemonId (str): 守护进程的唯一标识符。
+        - dockerFile (str): DockerFile Config
+        - name (str): 镜像名称。
+        - tag (str): 镜像版本。
 
         **返回:**
-       <br> - bool: 新增镜像成功后返回True。
+        - bool: 新增镜像成功后返回True。
         """
         return send(
             "POST",
@@ -90,10 +90,10 @@ class Image:
         ## **由于文档此部分内容不详，未使用模型**
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符。
+        - daemonId (str): 守护进程的唯一标识符。
 
         **返回:**
-       <br> - dict[str, int]: 包含构建进度信息的字典。
+        - dict[str, int]: 包含构建进度信息的字典。
         """
         return send(
             "GET",