mcsmapi 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

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):
@@ -23,9 +23,9 @@ class UserModel(BaseModel):
         删除该用户。
 
         **返回:**
-        - bool: 删除成功后返回True。
+       <br> - bool: 删除成功后返回True。
         """
-        from ..apis.user import User
+        from mcsmapi.apis.user import User
 
         return User().delete([self.uuid])
 
@@ -34,12 +34,12 @@ class UserModel(BaseModel):
         更新该用户的信息。
 
         参数:
-        - config (dict[str, Any]): 用户的新信息，以字典形式提供，缺失内容使用原用户信息填充。
+       <br> - config (dict[str, Any]): 用户的新信息，以字典形式提供，缺失内容使用原用户信息填充。
 
         返回:
-        - bool: 更新成功后返回True。
+       <br> - bool: 更新成功后返回True。
         """
-        from ..apis.user import User
+        from mcsmapi.apis.user import User
 
         updated_config = self.dict()
         updated_config.update(config)

mcsmapi/request.py

@@ -11,32 +11,34 @@ class Request:
     apikey = None
     token = None
 
-    @staticmethod
-    def set_mcsm_url(url):
+    @classmethod
+    def set_mcsm_url(cls, url):
         """设置类级别的 mcsm_url"""
-        Request.mcsm_url = url
+        cls.mcsm_url = url
 
-    @staticmethod
-    def set_timeout(timeout):
+    @classmethod
+    def set_timeout(cls, timeout):
         """设置类级别的 timeout"""
-        Request.timeout = timeout
+        cls.timeout = timeout
 
-    @staticmethod
-    def set_apikey(apikey):
+    @classmethod
+    def set_apikey(cls, apikey):
         """设置类级别的 apikey"""
-        Request.apikey = apikey
+        cls.apikey = apikey
 
-    @staticmethod
-    def set_token(token):
+    @classmethod
+    def set_token(cls, token):
         """设置类级别的 token"""
-        Request.token = token
+        cls.token = token
 
-    def __init__(self, mcsm_url=None, timeout=None):
+    @classmethod
+    def __init__(cls, mcsm_url=None, timeout=None):
         """初始化时使用类变量，或者使用传入的参数覆盖默认值"""
-        self.mcsm_url = mcsm_url or Request.mcsm_url
-        self.timeout = timeout or Request.timeout
+        cls.mcsm_url = mcsm_url or cls.mcsm_url
+        cls.timeout = timeout or cls.timeout
 
-    def send(self, method: str, endpoint: Any, params=None, data=None) -> Any:
+    @classmethod
+    def send(cls, method: str, endpoint: Any, params=None, data=None) -> Any:
         """发送 HTTP 请求"""
         if params is None:
             params = {}
@@ -45,20 +47,20 @@ class Request:
         if not isinstance(endpoint, str):
             endpoint = str(endpoint)
 
-        url = urllib.parse.urljoin(self.mcsm_url, endpoint)
-        if Request.apikey is not None:
-            params["apikey"] = Request.apikey
-            data["apikey"] = Request.apikey
-        if Request.token is not None:
-            params["token"] = Request.token
-            data["token"] = Request.token
+        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 = Request.session.request(
+        response = cls.session.request(
             method.upper(),
             url,
             params=params,
             data=data,
-            timeout=self.timeout,
+            timeout=cls.timeout,
         )
         try:
             response.raise_for_status()
@@ -68,15 +70,16 @@ class Request:
                 response.status_code, response.json().get("data", response.text)
             ) from e
 
-    async def upload(self, url: str, file: bytes) -> bool:
+    @classmethod
+    async def upload(cls, url: str, file: bytes) -> bool:
         """上传文件"""
 
-        response = Request.session.request(
+        response = cls.session.request(
             "POST",
             url,
             headers={"Content-Type": "multipart/form-data"},
             files={"file": file},
-            timeout=self.timeout,
+            timeout=cls.timeout,
         )
         try:
             response.raise_for_status()

{mcsmapi-0.1.2.dist-info → mcsmapi-0.1.4.dist-info}/METADATA

@@ -1,15 +1,16 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.2
+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.4.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=DT8u3nhelbd8EU24gRsuAW43QAXmGKTmuYs7fT3Fx2c,2014
+mcsmapi/apis/file.py,sha256=9oAKJsFo3iBYVI5hCd0BUv5Px0GXgHeQqIy2K3q3CNc,10890
+mcsmapi/apis/image.py,sha256=y9BoATZnDj2NbVWYpEAIDcO-pBXAtpQlcLgJUHoXkDk,2960
+mcsmapi/apis/instance.py,sha256=gToVq_2nJrlEB9LKKYdpaUsH-rcxLo_0B3W-2kpXsaM,11198
+mcsmapi/apis/overview.py,sha256=4bS3RGSykdQ1JyBTM-I9na6v0SCijEG1CN-WxqabfUo,625
+mcsmapi/apis/user.py,sha256=HgUJUKIxH6rUwjuevJwj_4JziF2oOqrLBwr2xXnalrM,3024
+mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/models/daemon.py,sha256=z2DmnXpjI8bq50BAbq3xrkVudOsRpVjXA2LyvUbocgY,3593
+mcsmapi/models/file.py,sha256=ly1LidhvdFr7XIeNnQWjM9cGxcWjGws8UCf4_ykMmQk,2822
+mcsmapi/models/image.py,sha256=jbi4cZCYtfaG-ca7aeI5DOmXXxWTZYCYDqdkzjtuHhc,2804
+mcsmapi/models/instance.py,sha256=zXqNWM2QuSmWsIRUz78aNewvj4JG7GQvH3QFgF8xDYc,5728
+mcsmapi/models/overview.py,sha256=TUvAqr_6h7O2ZC-CWngh8xz4zz6a4av66wgNRUN3NLg,1321
+mcsmapi/models/user.py,sha256=JNlVvpMcK-Rv67JLS8f7lUVp4TXH2gJbUE5LicZUooM,1970
+mcsmapi-0.1.4.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
+mcsmapi-0.1.4.dist-info/METADATA,sha256=0RVUYmmLKt0djp7X08zVpN4KISbl4huZD2xgbSDL8rA,2602
+mcsmapi-0.1.4.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+mcsmapi-0.1.4.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
+mcsmapi-0.1.4.dist-info/RECORD,,

{mcsmapi-0.1.2.dist-info → mcsmapi-0.1.4.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.2.dist-info → mcsmapi-0.1.4.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.2.dist-info/RECORD

@@ -1,21 +0,0 @@
-mcsmapi/__init__.py,sha256=vRKH5GjiGU9rPkUoQB7XMgJThhl1pA2x-7mYAL6Lkdo,1449
-mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
-mcsmapi/pool.py,sha256=CoOYbyECp4FoXkzwFN7WgtS3vgZtvWO8e93i18vhOEI,308
-mcsmapi/request.py,sha256=w_IWOOkxtp_WaaJ1b46ZwaSsWcNnY-CmGF3hhW92fvg,2615
-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=8c0BfNN4OmGlxkDIf-t5tLqfg4ZvODQ9-amqFOJrwSg,3518
-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=hgKn5VyheJVo81N1tqEfmBYJi71QVrg2Qd-ffmIT_Mo,1305
-mcsmapi/models/user.py,sha256=CDJjiG9cY8gW4rYD8SDnxvMGnn1cdeUU801NucPfnrA,1940
-mcsmapi-0.1.2.dist-info/LICENSE,sha256=kn0yZGn5uLIJtr2aAXy8pz_wJqal15ZGnynTU1fCnLQ,1063
-mcsmapi-0.1.2.dist-info/METADATA,sha256=RPzcnpPvkHs2DTR98fnmjpmSg8YHywzio9NpUeT_25o,2456
-mcsmapi-0.1.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-mcsmapi-0.1.2.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
-mcsmapi-0.1.2.dist-info/RECORD,,