mcsmapi 0.1.7__tar.gz → 0.1.8__tar.gz

{mcsmapi-0.1.7 → mcsmapi-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.7
+Version: 0.1.8
 Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
 Author-email: molanp <molanpp@outlook.com>
 License-Expression: MIT
@@ -11,7 +11,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
-Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
 Dynamic: license-file
 
 # MCSM API
@@ -23,16 +23,9 @@ Dynamic: license-file
 
 English|[Chinese Simplified](README_zh-cn.md)
 
-> [!important]
-> We need your help, the documentation for this project has not been written yet, if you are willing, please submit pr to help us write the documentation.
-
 ## Documentation
 
-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)
+📄 Docs: [docs](https://mcsmapi.awkchan.top/en/)
 
 💡 Example: [example](example)
 
@@ -50,7 +43,7 @@ You can install `mcsmapi` using `pip`:
 pip install mcsmapi
 ```
 
-If you need the latest build files (untested), please visit
+If you need the latest build files, please visit
 [Actions](https://github.com/molanp/mcsmapi/actions/workflows/auto-build.yml)
 
 ## Supported Features
@@ -65,8 +58,8 @@ If you need the latest build files (untested), please visit
 ## Supported MCSM Versions
 
 | MCSM Version | Support Status |
-| :---: | :---: |
-| 10.x | ✅ |
+| :----------: | :------------: |
+|     10.x     |       ✅       |
 
 ### Quick Example
 
@@ -84,9 +77,10 @@ mcsm.login_with_apikey("apikey")
 
 # Get dashboard data
 overview = mcsm.overview()
+overview_data = overview.overview()
 
 # Get MCSM version
-mcsm_version = mcsm.overview().version
+mcsm_version = overview_data.version
 ```
 
 ## Contributing

{mcsmapi-0.1.7 → mcsmapi-0.1.8}/README.md

@@ -7,16 +7,9 @@
 
 English|[Chinese Simplified](README_zh-cn.md)
 
-> [!important]
-> We need your help, the documentation for this project has not been written yet, if you are willing, please submit pr to help us write the documentation.
-
 ## Documentation
 
-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)
+📄 Docs: [docs](https://mcsmapi.awkchan.top/en/)
 
 💡 Example: [example](example)
 
@@ -34,7 +27,7 @@ You can install `mcsmapi` using `pip`:
 pip install mcsmapi
 ```
 
-If you need the latest build files (untested), please visit
+If you need the latest build files, please visit
 [Actions](https://github.com/molanp/mcsmapi/actions/workflows/auto-build.yml)
 
 ## Supported Features
@@ -49,8 +42,8 @@ If you need the latest build files (untested), please visit
 ## Supported MCSM Versions
 
 | MCSM Version | Support Status |
-| :---: | :---: |
-| 10.x | ✅ |
+| :----------: | :------------: |
+|     10.x     |       ✅       |
 
 ### Quick Example
 
@@ -68,9 +61,10 @@ mcsm.login_with_apikey("apikey")
 
 # Get dashboard data
 overview = mcsm.overview()
+overview_data = overview.overview()
 
 # Get MCSM version
-mcsm_version = mcsm.overview().version
+mcsm_version = overview_data.version
 ```
 
 ## Contributing

{mcsmapi-0.1.7 → mcsmapi-0.1.8}/mcsmapi/__init__.py

@@ -11,14 +11,14 @@ from mcsmapi.request import Request
 
 class MCSMAPI:
 
-    def __init__(self, url: str, timeout: int = 5) -> None:
+    def __init__(self, url: str, timeout: int = 5):
         split_url = urllib.parse.urlsplit(url)
         Request.set_mcsm_url(
             urllib.parse.urljoin(f"{split_url.scheme}://{split_url.netloc}", "")
         )
         Request.set_timeout(timeout)
 
-    def login(self, username: str, password: str) -> "MCSMAPI":
+    def login(self, username: str, password: str):
         Request.set_token(
             Request.send(
                 "POST",
@@ -34,20 +34,26 @@ class MCSMAPI:
         self.authentication = "apikey"
         return self
 
-    def overview(self) -> Overview:
+    @property
+    def overview(self):
         return Overview()
 
-    def instance(self) -> Instance:
+    @property
+    def instance(self):
         return Instance()
 
-    def user(self) -> User:
+    @property
+    def user(self) :
         return User()
 
-    def daemon(self) -> Daemon:
+    @property
+    def daemon(self):
         return Daemon()
 
-    def file(self) -> File:
+    @property
+    def file(self):
         return File()
 
-    def image(self) -> Image:
+    @property
+    def image(self):
         return Image()

mcsmapi-0.1.8/mcsmapi/apis/daemon.py

@@ -0,0 +1,109 @@
+from typing import Any
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import send
+from mcsmapi.models.daemon import (
+    DaemonConfig,
+    DaemonInfo,
+    DaemonSystemInfo,
+    DaemonStatus,
+    DaemonUpdateConfig,
+)
+
+
+class Daemon:
+    @staticmethod
+    def config() -> list[DaemonStatus]:
+        """
+        获取全部节点配置信息
+
+        :returns: 节点的配置信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services_list",
+        )
+        return [DaemonStatus(**daemon) for daemon in daemons]
+
+    @staticmethod
+    def info() -> list[DaemonInfo]:
+        """
+        获取全部节点信息
+
+        :returns: 节点信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services",
+        )
+        return [DaemonInfo(**daemon) for daemon in daemons]
+
+    @staticmethod
+    def system() -> list[DaemonSystemInfo]:
+        """
+        获取全部节点的系统信息
+
+        :returns: 节点系统信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services_system",
+        )
+        return [DaemonSystemInfo(**daemon) for daemon in daemons]
+
+    @staticmethod
+    def add(config: DaemonConfig) -> str:
+        """
+        新增一个节点
+
+        :params config: 节点的配置信息
+
+        :returns: 新增节点的UUID
+        """
+        return send(
+            "POST",
+            f"{ApiPool.SERVICE}/remote_service",
+            data=config.model_dump(),
+        )
+
+    @staticmethod
+    def delete(daemonId: str) -> bool:
+        """
+        删除一个节点
+
+        :params daemonId: 节点的UUID
+
+        :returns: 操作成功后返回True
+        """
+        return send(
+            "DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
+        )
+
+    @staticmethod
+    def link(daemonId: str) -> bool:
+        """
+        连接一个节点
+
+        :params daemonId: 节点的UUID
+
+        :returns: 操作成功后返回True
+        """
+        return send(
+            "GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
+        )
+
+    @staticmethod
+    def update(daemonId: str, config: dict[str, Any]) -> bool:
+        """
+        更新一个节点的配置
+
+        :params daemonId: 节点的UUID
+        :params config: 节点的配置信息，以字典形式提供，缺失内容由DaemonUpdateConfig模型补全
+
+        :returns: 操作成功后返回True
+        """
+        return send(
+            "PUT",
+            f"{ApiPool.SERVICE}/remote_service",
+            params={"uuid": daemonId},
+            data=DaemonUpdateConfig(**config).model_dump(),
+        )

{mcsmapi-0.1.7 → mcsmapi-0.1.8}/mcsmapi/apis/file.py

@@ -1,3 +1,4 @@
+from typing import Literal
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import Request, send, upload
 from mcsmapi.models.file import FileDownloadConfig, FileList
@@ -18,16 +19,14 @@ class File:
         """
         获取文件列表
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。
-        - page (int, 可选): 指定分页的页码。默认为0。
-        - page_size (int, 可选): 指定每页的文件数量。默认为100。
-        - file_name (str, 可选): 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 用于文件过滤的目标路径
+        :params page: 指定分页的页码
+        :params page_size: 指定每页的文件数量
+        :params file_name: 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
 
-        **返回:**
-        - FileList: 包含文件列表信息和分页详情的FileList模型。
+        :returns: 包含文件列表信息和分页详情的FileList模型
         """
         result = send(
             "GET",
@@ -44,17 +43,15 @@ class File:
         return FileList(**result, daemonId=daemonId, uuid=uuid)
 
     @staticmethod
-    def content(daemonId: str, uuid: str, target: str) -> str | bytes:
+    def content(daemonId: str, uuid: str, target: str) -> str:
         """
         获取文件内容
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - target (str): 文件的目标路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 文件的目标路径
 
-        **返回:**
-        - str: 文件的内容信息。
+        :returns: 文件的内容信息
         """
         return send(
             "PUT",
@@ -68,14 +65,12 @@ class File:
         """
         更新文件内容
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - target (str): 文件的目标路径。
-        - text (str): 新的文件内容。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件的路径
+        :params text: 新的文件内容
 
-        **返回:**
-        - bool: 更新成功后返回True。
+        :returns: 操作成功后返回True
         """
         return send(
             "PUT",
@@ -89,13 +84,11 @@ class File:
         """
         下载文件
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - file_name (str): 要下载的文件名。路径+名字, 示例: /backup/world.zip
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params file_name: 要下载的文件的实例内完整路径, eg: /backup/world.zip
 
-        **返回:**
-        - str: 文件下载URL。
+        :returns: 文件下载URL
         """
 
         result = send(
@@ -113,14 +106,12 @@ class File:
         """
         上传文件
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - file (bytes): 要上传的文件内容。
-        - upload_dir (str): 文件上传到的目标路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params file: 要上传的文件内容
+        :params upload_dir: 文件上传到的目标路径
 
-        **返回:**
-        - bool: 上传成功后返回True。
+        :returns: 操作成功后返回True
         """
         result = send(
             "POST",
@@ -135,17 +126,15 @@ class File:
         return True
 
     @staticmethod
-    def copy(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
+    def copy_to(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
         """
-        复制多个文件夹或文件到指定位置。
+        复制多个文件夹或文件到指定位置
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - copy_map (dict): 复制映射，格式为 {源路径: 目标路径}
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params copy_map: 复制映射，格式为 {源路径: 目标路径}
 
-        **返回:**
-        - bool: 上传成功后返回True。
+        :returns: 操作成功后返回True
         """
         targets = [[source, target] for source, target in copy_map.items()]
         return send(
@@ -158,31 +147,27 @@ class File:
     @staticmethod
     def copyOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
         """
-        复制单个文件或文件夹到指定位置。
+        复制单个文件或文件夹到指定位置
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 源文件或文件夹的路径。
-        - target (str): 目标文件或文件夹的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params target: 目标文件或文件夹的路径
 
-        **返回:**
-        - bool: 移动成功后返回True。
+        :returns: 操作成功后返回True
         """
-        return File.copy(daemonId, uuid, {source: target})
+        return File.copy_to(daemonId, uuid, {source: target})
 
     @staticmethod
     def move(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
         """
-        移动多个文件或文件夹到指定位置。
+        移动多个文件或文件夹到指定位置
 
-        参数:
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - copy_map (dict): 移动映射，格式为 {源路径: 目标路径}
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params copy_map: 移动映射，格式为 {源路径: 目标路径}
 
-        返回:
-        - bool: 移动成功后返回True。
+        :returns: 操作成功后返回True
         """
         targets = [[source, target] for source, target in copy_map.items()]
         return send(
@@ -195,32 +180,28 @@ class File:
     @staticmethod
     def moveOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
         """
-        从源路径移动单个文件或文件夹到目标路径。
+        从源路径移动单个文件或文件夹到目标路径
 
-        参数:
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 源文件或文件夹的路径。
-        - target (str): 目标文件或文件夹的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params target: 目标文件或文件夹的路径
 
-        返回:
-        - bool: 移动成功后返回True。
+        :returns: 操作成功后返回True
         """
         return File.move(daemonId, uuid, {source: target})
 
     @staticmethod
     def rename(daemonId: str, uuid: str, source: str, new_name: str) -> bool:
         """
-        重命名单个文件或文件夹。
+        重命名单个文件或文件夹
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 源文件或文件夹的路径。
-        - new_name (str): 源文件或文件夹的新名字。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params new_name: 源文件或文件夹的新名字
 
-        **返回:**
-        - bool: 重命名成功后返回True。
+        :returns: 操作成功后返回True
         """
         directory = os.path.dirname(source)
         target = os.path.join(directory, new_name)
@@ -229,16 +210,14 @@ class File:
     @staticmethod
     def zip(daemonId: str, uuid: str, source: str, targets: list[str]) -> bool:
         """
-        压缩多个文件或文件夹到指定位置。
+        压缩多个文件或文件夹到指定位置
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 需要压缩的文件路径。
-        - targets (list): 要压缩到的目标文件的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 要压缩到的目标文件的路径
+        :params targets: 需要压缩的文件路径
 
-        **返回:**
-        - bool: 压缩成功后返回True。
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",
@@ -249,41 +228,40 @@ class File:
 
     @staticmethod
     def unzip(
-        daemonId: str, uuid: str, source: str, target: str, code: str = "utf-8"
+        daemonId: str,
+        uuid: str,
+        source: str,
+        targets: str,
+        code: Literal["utf-8", "gbk", "big5"] = "utf-8",
     ) -> bool:
         """
-        解压缩指定的zip文件到目标位置。
-
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 需要解压的zip文件路径。
-        - target (str): 解压到的目标路径。
-        - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。
-            可选值: utf-8, gbk, big5
-
-        **返回:**
-        - bool: 解压成功后返回True。
+        解压缩指定的zip文件到目标位置
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 需要解压的zip文件路径
+        :params targets: 解压到的目标路径
+        :params code: 压缩文件的编码方式
+
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",
             f"{ApiPool.FILE}/compress",
             params={"daemonId": daemonId, "uuid": uuid},
-            data={"type": 2, "code": code, "source": source, "targets": target},
+            data={"type": 2, "code": code, "source": source, "targets": targets},
         )
 
     @staticmethod
     def delete(daemonId: str, uuid: str, targets: list[str]) -> bool:
         """
-        删除多个文件或文件夹。
+        删除多个文件或文件夹
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - targets (list): 要删除的文件或文件夹的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params targets: 要删除的文件或文件夹的路径
 
-        **返回:**
-        - bool: 删除成功后返回True。
+        :returns: 操作成功后返回True
         """
         return send(
             "DELETE",
@@ -295,15 +273,13 @@ class File:
     @staticmethod
     def createFile(daemonId: str, uuid: str, target: str) -> bool:
         """
-        创建文件。
+        创建文件
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - target (str): 目标文件的路径，包含文件名。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件的路径，包含文件名
 
-        **返回:**
-        - bool: 创建成功后返回True。
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",
@@ -317,13 +293,11 @@ class File:
         """
         创建文件夹
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - target (str): 目标文件夹的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件夹的路径
 
-        **返回:**
-        - bool: 创建成功后返回True。
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",