mcsmapi 0.1.4__py3-none-any.whl → 0.1.5b2__py3-none-any.whl

mcsmapi/models/user.py

@@ -4,18 +4,33 @@ from mcsmapi.models.instance import InstanceDetail, UserInstancesList
 
 
 class UserModel(BaseModel):
+    """用户信息模型"""
+
+    """用户唯一标识符 (UUID)"""
     uuid: str = ""
+    """用户名"""
     userName: str = ""
+    """用户密码 (存储加密后的字符串)"""
     passWord: str = ""
+    """密码类型 (0=默认类型)"""
     passWordType: int = 0
+    """密码盐值 (用于加密)"""
     salt: str = ""
-    permission: int = 1  # 1=用户, 10=管理员, -1=被封禁的用户
+    """用户权限级别 (1=用户, 10=管理员, -1=被封禁的用户)"""
+    permission: int = 1
+    """用户注册时间 (时间字符串格式)"""
     registerTime: str = ""
+    """用户最后登录时间 (时间字符串格式)"""
     loginTime: str = ""
+    """用户 API 密钥"""
     apiKey: str = ""
+    """是否为初始化用户 (系统内置用户)"""
     isInit: bool = False
+    """用户安全密钥 (可能用于额外的身份验证)"""
     secret: str = ""
+    """是否启用双因素认证 (2FA)"""
     open2FA: bool = False
+    """用户关联的实例列表"""
     instances: List["UserInstancesList"] = []
 
     def delete(self) -> bool:
@@ -23,7 +38,7 @@ class UserModel(BaseModel):
         删除该用户。
 
         **返回:**
-       <br> - bool: 删除成功后返回True。
+        - bool: 删除成功后返回True。
         """
         from mcsmapi.apis.user import User
 
@@ -34,10 +49,10 @@ class UserModel(BaseModel):
         更新该用户的信息。
 
         参数:
-       <br> - config (dict[str, Any]): 用户的新信息，以字典形式提供，缺失内容使用原用户信息填充。
+        - config (dict[str, Any]): 用户的新信息，以字典形式提供，缺失内容使用原用户信息填充。
 
         返回:
-       <br> - bool: 更新成功后返回True。
+        - bool: 更新成功后返回True。
         """
         from mcsmapi.apis.user import User
 
@@ -56,21 +71,40 @@ class UserModel(BaseModel):
 
 
 class SearchUserModel(BaseModel):
+    """用户搜索结果"""
+
+    """匹配的用户总数"""
     total: int = 0
+    """当前页码"""
     page: int = 0
+    """每页返回的用户数量"""
     page_size: int = 0
+    """最大可用页数"""
     max_page: int = 0
+    """用户信息列表"""
     data: List[UserModel] = []
 
 
 class UserConfig(BaseModel):
+    """用户配置信息"""
+
+    """用户唯一标识符 (UUID)"""
     uuid: str
+    """用户名"""
     userName: str
+    """最后登录时间"""
     loginTime: str
+    """注册时间"""
     registerTime: str
+    """用户拥有的实例列表"""
     instances: List[InstanceDetail]
-    permission: int  # 1=用户, 10=管理员, -1=被封禁的用户
+    """用户权限级别 (1=用户, 10=管理员, -1=被封禁的用户)"""
+    permission: int
+    """用户 API 密钥"""
     apiKey: str
+    """是否为初始化用户 (系统内置用户)"""
     isInit: bool
+    """用户安全密钥 (可能用于额外的身份验证)"""
     secret: str
+    """是否启用双因素认证 (2FA)"""
     open2FA: bool

{mcsmapi-0.1.4.dist-info → mcsmapi-0.1.5b2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.4
+Version: 0.1.5b2
 Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
 Author-email: molanp <molanpp@outlook.com>
 License-Expression: MIT
@@ -17,6 +17,7 @@ Dynamic: license-file
 ![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)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/molanp/mcsmapi)
 
 English|[Chinese Simplified](README_zh-cn.md)
 
@@ -41,6 +42,9 @@ You can install `mcsmapi` using `pip`:
 pip install mcsmapi
 ```
 
+If you need the latest build files (untested), please visit
+[Actions](https://github.com/molanp/mcsmapi/actions)
+
 ## Supported Features
 
 - [x] Dashboard data (`Overview`)

mcsmapi-0.1.5b2.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=2Se5ViwaePg6_CGI9qKeI823FMF0qzlemn2yCt92SPs,4488
+mcsmapi/apis/file.py,sha256=Qh3kOtU2mj9PS2nN4s6WufZ149pM0sbkM37aG-LlY5A,10778
+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=EV0nlUe6pUETbLIoUGn2HPWoNYClIyS2ABrRA70IjQk,5079
+mcsmapi/models/file.py,sha256=m75zhMkBA7KQm-870Ph3DfE9unSlOLWgMmwdl8H-vSc,6097
+mcsmapi/models/image.py,sha256=pjwSJ79rYMuDTLlazevpjqdnnc0Mqvea9bp-BepUhio,5484
+mcsmapi/models/instance.py,sha256=oNXw0q3FDTu2bG_crWPgUtLXxM2yL7eRwo9H2RFzmDA,8850
+mcsmapi/models/overview.py,sha256=yRERCPRA3vBceKjISBClngvmKaQlo0HowC859nm15Nc,2859
+mcsmapi/models/user.py,sha256=sduOS8MWoxUfvTseK7nShuBOYzei3dEM8eP45PuIZ3g,3130
+mcsmapi-0.1.5b2.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
+mcsmapi-0.1.5b2.dist-info/METADATA,sha256=IFV6TW-2aLuZydebLlPN1mSRbzsFCtRpRAbWa7kaDlc,2805
+mcsmapi-0.1.5b2.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+mcsmapi-0.1.5b2.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
+mcsmapi-0.1.5b2.dist-info/RECORD,,

mcsmapi-0.1.4.dist-info/RECORD

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