mcsmapi 0.1.3__tar.gz → 0.1.4__tar.gz

{mcsmapi-0.1.3 → mcsmapi-0.1.4}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 molanp
+Copyright (c) 2024-2025 molanp
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{mcsmapi-0.1.3 → mcsmapi-0.1.4}/PKG-INFO

@@ -1,15 +1,16 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.3
+Version: 0.1.4
 Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
 Author-email: molanp <molanpp@outlook.com>
+License-Expression: MIT
 Project-URL: Source, https://github.com/molanp/mcsmapi
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
 Requires-Dist: pydantic
+Dynamic: license-file
 
 # MCSM API
 
@@ -22,6 +23,10 @@ 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 [https://deepwiki.com/molanp/mcsmapi](https://deepwiki.com/molanp/mcsmapi)
+
 ## Introduction
 
 `mcsmapi` is a PyPI package based on [MCSManager](https://github.com/MCSManager/MCSManager), designed to simplify interactions with the MCSM API.
@@ -38,8 +43,8 @@ pip install mcsmapi
 
 ## Supported Features
 
-- [x] Dashboard data ([Overview](doc/en/Overview.md))
-- [x] User management ([User](doc/en/User.md))
+- [x] Dashboard data (`Overview`)
+- [x] User management (`User`)
 - [x] Instance management (`Instance`)
 - [x] Daemon management (`Daemon`)
 - [x] File management (`File`)
@@ -57,7 +62,7 @@ pip install mcsmapi
 from mcsmapi import MCSMAPI
 
 # Initialize
-mcsm = MCSMAPI("https://example.com")
+mcsm = MCSMAPI("https://example.com") # https or http required
 
 # Log in with username and password (API permissions depend on the account permissions)
 mcsm.login("username", "password")

{mcsmapi-0.1.3 → mcsmapi-0.1.4}/README.md

@@ -9,6 +9,10 @@ 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 [https://deepwiki.com/molanp/mcsmapi](https://deepwiki.com/molanp/mcsmapi)
+
 ## Introduction
 
 `mcsmapi` is a PyPI package based on [MCSManager](https://github.com/MCSManager/MCSManager), designed to simplify interactions with the MCSM API.
@@ -25,8 +29,8 @@ pip install mcsmapi
 
 ## Supported Features
 
-- [x] Dashboard data ([Overview](doc/en/Overview.md))
-- [x] User management ([User](doc/en/User.md))
+- [x] Dashboard data (`Overview`)
+- [x] User management (`User`)
 - [x] Instance management (`Instance`)
 - [x] Daemon management (`Daemon`)
 - [x] File management (`File`)
@@ -44,7 +48,7 @@ pip install mcsmapi
 from mcsmapi import MCSMAPI
 
 # Initialize
-mcsm = MCSMAPI("https://example.com")
+mcsm = MCSMAPI("https://example.com") # https or http required
 
 # Log in with username and password (API permissions depend on the account permissions)
 mcsm.login("username", "password")

{mcsmapi-0.1.3 → mcsmapi-0.1.4}/mcsmapi/__init__.py

@@ -1,13 +1,13 @@
 import urllib.parse
-from .models.overview import OverviewModel
-from .pool import ApiPool
-from .apis.file import File
-from .apis.user import User
-from .apis.image import Image
-from .apis.daemon import Daemon
-from .apis.instance import Instance
-from .apis.overview import Overview
-from .request import Request
+from mcsmapi.models.overview import OverviewModel
+from mcsmapi.pool import ApiPool
+from mcsmapi.apis.file import File
+from mcsmapi.apis.user import User
+from mcsmapi.apis.image import Image
+from mcsmapi.apis.daemon import Daemon
+from mcsmapi.apis.instance import Instance
+from mcsmapi.apis.overview import Overview
+from mcsmapi.request import Request
 
 
 class MCSMAPI:

{mcsmapi-0.1.3 → mcsmapi-0.1.4}/mcsmapi/apis/daemon.py

@@ -1,7 +1,7 @@
 from typing import Any
-from ..pool import ApiPool
-from ..request import send
-from ..models.daemon import DaemonConfig
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import send
+from mcsmapi.models.daemon import DaemonConfig
 
 
 class Daemon:
@@ -10,10 +10,10 @@ class Daemon:
         新增一个节点。
 
         参数:
-        - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。
+       <br> - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。
 
         返回:
-        - str: 新增节点的ID
+       <br> - str: 新增节点的ID
         """
         return send(
             "POST",
@@ -26,10 +26,10 @@ class Daemon:
         删除一个节点。
 
         参数:
-        - daemonId (str): 节点的唯一标识符。
+       <br> - daemonId (str): 节点的唯一标识符。
 
         返回:
-        - bool: 删除成功后返回True
+       <br> - bool: 删除成功后返回True
         """
         return send(
             "DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
@@ -40,10 +40,10 @@ class Daemon:
         连接一个节点。
 
         参数:
-        - daemonId (str): 节点的唯一标识符。
+       <br> - daemonId (str): 节点的唯一标识符。
 
         返回:
-        - bool: 连接成功后返回True
+       <br> - bool: 连接成功后返回True
         """
         return send(
             "GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
@@ -56,11 +56,11 @@ class Daemon:
         **不建议直接使用此函数，建议调用overview()后在remote属性内使用updateConfig方法按需更新**
 
         参数:
-        - daemonId (str): 节点的唯一标识符。
-        - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。
+       <br> - daemonId (str): 节点的唯一标识符。
+       <br> - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。
 
         返回:
-        - bool: 更新成功后返回True
+       <br> - bool: 更新成功后返回True
         """
         return send(
             "PUT",

{mcsmapi-0.1.3 → mcsmapi-0.1.4}/mcsmapi/apis/file.py

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

{mcsmapi-0.1.3 → mcsmapi-0.1.4}/mcsmapi/apis/image.py

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