mcsmapi 0.1.3__py3-none-any.whl → 0.1.5b1__py3-none-any.whl

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/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:

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
 
@@ -22,7 +22,7 @@ class File:
         - uuid (str): 文件实例的唯一标识符。
         - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。
         - page (int, 可选): 指定分页的页码。默认为0。
-        - page_size (int, 可选): 指定每页的项目数量。默认为100。
+        - page_size (int, 可选): 指定每页的文件数量。默认为100。
 
         **返回:**
         - FileList: 包含文件列表信息和分页详情的FileList模型。

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:

mcsmapi/apis/instance.py

@@ -1,7 +1,7 @@
 from typing import Any
-from ..pool import ApiPool
-from ..request import send
-from ..models.instance import (
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import send
+from mcsmapi.models.instance import (
     InstanceSearchList,
     InstanceDetail,
     InstanceCreateResult,

mcsmapi/apis/overview.py

@@ -1,6 +1,6 @@
-from ..pool import ApiPool
-from ..request import send
-from ..models.overview import OverviewModel
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import send
+from mcsmapi.models.overview import OverviewModel
 
 
 class Overview:

mcsmapi/apis/user.py

@@ -1,7 +1,7 @@
 from typing import Any
-from ..pool import ApiPool
-from ..request import send
-from ..models.user import SearchUserModel, UserConfig
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import send
+from mcsmapi.models.user import SearchUserModel, UserConfig
 
 
 class User:

mcsmapi/models/daemon.py

@@ -1,6 +1,6 @@
 from typing import Any, List
 from pydantic import BaseModel
-from ..models.instance import InstanceCreateResult
+from mcsmapi.models.instance import InstanceCreateResult
 
 
 class CpuMemChart(BaseModel):
@@ -55,7 +55,7 @@ class DaemonModel(BaseModel):
         返回:
         - bool: 删除成功后返回True
         """
-        from ..apis.daemon import Daemon
+        from mcsmapi.apis.daemon import Daemon
 
         return Daemon().delete(self.uuid)
 
@@ -66,7 +66,7 @@ class DaemonModel(BaseModel):
         返回:
         - bool: 链接成功后返回True
         """
-        from ..apis.daemon import Daemon
+        from mcsmapi.apis.daemon import Daemon
 
         return Daemon().link(self.uuid)
 
@@ -80,7 +80,7 @@ class DaemonModel(BaseModel):
         返回:
         - bool: 更新成功后返回True
         """
-        from ..apis.daemon import Daemon
+        from mcsmapi.apis.daemon import Daemon
 
         updated_config = self.dict()
         updated_config.update(config)
@@ -105,7 +105,7 @@ class DaemonModel(BaseModel):
         返回:
         - InstanceCreateResult: 一个包含新创建实例信息的结果对象，内容由InstanceCreateResult模型定义。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
         from .instance import InstanceConfig
 
         return Instance().create(self.uuid, InstanceConfig(**config).dict())
@@ -121,7 +121,7 @@ class DaemonModel(BaseModel):
         返回:
         - list[str]: 删除操作后返回的UUID列表。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         return Instance().delete(self.uuid, uuids, deleteFile)
 

mcsmapi/models/file.py

@@ -23,7 +23,7 @@ class FileItem(BaseModel):
         **返回:**
         - bool: 重命名成功后返回True。
         """
-        from ..apis.file import File
+        from mcsmapi.apis.file import File
 
         return File().rename(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), newName
@@ -36,14 +36,14 @@ class FileItem(BaseModel):
         **返回:**
         - bool: 重命名成功后返回True。
         """
-        from ..apis.file import File
+        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 ..apis.file import File
+        from mcsmapi.apis.file import File
 
         return File().copyOne(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target
@@ -59,7 +59,7 @@ class FileItem(BaseModel):
         **返回:**
         - bool: 移动成功后返回True。
         """
-        from ..apis.file import File
+        from mcsmapi.apis.file import File
 
         return File().moveOne(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target
@@ -77,7 +77,7 @@ class FileItem(BaseModel):
         **返回:**
         - bool: 解压成功后返回True。
         """
-        from ..apis.file import File
+        from mcsmapi.apis.file import File
 
         return File().unzip(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target, code

mcsmapi/models/image.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import List, Optional, Union
 from pydantic import BaseModel
 
 
@@ -9,8 +9,8 @@ class DockerConfig(BaseModel):
     ports: List[str] = ["25565:25565/tcp"]
     extraVolumes: List[str] = []
     maxSpace: Optional[int] = None
-    network: Optional[str] = None
-    io: Optional[str] = None
+    network: Optional[Union[str, int]] = None
+    io: Optional[Union[str, int]] = None
     networkMode: str = "bridge"
     networkAliases: List[str] = []
     cpusetCpus: str = ""

mcsmapi/models/instance.py

@@ -1,6 +1,7 @@
-from typing import List, Dict
+from typing import List, Dict, Optional
 from pydantic import BaseModel
-from .image import DockerConfig
+from mcsmapi.models.file import FileList
+from mcsmapi.models.image import DockerConfig
 
 
 class TerminalOption(BaseModel):
@@ -31,7 +32,7 @@ class InstanceConfig(BaseModel):
     lastDatetime: int = 0
     type: str = "universal"
     tag: List[str] = []
-    endTime: int = 0
+    endTime: Optional[int] = None
     fileCode: str = "gbk"
     processType: str = "docker"
     updateCommand: str = "shutdown -s"
@@ -83,7 +84,7 @@ class InstanceDetail(BaseModel):
         **返回:**
         - str|bool: str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         return Instance().start(self.daemonId, self.instanceUuid)
 
@@ -94,7 +95,7 @@ class InstanceDetail(BaseModel):
         **返回:**
         - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         return Instance().stop(self.daemonId, self.instanceUuid)
 
@@ -105,7 +106,7 @@ class InstanceDetail(BaseModel):
         **返回:**
         - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         return Instance().restart(self.daemonId, self.instanceUuid)
 
@@ -116,7 +117,7 @@ class InstanceDetail(BaseModel):
         **返回:**
         - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         return Instance().kill(self.daemonId, self.instanceUuid)
 
@@ -127,7 +128,7 @@ class InstanceDetail(BaseModel):
         **返回:**
         - str: 被删除的实例的uuid。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         return Instance().delete(self.daemonId, [self.instanceUuid], deleteFile)[0]
 
@@ -138,7 +139,7 @@ class InstanceDetail(BaseModel):
         **返回:**
         - bool: 返回操作结果，成功时返回True。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         return Instance().update(self.daemonId, self.instanceUuid)
 
@@ -152,7 +153,7 @@ class InstanceDetail(BaseModel):
         **返回:**
         - str|bool: 更新成功后返回更新的实例UUID，如果未找到该字段，则默认返回True。
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         updated_config = self.config.dict()
         updated_config.update(config)
@@ -175,12 +176,28 @@ class InstanceDetail(BaseModel):
         **返回:**
         - bool: 返回操作结果，成功时返回True
         """
-        from ..apis.instance import Instance
+        from mcsmapi.apis.instance import Instance
 
         return Instance().reinstall(
             self.daemonId, self.instanceUuid, targetUrl, title, description
         )
 
+    def files(self, target:str = "", page:int=0, page_size:int=100) -> FileList:
+        """
+        获取实例的文件列表。
+
+        **参数:**
+        - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤
+        - page (int, 可选): 指定分页的页码。默认为0。
+        - page_size (int, 可选): 指定每页的文件数量。默认为100。
+
+        **返回:**
+        - FileList: 文件列表。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().show(self.daemonId, self.instanceUuid, target, page, page_size)
+
 
 class InstanceCreateResult(BaseModel):
     instanceUuid: str = ""

mcsmapi/models/overview.py

@@ -1,6 +1,6 @@
 from typing import Dict, List, Optional
 from pydantic import BaseModel
-from .daemon import DaemonModel
+from mcsmapi.models.daemon import DaemonModel
 
 
 class SystemUser(BaseModel):

mcsmapi/models/user.py

@@ -1,6 +1,6 @@
 from typing import Any, List
 from pydantic import BaseModel
-from ..models.instance import InstanceDetail, UserInstancesList
+from mcsmapi.models.instance import InstanceDetail, UserInstancesList
 
 
 class UserModel(BaseModel):
@@ -25,7 +25,7 @@ class UserModel(BaseModel):
         **返回:**
         - bool: 删除成功后返回True。
         """
-        from ..apis.user import User
+        from mcsmapi.apis.user import User
 
         return User().delete([self.uuid])
 
@@ -39,7 +39,7 @@ class UserModel(BaseModel):
         返回:
         - bool: 更新成功后返回True。
         """
-        from ..apis.user import User
+        from mcsmapi.apis.user import User
 
         updated_config = self.dict()
         updated_config.update(config)

{mcsmapi-0.1.3.dist-info → mcsmapi-0.1.5b1.dist-info}/METADATA

@@ -1,15 +1,16 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.3
+Version: 0.1.5b1
 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.5b1.dist-info/RECORD

@@ -0,0 +1,23 @@
+mcsmapi/__init__.py,sha256=Xm0gsQMecMZwD1of9UGOkTan25l_jqrWkG-7mg0YgF4,1514
+mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
+mcsmapi/pool.py,sha256=CoOYbyECp4FoXkzwFN7WgtS3vgZtvWO8e93i18vhOEI,308
+mcsmapi/request.py,sha256=5mCzKgrh4OPFKvBo22kIDpX_D1zqCza1nglYUeGWveg,2618
+mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/apis/daemon.py,sha256=j-MJc484J85Eopm7xUBW37-hJxE2Widl86XsHnCVj80,1978
+mcsmapi/apis/file.py,sha256=LfWcVhU42xkdKfw2penZZwmgr2jPs7oKizdWuInc9a8,10610
+mcsmapi/apis/image.py,sha256=UwVH2LPfPBEADZuoSyyiMrlEc9LL858Z3oidRPaKrvs,2908
+mcsmapi/apis/instance.py,sha256=zibACXlhsMAWW5QjvGCFO5iN0wNEVlnecdnFvLeQTUg,10986
+mcsmapi/apis/overview.py,sha256=4bS3RGSykdQ1JyBTM-I9na6v0SCijEG1CN-WxqabfUo,625
+mcsmapi/apis/user.py,sha256=CBLNWxxNfvnmzoMa1YV3Q33POitYDGyN-hRORoe2JEc,2968
+mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/models/daemon.py,sha256=Jt4xN86U2SWTsshWPh2xVzwnEeEQ5QJ_RlIjwxyP8xk,3557
+mcsmapi/models/file.py,sha256=WpFSq6FiaracGZfhwMmWnYsCtY70c7TkpUdpW4hPmjY,2790
+mcsmapi/models/image.py,sha256=jbi4cZCYtfaG-ca7aeI5DOmXXxWTZYCYDqdkzjtuHhc,2804
+mcsmapi/models/instance.py,sha256=TeGNvZA_hBn0qbuV5xoBrnNpfwPcTjIS6b6xthvfBFc,6340
+mcsmapi/models/overview.py,sha256=TUvAqr_6h7O2ZC-CWngh8xz4zz6a4av66wgNRUN3NLg,1321
+mcsmapi/models/user.py,sha256=dw6INDrPcjT6b3PzBAgHQaVE8G6IZMKm94y6VhlSMIo,1958
+mcsmapi-0.1.5b1.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
+mcsmapi-0.1.5b1.dist-info/METADATA,sha256=hy0ptYUXph8SGp9CFR8gn9qxbcK23WWHgXfH5eWMmoY,2604
+mcsmapi-0.1.5b1.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+mcsmapi-0.1.5b1.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
+mcsmapi-0.1.5b1.dist-info/RECORD,,

{mcsmapi-0.1.3.dist-info → mcsmapi-0.1.5b1.dist-info}/WHEEL

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

{mcsmapi-0.1.3.dist-info → mcsmapi-0.1.5b1.dist-info/licenses}/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.dist-info/RECORD

@@ -1,21 +0,0 @@
-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,,