mcsmapi 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

mcsmapi/models/image.py

@@ -0,0 +1,112 @@
+from typing import List, Optional
+from pydantic import BaseModel
+
+
+class DockerConfig(BaseModel):
+    containerName: str = ""
+    image: str = "mcsm-ubuntu:22.04"
+    memory: int = 1024  # in MB
+    ports: List[str] = ["25565:25565/tcp"]
+    extraVolumes: List[str] = []
+    maxSpace: Optional[int] = None
+    network: Optional[str] = None
+    io: Optional[str] = None
+    networkMode: str = "bridge"
+    networkAliases: List[str] = []
+    cpusetCpus: str = ""
+    cpuUsage: int = 100
+    workingDir: str = ""
+    env: List[str] = []
+
+
+class DockerImageItem(BaseModel):
+    Id: str = ""
+    ParentId: str = ""
+    RepoTags: List[str] = []
+    RepoDigests: List[str] = []
+    Created: int = 0
+    Size: int = 0
+    VirtualSize: int = 0
+    SharedSize: int = 0
+    Labels: dict[str, str] = {}
+    Containers: int = 0
+
+
+class DockerContainerItemPort(BaseModel):
+    PrivatePort: int = 0
+    PublicPort: Optional[int] = None
+    Type: str = ""
+
+
+class DockerContainerItemNetworkSettingsNetwork(BaseModel):
+    NetworkID: str = ""
+    EndpointID: str = ""
+    Gateway: str = ""
+    IPAddress: str = ""
+    IPPrefixLen: int = 0
+    IPv6Gateway: str = ""
+    GlobalIPv6Address: str = ""
+    GlobalIPv6PrefixLen: int = 0
+    MacAddress: str = ""
+
+
+class DockerContainerItemNetworkSettings(BaseModel):
+    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):
+    NetworkMode: str = ""
+
+
+class DockerContainerItem(BaseModel):
+    Id: str = ""
+    Names: List[str] = []
+    Image: str = ""
+    ImageID: str = ""
+    Command: str = ""
+    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):
+    Subnet: str = ""
+
+
+class DockerNetworkItemIPAM(BaseModel):
+    Driver: str = ""
+    Config: List[DockerNetworkItemIPAMConfig] = []
+
+
+class DockerNetworkItem(BaseModel):
+    Name: str = ""
+    Id: str = ""
+    Created: str = ""
+    Scope: str = ""
+    Driver: str = ""
+    EnableIPv6: bool = False
+    Internal: bool = False
+    Attachable: bool = False
+    Ingress: bool = False
+    IPAM: DockerNetworkItemIPAM = DockerNetworkItemIPAM()
+    Options: dict[str, str]
+    Containers: Optional[dict[str, dict]] = {}

mcsmapi/models/instance.py

@@ -0,0 +1,204 @@
+from typing import List, Dict
+from pydantic import BaseModel
+from .image import DockerConfig
+
+
+class TerminalOption(BaseModel):
+    haveColor: bool = False
+    pty: bool = True
+
+
+class EventTask(BaseModel):
+    autoStart: bool = False
+    autoRestart: bool = True
+    ignore: bool = False
+
+
+class PingConfig(BaseModel):
+    ip: str = ""
+    port: int = 25565
+    type: int = 1
+
+
+class InstanceConfig(BaseModel):
+    nickname: str = "New Name"
+    startCommand: str = "cmd.exe"
+    stopCommand: str = "^C"
+    cwd: str = ""
+    ie: str = "gbk"  # 输入编码
+    oe: str = "gbk"  # 输出编码
+    createDatetime: int = 0
+    lastDatetime: int = 0
+    type: str = "universal"
+    tag: List[str] = []
+    endTime: int = 0
+    fileCode: str = "gbk"
+    processType: str = "docker"
+    updateCommand: str = "shutdown -s"
+    actionCommandList: List[str] = []
+    crlf: int = 2
+    docker: "DockerConfig" = DockerConfig()
+    enableRcon: bool = True
+    rconPassword: str = ""
+    rconPort: int = 2557
+    rconIp: str = ""
+    terminalOption: TerminalOption = TerminalOption()
+    eventTask: EventTask = EventTask()
+    pingConfig: PingConfig = PingConfig()
+
+
+class ProcessInfo(BaseModel):
+    cpu: int = 0
+    memory: int = 0
+    ppid: int = 0
+    pid: int = 0
+    ctime: int = 0
+    elapsed: int = 0
+    timestamp: int = 0
+
+
+class InstanceInfo(BaseModel):
+    currentPlayers: int = -1
+    fileLock: int = 0
+    maxPlayers: int = -1
+    openFrpStatus: bool = False
+    playersChart: List[Dict] = []
+    version: str = ""
+
+
+class InstanceDetail(BaseModel):
+    config: InstanceConfig = InstanceConfig()
+    info: InstanceInfo = InstanceInfo()
+    daemonId: str = ""
+    instanceUuid: str = ""
+    processInfo: ProcessInfo = ProcessInfo()
+    space: int = 0
+    started: int = 0  # 启动次数
+    status: int = 0  # -1 = 忙碌, 0 = 停止, 1 = 停止中, 2 = 启动中, 3 = 运行中
+
+    def start(self) -> str | bool:
+        """
+        启动该实例。
+
+        **返回:**
+        - str|bool: str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        """
+        from ..apis.instance import Instance
+
+        return Instance().start(self.daemonId, self.instanceUuid)
+
+    def stop(self) -> str | bool:
+        """
+        停止该实例。
+
+        **返回:**
+        - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        """
+        from ..apis.instance import Instance
+
+        return Instance().stop(self.daemonId, self.instanceUuid)
+
+    def restart(self) -> str | bool:
+        """
+        重启该实例。
+
+        **返回:**
+        - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        """
+        from ..apis.instance import Instance
+
+        return Instance().restart(self.daemonId, self.instanceUuid)
+
+    def kill(self) -> str | bool:
+        """
+        强制关闭该实例。
+
+        **返回:**
+        - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        """
+        from ..apis.instance import Instance
+
+        return Instance().kill(self.daemonId, self.instanceUuid)
+
+    def delete(self, deleteFile=False) -> str:
+        """
+        删除该实例。
+
+        **返回:**
+        - str: 被删除的实例的uuid。
+        """
+        from ..apis.instance import Instance
+
+        return Instance().delete(self.daemonId, [self.instanceUuid], deleteFile)[0]
+
+    def update(self) -> bool:
+        """
+        升级实例。
+
+        **返回:**
+        - bool: 返回操作结果，成功时返回True。
+        """
+        from ..apis.instance import Instance
+
+        return Instance().update(self.daemonId, self.instanceUuid)
+
+    def updateConfig(self, config: dict) -> str | bool:
+        """
+        更新该实例配置。
+
+        **参数:**
+        - config (dict): 新的实例配置，以字典形式提供，缺失内容由使用原实例配置填充。
+
+        **返回:**
+        - str|bool: 更新成功后返回更新的实例UUID，如果未找到该字段，则默认返回True。
+        """
+        from ..apis.instance import Instance
+
+        updated_config = self.config.dict()
+        updated_config.update(config)
+
+        instance_config = InstanceConfig(**updated_config).dict()
+
+        return Instance().updateConfig(
+            self.daemonId, self.instanceUuid, instance_config
+        )
+
+    def reinstall(self, targetUrl: str, title: str = "", description: str = "") -> bool:
+        """
+        重装实例。
+
+        **参数:**
+        - targetUrl (str): 重装文件的目标URL。
+        - title (str): 重装文件的标题。
+        - description (str, optional): 重装文件的描述，默认为空字符串。
+
+        **返回:**
+        - bool: 返回操作结果，成功时返回True
+        """
+        from ..apis.instance import Instance
+
+        return Instance().reinstall(
+            self.daemonId, self.instanceUuid, targetUrl, title, description
+        )
+
+
+class InstanceCreateResult(BaseModel):
+    instanceUuid: str = ""
+    config: InstanceConfig = InstanceConfig()
+
+
+class InstanceSearchList(BaseModel):
+    pageSize: int = 0
+    maxPage: int = 0
+    data: List[InstanceDetail] = []
+    daemonId: str = ""
+
+    def __init__(self, **data: str):
+        super().__init__(**data)
+        for instance in self.data:
+            instance.daemonId = self.daemonId
+
+
+class UserInstancesList(BaseModel):
+    instanceUuid: str = ""
+    daemonId: str = ""

mcsmapi/models/overview.py

@@ -0,0 +1,63 @@
+from typing import Dict, List, Optional
+from pydantic import BaseModel
+from .daemon import DaemonModel
+
+
+class SystemUser(BaseModel):
+    uid: int = 0
+    gid: int = 0
+    username: str = ""
+    homedir: str = ""
+    shell: Optional[str] = None
+
+
+class SystemInfo(BaseModel):
+    user: SystemUser = SystemUser()
+    time: int = 0
+    totalmem: int = 0
+    freemem: int = 0
+    type: str = ""
+    version: str = ""
+    node: str = ""
+    hostname: str = ""
+    loadavg: List[float] = []
+    platform: str = ""
+    release: str = ""
+    uptime: float = 0
+    cpu: float = 0
+
+
+
+class RecordInfo(BaseModel):
+    logined: int = 0
+    illegalAccess: int = 0
+    banips: int = 0
+    loginFailed: int = 0
+
+
+class ChartInfo(BaseModel):
+    system: List[Dict[str, float]] = []
+    request: List[Dict[str, int]] = []
+
+
+class ProcessInfo(BaseModel):
+    cpu: int = 0
+    memory: int = 0
+    cwd: str = ""
+
+
+class RemoteCountInfo(BaseModel):
+    total: int = 0
+    available: int = 0
+
+
+class OverviewModel(BaseModel):
+    version: str = ""
+    specifiedDaemonVersion: str = ""
+    system: SystemInfo = SystemInfo()
+    record: RecordInfo = RecordInfo()
+    process: ProcessInfo = ProcessInfo()
+    chart: ChartInfo = ChartInfo()
+    remoteCount: RemoteCountInfo = RemoteCountInfo()
+    remote: List["DaemonModel"] = []
+

mcsmapi/models/user.py

@@ -0,0 +1,76 @@
+from typing import Any, List
+from pydantic import BaseModel
+from ..models.instance import InstanceDetail, UserInstancesList
+
+
+class UserModel(BaseModel):
+    uuid: str = ""
+    userName: str = ""
+    passWord: str = ""
+    passWordType: int = 0
+    salt: str = ""
+    permission: int = 1  # 1=用户, 10=管理员, -1=被封禁的用户
+    registerTime: str = ""
+    loginTime: str = ""
+    apiKey: str = ""
+    isInit: bool = False
+    secret: str = ""
+    open2FA: bool = False
+    instances: List["UserInstancesList"] = []
+
+    def delete(self) -> bool:
+        """
+        删除该用户。
+
+        **返回:**
+        - bool: 删除成功后返回True。
+        """
+        from ..apis.user import User
+
+        return User().delete([self.uuid])
+
+    def update(self, config: dict[str, Any]) -> bool:
+        """
+        更新该用户的信息。
+
+        参数:
+        - config (dict[str, Any]): 用户的新信息，以字典形式提供，缺失内容使用原用户信息填充。
+
+        返回:
+        - bool: 更新成功后返回True。
+        """
+        from ..apis.user import User
+
+        updated_config = self.dict()
+        updated_config.update(config)
+        # 过滤用户信息中不需要的字段
+        user_config_dict = {
+            key: updated_config[key]
+            for key in UserConfig.__fields__.keys()
+            if key in updated_config
+        }
+
+        user_config = UserConfig(**user_config_dict).dict()
+
+        return User().update(self.uuid, user_config)
+
+
+class SearchUserModel(BaseModel):
+    total: int = 0
+    page: int = 0
+    page_size: int = 0
+    max_page: int = 0
+    data: List[UserModel] = []
+
+
+class UserConfig(BaseModel):
+    uuid: str
+    userName: str
+    loginTime: str
+    registerTime: str
+    instances: List[InstanceDetail]
+    permission: int  # 1=用户, 10=管理员, -1=被封禁的用户
+    apiKey: str
+    isInit: bool
+    secret: str
+    open2FA: bool

mcsmapi/pool.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class ApiPool(Enum):
+    def __str__(self):
+        return self.value
+
+    AUTH = "api/auth"
+    OVERVIEW = "api/overview"
+    INSTANCE = "api/instance"
+    PROTECTED_INSTANCE = "api/protected_instance"
+    SERVICE = "api/service"
+    FILE = "api/files"
+    IMAGE = "api/environment"

mcsmapi/request.py

@@ -0,0 +1,94 @@
+from typing import Any
+import requests
+import urllib.parse
+from .exceptions import MCSMError
+
+
+class Request:
+    mcsm_url = ""
+    timeout = 5
+    session = requests.Session()
+    apikey = None
+    token = None
+
+    @classmethod
+    def set_mcsm_url(cls, url):
+        """设置类级别的 mcsm_url"""
+        cls.mcsm_url = url
+
+    @classmethod
+    def set_timeout(cls, timeout):
+        """设置类级别的 timeout"""
+        cls.timeout = timeout
+
+    @classmethod
+    def set_apikey(cls, apikey):
+        """设置类级别的 apikey"""
+        cls.apikey = apikey
+
+    @classmethod
+    def set_token(cls, token):
+        """设置类级别的 token"""
+        cls.token = token
+
+    @classmethod
+    def __init__(cls, mcsm_url=None, timeout=None):
+        """初始化时使用类变量，或者使用传入的参数覆盖默认值"""
+        cls.mcsm_url = mcsm_url or cls.mcsm_url
+        cls.timeout = timeout or cls.timeout
+
+    @classmethod
+    def send(cls, method: str, endpoint: Any, params=None, data=None) -> Any:
+        """发送 HTTP 请求"""
+        if params is None:
+            params = {}
+        if data is None:
+            data = {}
+        if not isinstance(endpoint, str):
+            endpoint = str(endpoint)
+
+        url = urllib.parse.urljoin(cls.mcsm_url, endpoint)
+        if cls.apikey is not None:
+            params["apikey"] = cls.apikey
+            data["apikey"] = cls.apikey
+        if cls.token is not None:
+            params["token"] = cls.token
+            data["token"] = cls.token
+
+        response = cls.session.request(
+            method.upper(),
+            url,
+            params=params,
+            data=data,
+            timeout=cls.timeout,
+        )
+        try:
+            response.raise_for_status()
+            return response.json()["data"]
+        except requests.exceptions.HTTPError as e:
+            raise MCSMError(
+                response.status_code, response.json().get("data", response.text)
+            ) from e
+
+    @classmethod
+    async def upload(cls, url: str, file: bytes) -> bool:
+        """上传文件"""
+
+        response = cls.session.request(
+            "POST",
+            url,
+            headers={"Content-Type": "multipart/form-data"},
+            files={"file": file},
+            timeout=cls.timeout,
+        )
+        try:
+            response.raise_for_status()
+            return True
+        except requests.exceptions.HTTPError as e:
+            raise MCSMError(
+                response.status_code, response.json().get("data", response.text)
+            ) from e
+
+
+send = Request().send
+upload = Request().upload

mcsmapi-0.1.3.dist-info/METADATA

@@ -0,0 +1,83 @@
+Metadata-Version: 2.2
+Name: mcsmapi
+Version: 0.1.3
+Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
+Author-email: molanp <molanpp@outlook.com>
+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
+
+# MCSM API
+
+![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)
+
+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.
+
+## Introduction
+
+`mcsmapi` is a PyPI package based on [MCSManager](https://github.com/MCSManager/MCSManager), designed to simplify interactions with the MCSM API.
+
+With this library, you can more easily access and operate the various features provided by MCSM.
+
+## Installation
+
+You can install `mcsmapi` using `pip`:
+
+```bash
+pip install mcsmapi
+```
+
+## Supported Features
+
+- [x] Dashboard data ([Overview](doc/en/Overview.md))
+- [x] User management ([User](doc/en/User.md))
+- [x] Instance management (`Instance`)
+- [x] Daemon management (`Daemon`)
+- [x] File management (`File`)
+- [x] Image management (`Image`)
+
+## Supported MCSM Versions
+
+| MCSM Version | Support Status |
+| :---: | :---: |
+| 10.x | ✅ |
+
+### Quick Example
+
+```python
+from mcsmapi import MCSMAPI
+
+# Initialize
+mcsm = MCSMAPI("https://example.com")
+
+# Log in with username and password (API permissions depend on the account permissions)
+mcsm.login("username", "password")
+
+# Log in with API key (API permissions depend on the API key permissions)
+mcsm.login_with_apikey("apikey")
+
+# Get dashboard data
+overview = mcsm.overview()
+
+# Get MCSM version
+mcsm_version = mcsm.overview().version
+```
+
+## Contributing
+
+If you encounter any issues or have suggestions for improvements, feel free to submit an [Issue](https://github.com/molanp/mcsmapi/issues) or create a [Pull Request](https://github.com/molanp/mcsmapi/pulls).
+
+## License
+
+`mcsmapi` is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+
+Please refer to the [LICENSE](LICENSE) file for more details.

mcsmapi-0.1.3.dist-info/RECORD

@@ -0,0 +1,21 @@
+mcsmapi/__init__.py,sha256=MUAbGnG0qSVKcG9YTCkZru42x1UxcfzfJF9WJzDjU8Q,1451
+mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
+mcsmapi/pool.py,sha256=CoOYbyECp4FoXkzwFN7WgtS3vgZtvWO8e93i18vhOEI,308
+mcsmapi/request.py,sha256=5mCzKgrh4OPFKvBo22kIDpX_D1zqCza1nglYUeGWveg,2618
+mcsmapi/apis/daemon.py,sha256=a0351ca2I68S2lFRg5wtV52FuLsaT-_dnqhuBXpE-tQ,1960
+mcsmapi/apis/file.py,sha256=UKD295UK9755Y_fEANZCxPyS9uwpkJ6KcqnNlM2YHMY,10592
+mcsmapi/apis/image.py,sha256=kGuO2U3D3OM8p1jo31U3ACKv-DD-60pkhn1LNiEhhM4,2890
+mcsmapi/apis/instance.py,sha256=GTSMSfwaYElrSO3DO4IBbU8OJvd1A34DzgsL_xgU6I0,10968
+mcsmapi/apis/overview.py,sha256=tBiZZEXVQukzMqw3EvAVbjkG6h2KO115ylpNRONSJ9s,607
+mcsmapi/apis/user.py,sha256=Xza7jAmy8ORkeO2NS-nzKPkG5Immp4FUtskEN0Hd9Z4,2950
+mcsmapi/models/daemon.py,sha256=u7leIa_91eVeia00rhD8HiYiaRKFCOiWFtqSI4WEC2g,3521
+mcsmapi/models/file.py,sha256=qI_3e5C7cHUc0botBP7YWU90J-Uu2-JILzBTQ-PicRA,2760
+mcsmapi/models/image.py,sha256=akx0b7aUnpl-9F2AHUbkinUP15hLHAnSdLlZZxM3bcI,2773
+mcsmapi/models/instance.py,sha256=eDQng8BAVep_ufDYbLHc-sM5JIPn0-AeNqgkOh8wFEM,5595
+mcsmapi/models/overview.py,sha256=kImr_Dy1Mkyf2jJ7bq5E5IAYGyEYzHZ7inrRNxV0u6k,1307
+mcsmapi/models/user.py,sha256=CDJjiG9cY8gW4rYD8SDnxvMGnn1cdeUU801NucPfnrA,1940
+mcsmapi-0.1.3.dist-info/LICENSE,sha256=kn0yZGn5uLIJtr2aAXy8pz_wJqal15ZGnynTU1fCnLQ,1063
+mcsmapi-0.1.3.dist-info/METADATA,sha256=CgoVwe46VfW-2efVTqnpYXcKwic8DhaPOqGkO-o3rVI,2456
+mcsmapi-0.1.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+mcsmapi-0.1.3.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
+mcsmapi-0.1.3.dist-info/RECORD,,

{mcsmapi-0.1.1.dist-info → mcsmapi-0.1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any