mcsmapi 0.1.5b1__tar.gz → 0.1.6__tar.gz

{mcsmapi-0.1.5b1 → mcsmapi-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.5b1
+Version: 0.1.6
 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)
 
@@ -25,7 +26,13 @@ English|[Chinese Simplified](README_zh-cn.md)
 
 ## Documentation
 
-The documentation is not yet complete, if you need it, please visit [https://deepwiki.com/molanp/mcsmapi](https://deepwiki.com/molanp/mcsmapi)
+The documentation is not yet complete, if you need it, please visit [deepwiki-mcsmapi](https://deepwiki.com/molanp/mcsmapi)
+
+You can also find:  
+
+📄 Work-in-progress docs: [docs](docs)
+
+💡 Example: [example](example)
 
 ## Introduction
 
@@ -41,6 +48,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/workflows/auto-build.yml)
+
 ## Supported Features
 
 - [x] Dashboard data (`Overview`)

{mcsmapi-0.1.5b1 → mcsmapi-0.1.6}/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)
 
@@ -11,7 +12,13 @@ English|[Chinese Simplified](README_zh-cn.md)
 
 ## Documentation
 
-The documentation is not yet complete, if you need it, please visit [https://deepwiki.com/molanp/mcsmapi](https://deepwiki.com/molanp/mcsmapi)
+The documentation is not yet complete, if you need it, please visit [deepwiki-mcsmapi](https://deepwiki.com/molanp/mcsmapi)
+
+You can also find:  
+
+📄 Work-in-progress docs: [docs](docs)
+
+💡 Example: [example](example)
 
 ## Introduction
 
@@ -27,6 +34,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/workflows/auto-build.yml)
+
 ## Supported Features
 
 - [x] Dashboard data (`Overview`)

{mcsmapi-0.1.5b1 → mcsmapi-0.1.6}/mcsmapi/apis/daemon.py

@@ -1,10 +1,37 @@
 from typing import Any
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import send
-from mcsmapi.models.daemon import DaemonConfig
+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 add(self, config: dict[str, Any]) -> str:
         """
         新增一个节点。

{mcsmapi-0.1.5b1 → mcsmapi-0.1.6}/mcsmapi/apis/file.py

@@ -13,6 +13,7 @@ class File:
         target: str = "",
         page: int = 0,
         page_size: int = 100,
+        file_name: str = ""
     ) -> FileList:
         """
         获取文件列表
@@ -23,6 +24,7 @@ class File:
         - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。
         - page (int, 可选): 指定分页的页码。默认为0。
         - page_size (int, 可选): 指定每页的文件数量。默认为100。
+        - file_name (str, 可选): 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
 
         **返回:**
         - FileList: 包含文件列表信息和分页详情的FileList模型。
@@ -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)
@@ -223,8 +226,8 @@ class File:
         **参数:**
         - daemonId (str): 守护进程的唯一标识符。
         - uuid (str): 实例的唯一标识符。
-        - source (str): 需要压缩到的 zip 文件路径。
-        - targets (list): 要压缩的目标文件或文件夹的路径。
+        - source (str): 需要压缩的文件路径。
+        - targets (list): 要压缩到的目标文件的路径。
 
         **返回:**
         - bool: 压缩成功后返回True。

{mcsmapi-0.1.5b1 → mcsmapi-0.1.6}/mcsmapi/apis/instance.py

@@ -229,7 +229,7 @@ class Instance:
         - bool: 返回操作结果，成功时返回True。
         """
         return send(
-            "GET",
+            "POST",
             f"{ApiPool.PROTECTED_INSTANCE}/asynchronous",
             params={"daemonId": daemonId, "uuid": uuid, "task_name": "update"},
         )

{mcsmapi-0.1.5b1 → mcsmapi-0.1.6}/mcsmapi/models/daemon.py

@@ -4,48 +4,89 @@ from mcsmapi.models.instance import InstanceCreateResult
 
 
 class CpuMemChart(BaseModel):
+    """节点资源使用率信息"""
+
+    """cpu使用率"""
     cpu: float = 0
+    """内存使用率"""
     mem: float = 0
 
 
 class ProcessInfo(BaseModel):
+    """节点进程详细信息"""
+
+    """远程节点使用的cpu资源(单位: byte)"""
     cpu: int = 0
+    """远程节点使用的内存资源(单位: byte)"""
     memory: int = 0
+    """远程节点的工作路径"""
     cwd: str = ""
 
 
 class InstanceInfo(BaseModel):
+    """实例统计信息"""
+
+    """运行中实例数量"""
     running: int = 0
+    """全部实例数量"""
     total: int = 0
 
 
 class SystemInfo(BaseModel):
+    """节点系统信息"""
+
+    """系统类型"""
     type: str = ""
+    """主机名"""
     hostname: str = ""
+    """平台架构"""
     platform: str = ""
+    """系统版本"""
     release: str = ""
+    """系统运行时间(单位: sec)"""
     uptime: float = 0
+    """远程节点运行路径"""
     cwd: str = ""
+    """系统负载平均值（仅适用于 Linux 和 macOS），表示过去 **1 分钟、5 分钟、15 分钟** 内的 CPU 负载情况"""
     loadavg: List[float] = []
+    """可用内存(单位: byte)"""
     freemem: int = 0
+    """cpu使用率"""
     cpuUsage: float = 0
+    """内存使用率"""
     memUsage: float = 0
+    """内存总量(单位: byte)"""
     totalmem: int = 0
+    """未知，在MCSM代码中始终为0"""
     processCpu: int = 0
+    """未知，在MCSM代码中始终为0"""
     processMem: int = 0
 
 
 class DaemonModel(BaseModel):
+    """节点详细信息"""
+
+    """远程节点版本"""
     version: str = ""
+    """远程节点的基本信息"""
     process: ProcessInfo = ProcessInfo()
+    """远程节点实例基本信息"""
     instance: InstanceInfo = InstanceInfo()
+    """远程节点系统信息"""
     system: SystemInfo = SystemInfo()
+    """cpu和内存使用趋势"""
     cpuMemChart: List[CpuMemChart] = []
+    """远程节点的uuid"""
     uuid: str = ""
+    """远程节点的ip"""
     ip: str = ""
+    """远程节点的端口"""
     port: int = 24444
+    """远程节点的路径前缀"""
     prefix: str = ""
+    """远程节点的可用状态"""
     available: bool = False
+    """远程节点的备注"""
     remarks: str = ""
 
     def delete(self) -> bool:
@@ -127,8 +168,15 @@ class DaemonModel(BaseModel):
 
 
 class DaemonConfig(BaseModel):
+    """节点配置信息"""
+
+    """远程节点的ip"""
     ip: str = "localhost"
+    """远程节点的端口"""
     port: int = 24444
+    """远程节点的路径前缀"""
     prefix: str = ""
+    """远程节点的备注"""
     remarks: str = "New Daemon"
+    """远程节点的可用状态"""
     available: bool = True

mcsmapi-0.1.6/mcsmapi/models/file.py

@@ -0,0 +1,228 @@
+from pydantic import BaseModel
+from typing import List
+import os
+
+
+class FileItem(BaseModel):
+    """文件信息"""
+
+    """文件名称"""
+    name: str = ""
+    """文件大小(单位: byte)"""
+    size: int = 0  # byte
+    """文件修改时间"""
+    time: str = ""
+    """文件操作权限(仅适用于Linux)"""
+    mode: int = 777  # Linux file permission
+    """文件类型，`0`为文件夹，`1`为文件"""
+    type: int = 0  # 0 = Folder, 1 = File
+    """远程节点uuid"""
+    daemonId: str = ""
+    """实例的uiid"""
+    uuid: str = ""
+    """文件所在路径"""
+    target: str = ""
+    """当前文件列表过滤条件"""
+    file_name: str = ""
+
+    def rename(self, newName: str) -> bool:
+        """
+        重命名该文件或文件夹。
+
+        **参数:**
+        - new_name (str): 源文件或文件夹的新名字。
+
+        **返回:**
+        - bool: 重命名成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().rename(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), newName
+        )
+
+    def delete(self) -> bool:
+        """
+        删除该文件或文件夹。
+
+        **返回:**
+        - bool: 重命名成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().delete(
+            self.daemonId, self.uuid, [os.path.join(self.target, self.name)]
+        )
+
+    def copy(self, target: str) -> bool:
+        from mcsmapi.apis.file import File
+
+        return File().copyOne(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), target
+        )
+
+    def move(self, target: str) -> bool:
+        """
+        移动该文件或文件夹到目标路径。
+
+        **参数:**
+        - target (str): 目标文件或文件夹的路径。
+
+        **返回:**
+        - bool: 移动成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().moveOne(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), target
+        )
+
+    def content(self):
+        """
+        获取文件内容。
+        **返回:**
+        - str | bytes: 文件内容。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().content(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name)
+        )
+
+    def zip(self, targets: list[str]) -> bool:
+        """
+        压缩多个文件或文件夹到指定位置。
+
+        **参数:**
+        - targets (list): 要压缩到的目标文件的路径。
+
+        **返回:**
+        - bool: 压缩成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().zip(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), targets
+        )
+
+    def unzip(self, target: str, code: str = "utf-8") -> bool:
+        """
+        解压缩该 zip 文件到目标位置。
+
+        **参数:**
+        - target (str): 解压到的目标路径。
+        - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。
+            可选值: utf-8, gbk, big5
+
+        **返回:**
+        - bool: 解压成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().unzip(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), target, code
+        )
+
+    def update(self, text: str) -> bool:
+        """
+        更新该文件内容。
+        **参数:**
+        - text (str): 文件内容。
+        **返回:**
+        - bool: 更新成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().update(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), text
+        )
+
+    def download(self) -> str:
+        """
+        下载该文件。
+        **返回:**
+        - str: 文件下载的URL。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().download(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name)
+        )
+
+
+class FileList(BaseModel):
+    """文件列表"""
+
+    """文件信息列表"""
+    items: List[FileItem]
+    """当前页数"""
+    page: int = 0
+    """文件列表单页大小"""
+    pageSize: int = 100
+    """总页数"""
+    total: int = 0
+    """当前路径在远程节点的绝对路径"""
+    absolutePath: str = "\\"
+    """远程节点uuid"""
+    daemonId: str = ""
+    """实例uuid"""
+    uuid: str = ""
+    """文件（名称或目录）路径"""
+    target: str = ""
+
+    def __init__(self, **data: str):
+        super().__init__(**data)
+        for item in self.items:
+            item.daemonId = self.daemonId
+            item.uuid = self.uuid
+            item.target = self.target
+
+    async def upload(self, file: bytes, upload_dir: str) -> bool:
+        """
+        上传文件到实例。
+
+        **参数:**
+        - file (bytes): 要上传的文件内容。
+        - upload_dir (str): 上传文件的目标目录(包含文件名)。
+
+        **返回:**
+        - bool: 返回操作结果，成功时返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return await File().upload(self.daemonId, self.uuid, file, upload_dir)
+
+    def createFile(self, target: str) -> bool:
+        """
+        创建文件。
+
+        **参数:**
+        - target (str): 目标文件的路径，包含文件名。
+
+        **返回:**
+        - bool: 创建成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().createFile(self.daemonId, self.uuid, target)
+
+    def createFloder(self, target: str) -> bool:
+        """
+        创建文件夹
+
+        **参数:**
+        - target (str): 目标文件夹的路径。
+
+        **返回:**
+        - bool: 创建成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().createFloder(self.daemonId, self.uuid, target)
+
+
+class CommonConfig(BaseModel):
+    """文件下载密码"""
+    password: str = ""
+    """文件下载地址"""
+    addr: str = ""

mcsmapi-0.1.6/mcsmapi/models/image.py

@@ -0,0 +1,207 @@
+from typing import List, Optional, Union
+from pydantic import BaseModel
+
+
+class DockerConfig(BaseModel):
+    """容器配置"""
+
+    """容器名称"""
+    containerName: str = ""
+    """镜像名称"""
+    image: str = ""
+    """容器分配内存(单位: MB)"""
+    memory: int = 0  # in MB
+    """容器端口映射"""
+    ports: List[str] = []  # ["25565:25565/tcp"]
+    """额外挂载卷路径"""
+    extraVolumes: List[str] = []
+    """容器可使用的最大磁盘空间(单位: MB)"""
+    maxSpace: Optional[int] = None
+    """网络配置，可以是网络名称或ID"""
+    network: Optional[Union[str, int]] = None
+    """容器的 IO 限制"""
+    io: Optional[Union[str, int]] = None
+    """网络模式(例如: bridge, host)"""
+    networkMode: str = "bridge"
+    """网络别名列表"""
+    networkAliases: List[str] = []
+    """绑定的 CPU 核心"""
+    cpusetCpus: str = ""  # 例如 `0,1`
+    """CPU 使用率(单位: %)"""
+    cpuUsage: int = 100
+    """工作目录"""
+    workingDir: str = ""
+    """环境变量设置"""
+    env: List[str] = []
+
+
+class DockerImageItem(BaseModel):
+    """Docker 镜像信息"""
+
+    """镜像唯一 ID"""
+    Id: str = ""
+    """父镜像 ID"""
+    ParentId: str = ""
+    """镜像仓库标签"""
+    RepoTags: List[str] = []  # 例如 ["ubuntu:latest"]
+    """镜像摘要"""
+    RepoDigests: List[str] = []
+    """镜像创建时间(Unix 时间戳)"""
+    Created: int = 0
+    """镜像大小(单位: 字节)"""
+    Size: int = 0
+    """镜像的虚拟大小"""
+    VirtualSize: int = 0
+    """共享存储空间大小"""
+    SharedSize: int = 0
+    """镜像标签"""
+    Labels: dict[str, str] = {}
+    """依赖该镜像运行的容器数量"""
+    Containers: int = 0
+
+
+class DockerContainerItemPort(BaseModel):
+    """Docker 容器端口映射"""
+
+    """容器内部端口"""
+    PrivatePort: int = 0
+    """映射到宿主机的端口"""
+    PublicPort: Optional[int] = None
+    """端口类型(tcp/udp)"""
+    Type: str = ""
+
+
+class DockerContainerItemNetworkSettingsNetwork(BaseModel):
+    """Docker 容器网络设置信息"""
+
+    """网络 ID"""
+    NetworkID: str = ""
+    """网络端点 ID"""
+    EndpointID: str = ""
+    """网关地址"""
+    Gateway: str = ""
+    """分配的 IP 地址"""
+    IPAddress: str = ""
+    """IP 地址前缀长度"""
+    IPPrefixLen: int = 0
+    """IPv6 网关地址"""
+    IPv6Gateway: str = ""
+    """IPv6 地址"""
+    GlobalIPv6Address: str = ""
+    """IPv6 地址前缀长度"""
+    GlobalIPv6PrefixLen: int = 0
+    """MAC 地址"""
+    MacAddress: str = ""
+
+
+class DockerContainerItemNetworkSettings(BaseModel):
+    """Docker 容器的网络配置信息"""
+
+    """容器连接的所有网络"""
+    Networks: dict[str, DockerContainerItemNetworkSettingsNetwork] = {}
+
+
+class DockerContainerItemMount(BaseModel):
+    """容器挂载点信息"""
+
+    """挂载名称"""
+    Name: str = ""
+    """源路径"""
+    Source: str = ""
+    """目标路径"""
+    Destination: str = ""
+    """驱动类型"""
+    Driver: str = ""
+    """挂载模式"""
+    Mode: str = ""
+    """是否允许读写"""
+    RW: bool = False
+    """传播模式"""
+    Propagation: str = ""
+
+
+class DockerContainerItemHostConfig(BaseModel):
+    """Docker 宿主机配置"""
+
+    """网络模式"""
+    NetworkMode: str = ""
+
+
+class DockerContainerItem(BaseModel):
+    """Docker 容器详细信息"""
+
+    """容器 ID"""
+    Id: str = ""
+    """容器名称列表"""
+    Names: List[str] = []
+    """运行的镜像名称"""
+    Image: str = ""
+    """镜像 ID"""
+    ImageID: str = ""
+    """容器启动命令"""
+    Command: str = ""
+    """容器创建时间(Unix 时间戳)"""
+    Created: int = 0
+    """容器状态"""
+    State: str = ""
+    """容器运行状态描述"""
+    Status: str = ""
+    """端口映射信息"""
+    Ports: List[DockerContainerItemPort] = []
+    """容器标签信息"""
+    Labels: dict[str, str] = {}
+    """读写层大小(单位: 字节)"""
+    SizeRw: int = 0
+    """根文件系统大小(单位: 字节)"""
+    SizeRootFs: int = 0
+    """宿主机配置"""
+    HostConfig: DockerContainerItemHostConfig = DockerContainerItemHostConfig()
+    """容器网络配置"""
+    NetworkSettings: DockerContainerItemNetworkSettings = DockerContainerItemNetworkSettings()
+    """容器挂载信息"""
+    Mounts: List[DockerContainerItemMount] = []
+
+
+class DockerNetworkItemIPAMConfig(BaseModel):
+    """Docker 网络 IPAM 配置信息"""
+
+    """子网地址"""
+    Subnet: str = ""
+
+
+class DockerNetworkItemIPAM(BaseModel):
+    """Docker 网络的 IP 地址管理"""
+
+    """驱动类型"""
+    Driver: str = ""
+    """IPAM 配置"""
+    Config: List[DockerNetworkItemIPAMConfig] = []
+
+
+class DockerNetworkItem(BaseModel):
+    """Docker 网络详细信息"""
+
+    """网络名称"""
+    Name: str = ""
+    """网络 ID"""
+    Id: str = ""
+    """网络创建时间"""
+    Created: str = ""
+    """网络作用范围(local/global)"""
+    Scope: str = ""
+    """网络驱动类型"""
+    Driver: str = ""
+    """是否启用 IPv6"""
+    EnableIPv6: bool = False
+    """是否为内部网络"""
+    Internal: bool = False
+    """是否可附加"""
+    Attachable: bool = False
+    """是否为入口网络"""
+    Ingress: bool = False
+    """IPAM 配置信息"""
+    IPAM: DockerNetworkItemIPAM = DockerNetworkItemIPAM()
+    """网络选项"""
+    Options: dict[str, str] = {}
+    """连接到此网络的容器信息"""
+    Containers: Optional[dict[str, dict]] = {}