mcsm-sdk-python 1.0.6__tar.gz

mcsm_sdk_python-1.0.6/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: mcsm_sdk_python
+Version: 1.0.6
+Summary: An unoffical SDK for the MCSManager
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: build>=1.4.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: ruff>=0.13.3
+Requires-Dist: twine>=6.2.0
+
+# MCSM SDK Python
+
+一个用于 MCSManager 的非官方 Python SDK，提供简单易用的 API 接口来管理 Minecraft 服务器实例。
+
+## 特性
+
+- 🚀 异步支持，基于 `httpx` 构建
+- 📊 完整的仪表板信息获取
+- 👥 用户管理功能（创建、查询、更新、删除）
+- 🎮 实例管理功能（创建、启动、停止、重启等）
+- 📝 类型提示支持
+- 🔧 简单易用的 API 设计
+
+## 安装
+
+### 使用 pip 安装
+
+```bash
+pip install mcsm-sdk-python
+```
+
+### 从源码安装
+
+```bash
+git clone https://github.com/laobinghu/mcsm-sdk-python.git
+cd mcsm-sdk-python
+pip install -e .
+```
+
+## 快速开始
+
+```python
+import asyncio
+from httpx import AsyncClient
+from mcsm_sdk_python import McsmSdk
+
+async def main():
+    # 创建 HTTP 客户端
+    http_client = AsyncClient()
+    
+    # 初始化 MCSM SDK
+    mcsm = McsmSdk(
+        client=http_client,
+        endpoint="http://127.0.0.1:2333",  # 你的 MCSManager 地址
+        apikey="your_api_key_here"         # 你的 API 密钥
+    )
+    
+    try:
+        # 获取系统概览信息
+        overview = await mcsm.get_overview()
+        print("系统概览:", overview)
+        
+        # 获取用户列表
+        users = await mcsm.get_user_list(page=1, page_size=10)
+        print("用户列表:", users)
+        
+    finally:
+        # 关闭 HTTP 客户端
+        await http_client.aclose()
+
+# 运行示例
+asyncio.run(main())
+```
+
+## API 文档
+
+### 初始化
+
+```python
+from httpx import AsyncClient
+from mcsm_sdk_python import McsmSdk
+
+client = AsyncClient()
+mcsm = McsmSdk(
+    client=client,
+    endpoint="http://your-mcsm-server:2333",
+    apikey="your_api_key"
+)
+```
+
+### 仪表板 API
+
+#### 获取系统概览
+
+```python
+overview = await mcsm.get_overview()
+```
+
+返回系统的基本信息，包括服务器状态、实例数量等。
+
+### 用户管理 API
+
+#### 获取用户列表
+
+```python
+users = await mcsm.get_user_list(
+    page=1,           # 页码
+    page_size=10,     # 每页数量
+    userName="",      # 可选：用户名筛选
+    role=1           # 可选：角色筛选
+)
+```
+
+#### 创建用户
+
+```python
+result = await mcsm.create_user(
+    username="new_user",
+    password="password123",
+    permission=1  # 权限级别
+)
+```
+
+#### 更新用户信息
+
+```python
+result = await mcsm.update_user({
+    "uuid": "user_uuid",
+    "username": "updated_name",
+    "permission": 2
+})
+```
+
+#### 删除用户
+
+```python
+result = await mcsm.delete_user(["user_uuid_1", "user_uuid_2"])
+```
+
+### 实例管理 API
+
+#### 获取实例列表
+
+```python
+instances = await mcsm.get_instances_list(
+    daemonId="daemon_id",
+    page=1,
+    page_size=10,
+    status="running",        # 状态筛选
+    instance_name=""         # 可选：实例名称筛选
+)
+```
+
+#### 获取实例详细信息
+
+```python
+instance_info = await mcsm.get_instances_info(
+    daemonId="daemon_id",
+    page=1,
+    page_size=10,
+    status="running",
+    instance_id="instance_uuid"
+)
+```
+
+#### 创建实例
+
+```python
+result = await mcsm.create_instance(
+    daemonId="daemon_id",
+    data={
+        "nickname": "我的服务器",
+        "startCommand": "java -jar server.jar",
+        "stopCommand": "stop",
+        "cwd": "/path/to/server",
+        "ie": "utf-8",
+        "oe": "utf-8"
+    }
+)
+```
+
+#### 实例操作
+
+支持单个实例和批量实例操作：
+
+```python
+# 单个实例操作
+result = await mcsm.instances_operate(
+    method="start",           # 操作类型：start, stop, restart, kill
+    daemonId="daemon_id",
+    instance_id="instance_uuid"
+)
+
+# 批量实例操作
+result = await mcsm.instances_operate(
+    method="start",
+    isBatch=True,
+    instance_list=[
+        {
+            "daemonId": "daemon-123",
+            "instanceUuids": ["uuid-1", "uuid-2", "uuid-3"]
+        },
+        {
+            "daemonId": "daemon-456", 
+            "instanceUuids": ["uuid-4", "uuid-5"]
+        }
+    ]
+)
+```
+
+支持的操作类型：
+- `start` - 启动实例
+- `stop` - 停止实例
+- `restart` - 重启实例
+- `kill` - 强制终止实例
+
+#### 更新实例
+
+```python
+result = await mcsm.update_instance(
+    daemonId="daemon_id",
+    uuid="instance_uuid"
+)
+```
+
+## 错误处理
+
+SDK 使用 `httpx` 的异常处理机制：
+
+```python
+import httpx
+
+try:
+    result = await mcsm.get_overview()
+except httpx.HTTPStatusError as e:
+    print(f"HTTP 错误: {e.response.status_code}")
+    print(f"响应内容: {e.response.text}")
+except httpx.RequestError as e:
+    print(f"请求错误: {e}")
+```
+
+## 配置要求
+
+- Python 3.9+
+- httpx >= 0.28.1
+
+## 项目结构
+
+```
+mcsm_sdk_python/
+├── __init__.py          # 主入口，导出 McsmSdk 类
+├── base.py             # 基础类，提供通用功能
+├── dashboard.py        # 仪表板相关 API
+├── users.py           # 用户管理 API
+├── instance.py        # 实例管理 API
+├── daemon.py          # 守护进程 API（待实现）
+├── fileManager.py     # 文件管理 API（待实现）
+└── imageManager.py    # 镜像管理 API（待实现）
+```
+
+## 开发计划
+
+- [ ] 守护进程管理 API
+- [ ] 文件管理 API
+- [ ] 镜像管理 API
+- [ ] 单元测试
+- [ ] 文档完善
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 许可证
+
+MIT License
+
+## 相关链接
+
+- [MCSManager 官方网站](https://mcsmanager.com/)
+- [MCSManager GitHub](https://github.com/MCSManager/MCSManager)
+
+---
+
+**注意**: 这是一个非官方的 SDK，与 MCSManager 官方团队无关。使用前请确保你的 MCSManager 版本支持相应的 API。

mcsm_sdk_python-1.0.6/README.md

@@ -0,0 +1,274 @@
+# MCSM SDK Python
+
+一个用于 MCSManager 的非官方 Python SDK，提供简单易用的 API 接口来管理 Minecraft 服务器实例。
+
+## 特性
+
+- 🚀 异步支持，基于 `httpx` 构建
+- 📊 完整的仪表板信息获取
+- 👥 用户管理功能（创建、查询、更新、删除）
+- 🎮 实例管理功能（创建、启动、停止、重启等）
+- 📝 类型提示支持
+- 🔧 简单易用的 API 设计
+
+## 安装
+
+### 使用 pip 安装
+
+```bash
+pip install mcsm-sdk-python
+```
+
+### 从源码安装
+
+```bash
+git clone https://github.com/laobinghu/mcsm-sdk-python.git
+cd mcsm-sdk-python
+pip install -e .
+```
+
+## 快速开始
+
+```python
+import asyncio
+from httpx import AsyncClient
+from mcsm_sdk_python import McsmSdk
+
+async def main():
+    # 创建 HTTP 客户端
+    http_client = AsyncClient()
+    
+    # 初始化 MCSM SDK
+    mcsm = McsmSdk(
+        client=http_client,
+        endpoint="http://127.0.0.1:2333",  # 你的 MCSManager 地址
+        apikey="your_api_key_here"         # 你的 API 密钥
+    )
+    
+    try:
+        # 获取系统概览信息
+        overview = await mcsm.get_overview()
+        print("系统概览:", overview)
+        
+        # 获取用户列表
+        users = await mcsm.get_user_list(page=1, page_size=10)
+        print("用户列表:", users)
+        
+    finally:
+        # 关闭 HTTP 客户端
+        await http_client.aclose()
+
+# 运行示例
+asyncio.run(main())
+```
+
+## API 文档
+
+### 初始化
+
+```python
+from httpx import AsyncClient
+from mcsm_sdk_python import McsmSdk
+
+client = AsyncClient()
+mcsm = McsmSdk(
+    client=client,
+    endpoint="http://your-mcsm-server:2333",
+    apikey="your_api_key"
+)
+```
+
+### 仪表板 API
+
+#### 获取系统概览
+
+```python
+overview = await mcsm.get_overview()
+```
+
+返回系统的基本信息，包括服务器状态、实例数量等。
+
+### 用户管理 API
+
+#### 获取用户列表
+
+```python
+users = await mcsm.get_user_list(
+    page=1,           # 页码
+    page_size=10,     # 每页数量
+    userName="",      # 可选：用户名筛选
+    role=1           # 可选：角色筛选
+)
+```
+
+#### 创建用户
+
+```python
+result = await mcsm.create_user(
+    username="new_user",
+    password="password123",
+    permission=1  # 权限级别
+)
+```
+
+#### 更新用户信息
+
+```python
+result = await mcsm.update_user({
+    "uuid": "user_uuid",
+    "username": "updated_name",
+    "permission": 2
+})
+```
+
+#### 删除用户
+
+```python
+result = await mcsm.delete_user(["user_uuid_1", "user_uuid_2"])
+```
+
+### 实例管理 API
+
+#### 获取实例列表
+
+```python
+instances = await mcsm.get_instances_list(
+    daemonId="daemon_id",
+    page=1,
+    page_size=10,
+    status="running",        # 状态筛选
+    instance_name=""         # 可选：实例名称筛选
+)
+```
+
+#### 获取实例详细信息
+
+```python
+instance_info = await mcsm.get_instances_info(
+    daemonId="daemon_id",
+    page=1,
+    page_size=10,
+    status="running",
+    instance_id="instance_uuid"
+)
+```
+
+#### 创建实例
+
+```python
+result = await mcsm.create_instance(
+    daemonId="daemon_id",
+    data={
+        "nickname": "我的服务器",
+        "startCommand": "java -jar server.jar",
+        "stopCommand": "stop",
+        "cwd": "/path/to/server",
+        "ie": "utf-8",
+        "oe": "utf-8"
+    }
+)
+```
+
+#### 实例操作
+
+支持单个实例和批量实例操作：
+
+```python
+# 单个实例操作
+result = await mcsm.instances_operate(
+    method="start",           # 操作类型：start, stop, restart, kill
+    daemonId="daemon_id",
+    instance_id="instance_uuid"
+)
+
+# 批量实例操作
+result = await mcsm.instances_operate(
+    method="start",
+    isBatch=True,
+    instance_list=[
+        {
+            "daemonId": "daemon-123",
+            "instanceUuids": ["uuid-1", "uuid-2", "uuid-3"]
+        },
+        {
+            "daemonId": "daemon-456", 
+            "instanceUuids": ["uuid-4", "uuid-5"]
+        }
+    ]
+)
+```
+
+支持的操作类型：
+- `start` - 启动实例
+- `stop` - 停止实例
+- `restart` - 重启实例
+- `kill` - 强制终止实例
+
+#### 更新实例
+
+```python
+result = await mcsm.update_instance(
+    daemonId="daemon_id",
+    uuid="instance_uuid"
+)
+```
+
+## 错误处理
+
+SDK 使用 `httpx` 的异常处理机制：
+
+```python
+import httpx
+
+try:
+    result = await mcsm.get_overview()
+except httpx.HTTPStatusError as e:
+    print(f"HTTP 错误: {e.response.status_code}")
+    print(f"响应内容: {e.response.text}")
+except httpx.RequestError as e:
+    print(f"请求错误: {e}")
+```
+
+## 配置要求
+
+- Python 3.9+
+- httpx >= 0.28.1
+
+## 项目结构
+
+```
+mcsm_sdk_python/
+├── __init__.py          # 主入口，导出 McsmSdk 类
+├── base.py             # 基础类，提供通用功能
+├── dashboard.py        # 仪表板相关 API
+├── users.py           # 用户管理 API
+├── instance.py        # 实例管理 API
+├── daemon.py          # 守护进程 API（待实现）
+├── fileManager.py     # 文件管理 API（待实现）
+└── imageManager.py    # 镜像管理 API（待实现）
+```
+
+## 开发计划
+
+- [ ] 守护进程管理 API
+- [ ] 文件管理 API
+- [ ] 镜像管理 API
+- [ ] 单元测试
+- [ ] 文档完善
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 许可证
+
+MIT License
+
+## 相关链接
+
+- [MCSManager 官方网站](https://mcsmanager.com/)
+- [MCSManager GitHub](https://github.com/MCSManager/MCSManager)
+
+---
+
+**注意**: 这是一个非官方的 SDK，与 MCSManager 官方团队无关。使用前请确保你的 MCSManager 版本支持相应的 API。

mcsm_sdk_python-1.0.6/mcsm_sdk_python/__init__.py

@@ -0,0 +1,15 @@
+from httpx import AsyncClient
+
+from .dashboard import Dashboard
+from .users import Users
+from .instance import Instance
+
+
+__all__ = ["McsmSdk"]
+
+
+class McsmSdk(Dashboard, Users, Instance):
+    def __init__(self, client: AsyncClient, endpoint: str, apikey: str = ""):
+        super().__init__(client, endpoint, apikey)
+    
+    pass

mcsm_sdk_python-1.0.6/mcsm_sdk_python/base.py

@@ -0,0 +1,57 @@
+from abc import ABC
+from httpx import AsyncClient, Request, Response
+from urllib.parse import urljoin
+from typing import Union
+
+
+class Base(ABC):
+    def __init__(self, client: AsyncClient, endpoint: str, apikey: str, **kwargs):
+        self.client = client
+        self.endpoint = endpoint
+        self.apikey = apikey
+        # 可以在这里处理其他通用参数
+        self.extra_kwargs = kwargs
+
+    def _get_headers(self) -> dict:
+        """构建基础请求头，包含认证信息和内容类型"""
+        headers = {
+            "Content-Type": "application/json",
+            "X-Requested-With": "XMLHttpRequest",
+            "charset": "utf-8",
+        }
+        return headers
+
+    def _get_full_url(self, path: str) -> str:
+        """拼接基础地址和路径，生成完整URL"""
+        return urljoin(self.endpoint, path)
+
+    async def delete_with_body(
+        self,
+        url: str,
+        params: dict,
+        data: Union[list, dict],
+    ) -> Response:
+        """
+        发送带有body的DELETE请求
+
+        参数:
+            url: API路径(相对于endpoint)
+            params: 请求参数
+            payload: 要发送的请求体数据(列表???)
+
+        返回:
+            httpx.Response对象
+        """
+        # 准备请求数据
+        full_url = self._get_full_url(url)
+        headers = self._get_headers()
+
+        # 构建请求对象
+        request = Request(
+            method="DELETE", url=full_url, content=data, headers=headers, params=params
+        )
+
+        # 发送请求
+        response = await self.client.send(request)
+        response.raise_for_status()  # 自动处理HTTP错误状态码
+        return response

mcsm_sdk_python-1.0.6/mcsm_sdk_python/dashboard.py

@@ -0,0 +1,15 @@
+from httpx import AsyncClient
+from urllib.parse import urljoin
+
+from .base import Base
+
+
+class Dashboard(Base):
+    def __init__(self, client: AsyncClient, endpoint: str, apikey: str, **kwargs):
+        super().__init__(client, endpoint, apikey, **kwargs)
+
+    async def get_overview(self) -> dict:
+        final_url = urljoin(self.endpoint, f"/api/overview?apikey={self.apikey}")
+        response = await self.client.get(final_url)
+        response.raise_for_status()
+        return response.json()

mcsm_sdk_python-1.0.6/mcsm_sdk_python/instance.py

@@ -0,0 +1,219 @@
+from httpx import AsyncClient
+from urllib.parse import urljoin
+
+from .base import Base
+
+
+class Instance(Base):
+    def __init__(self, client: AsyncClient, endpoint: str, apikey: str, **kwargs):
+        super().__init__(client, endpoint, apikey, **kwargs)
+
+    async def get_instances_list(
+        self,
+        daemonId: str,
+        page: int,
+        page_size: int,
+        status: str,
+        instance_name: str = "",
+    ) -> dict:
+        params = {
+            "apikey": self.apikey,
+            "page": page,
+            "page_size": page_size,
+            "daemonId": daemonId,
+            "status": status,
+            **({"instance_name": instance_name} if instance_name != "" else {}),
+        }
+
+        final_url = urljoin(
+            self.endpoint,
+            "/api/service/remote_service_instances",
+        )
+        response = await self.client.get(final_url, params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def get_instances_info(
+        self,
+        daemonId: str,
+        page: int,
+        page_size: int,
+        status: str,
+        instance_id: str = "",
+    ) -> dict:
+        params = {
+            "apikey": self.apikey,
+            "daemonId": daemonId,
+            "uuid": instance_id,
+        }
+
+        final_url = urljoin(
+            self.endpoint,
+            "/api/instance",
+        )
+        response = await self.client.get(final_url, params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def create_instance(self, daemonId: str, data: dict) -> dict:
+        params = {"apikey": self.apikey, "daemonId": daemonId}
+        final_url = urljoin(
+            self.endpoint,
+            "/api/instance",
+        )
+        response = await self.client.post(final_url, params=params, data=data)
+        response.raise_for_status()
+        return response.json()
+
+    async def update_instance_config(self, daemonId: str, data: dict) -> dict:
+        params = {"apikey": self.apikey, "daemonId": daemonId}
+        final_url = urljoin(
+            self.endpoint,
+            "/api/instance",
+        )
+        response = await self.client.post(final_url, params=params, data=data)
+        response.raise_for_status()
+        return response.json()
+
+    async def delete_user(
+        self, daemonId: str, uuids: list[str], deleteFile: bool = False
+    ) -> dict:
+        data = {"uuids": uuids, "deleteFile": deleteFile}
+        params = {"apikey": self.apikey, "daemonId": daemonId}
+        final_url = urljoin(
+            self.endpoint,
+            "/api/auth",
+        )
+        response = await self.delete_with_body(final_url, params=params, data=data)
+        response.raise_for_status()
+        return response.json()
+
+    async def instances_operate(
+        self,
+        method: str,
+        isBatch: bool = False,
+        daemonId: str = "",
+        instance_id: str = "",
+        instance_list: dict[str, str] = {},
+    ) -> dict:
+        """执行实例操作,支持单个实例和批量实例操作
+
+        Args:
+            method (str): 操作方法名称,如 'start', 'stop', 'restart', 'kill'
+            isBatch (bool, optional): 是否为批量操作. 默认为 False
+            daemonId (str, optional): 守护进程ID. 默认为空字符串
+            instance_id (str, optional): 实例ID,单个操作时使用. 默认为空字符串
+            instance_list (dict[str, str], optional): 实例列表,批量操作时使用. 默认为空字典,示例：
+                [
+                    {
+                        "daemonId": "daemon-123",
+                        "instanceUuids": ["uuid-1", "uuid-2", "uuid-3"]
+                    },
+                    {
+                        "daemonId": "daemon-456",
+                        "instanceUuids": ["uuid-4", "uuid-5"]
+                    }
+                ]
+
+        Returns: dict: API响应结果,包含操作状态和相关信息
+
+        Raises: httpx.HTTPStatusError: 当HTTP请求返回错误状态码时抛出
+        """
+        params = {
+            "apikey": self.apikey,
+            "daemonId": daemonId,
+            **({"uuid": instance_id} if not isBatch else {}),
+            **({"daemonId": daemonId} if not isBatch else {}),
+        }
+        final_url = urljoin(
+            self.endpoint,
+            f"/api/protected_instance/{method}"
+            if not isBatch
+            else f"/api/instance/multi_{method}",
+        )
+        response = await self.client.get(final_url, params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def update_instance(self, daemonId: str, uuid: str) -> dict:
+        params = {
+            "apikey": self.apikey,
+            "daemonId": daemonId,
+            "uuid": uuid,
+            "task_name": "update",
+        }
+        final_url = urljoin(
+            self.endpoint,
+            "/api/protected_instance/asynchronous",
+        )
+        response = await self.client.post(final_url, params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def send_command(
+        self,
+        daemonId: str,
+        instance_id: str,
+        command: str,
+    ) -> dict:
+        params = {
+            "apikey": self.apikey,
+            "daemonId": daemonId,
+            "uuid": instance_id,
+            "command": command,
+        }
+
+        final_url = urljoin(
+            self.endpoint,
+            "/api/protected_instance/command",
+        )
+        response = await self.client.get(final_url, params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def get_instance_log(
+        self,
+        daemonId: str,
+        instance_id: str,
+        size: int = 1,
+    ) -> dict:
+        params = {
+            "apikey": self.apikey,
+            "daemonId": daemonId,
+            "uuid": instance_id,
+            **({"size": size} if size is not None else {}),
+        }
+
+        final_url = urljoin(
+            self.endpoint,
+            "/api/protected_instance/outputlog",
+        )
+        response = await self.client.get(final_url, params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def install_instance(
+        self,
+        daemonId: str,
+        instance_id: str,
+        targetUrl: str,
+        title: str,
+        description: str,
+    ) -> dict:
+        params = {
+            "apikey": self.apikey,
+            "daemonId": daemonId,
+            "uuid": instance_id,
+        }
+        data = {
+            "targetUrl": targetUrl,
+            "title": title,
+            "description": description,
+        }
+        final_url = urljoin(
+            self.endpoint,
+            "/api/protected_instance/install_instance",
+        )
+        response = await self.client.post(final_url, params=params, data=data)
+        response.raise_for_status()
+        return response.json()

mcsm_sdk_python-1.0.6/mcsm_sdk_python/users.py

@@ -0,0 +1,72 @@
+from httpx import AsyncClient
+from urllib.parse import urljoin
+
+from .base import Base
+
+
+class Users(Base):
+    def __init__(self, client: AsyncClient, endpoint: str, apikey: str, **kwargs):
+        super().__init__(client, endpoint, apikey, **kwargs)
+
+    async def get_user_list(
+        self, page: int, page_size: int, userName: str = "", role: int = 1
+    ) -> dict:
+        params = {
+            "apikey": self.apikey,
+            "page": page,
+            "page_size": page_size,
+            **({"userName": userName} if userName != "" else {}),
+            **({"role": role} if role is not None else {}),
+        }
+
+        final_url = urljoin(
+            self.endpoint,
+            "/api/auth/search",
+        )
+        response = await self.client.get(final_url, params=params)
+        response.raise_for_status()
+        return response.json()
+
+    async def create_user(
+        self, username: str, password: str, permission: int = 1
+    ) -> dict:
+        params = {
+            "apikey": self.apikey,
+        }
+        data = {
+            "username": username,
+            "password": password,
+            "permission": permission,
+        }
+        final_url = urljoin(
+            self.endpoint,
+            "/api/auth",
+        )
+        response = await self.client.post(final_url, params=params, data=data)
+        response.raise_for_status()
+        return response.json()
+
+    async def update_user(self, data: dict) -> dict:
+        params = {
+            "apikey": self.apikey,
+        }
+        final_url = urljoin(
+            self.endpoint,
+            "/api/auth",
+        )
+        response = await self.client.put(final_url, params=params, data=data)
+        response.raise_for_status()
+        return response.json()
+
+    async def delete_user(self, user_uuid: list[str]) -> dict:
+        params = {
+            "apikey": self.apikey,
+        }
+
+        final_url = urljoin(
+            self.endpoint,
+            "/api/auth",
+        )
+        response = await self.delete_with_body(final_url, params=params, data=user_uuid)
+        response.raise_for_status()
+        return response.json()

mcsm_sdk_python-1.0.6/mcsm_sdk_python.egg-info/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: mcsm_sdk_python
+Version: 1.0.6
+Summary: An unoffical SDK for the MCSManager
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: build>=1.4.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: ruff>=0.13.3
+Requires-Dist: twine>=6.2.0
+
+# MCSM SDK Python
+
+一个用于 MCSManager 的非官方 Python SDK，提供简单易用的 API 接口来管理 Minecraft 服务器实例。
+
+## 特性
+
+- 🚀 异步支持，基于 `httpx` 构建
+- 📊 完整的仪表板信息获取
+- 👥 用户管理功能（创建、查询、更新、删除）
+- 🎮 实例管理功能（创建、启动、停止、重启等）
+- 📝 类型提示支持
+- 🔧 简单易用的 API 设计
+
+## 安装
+
+### 使用 pip 安装
+
+```bash
+pip install mcsm-sdk-python
+```
+
+### 从源码安装
+
+```bash
+git clone https://github.com/laobinghu/mcsm-sdk-python.git
+cd mcsm-sdk-python
+pip install -e .
+```
+
+## 快速开始
+
+```python
+import asyncio
+from httpx import AsyncClient
+from mcsm_sdk_python import McsmSdk
+
+async def main():
+    # 创建 HTTP 客户端
+    http_client = AsyncClient()
+    
+    # 初始化 MCSM SDK
+    mcsm = McsmSdk(
+        client=http_client,
+        endpoint="http://127.0.0.1:2333",  # 你的 MCSManager 地址
+        apikey="your_api_key_here"         # 你的 API 密钥
+    )
+    
+    try:
+        # 获取系统概览信息
+        overview = await mcsm.get_overview()
+        print("系统概览:", overview)
+        
+        # 获取用户列表
+        users = await mcsm.get_user_list(page=1, page_size=10)
+        print("用户列表:", users)
+        
+    finally:
+        # 关闭 HTTP 客户端
+        await http_client.aclose()
+
+# 运行示例
+asyncio.run(main())
+```
+
+## API 文档
+
+### 初始化
+
+```python
+from httpx import AsyncClient
+from mcsm_sdk_python import McsmSdk
+
+client = AsyncClient()
+mcsm = McsmSdk(
+    client=client,
+    endpoint="http://your-mcsm-server:2333",
+    apikey="your_api_key"
+)
+```
+
+### 仪表板 API
+
+#### 获取系统概览
+
+```python
+overview = await mcsm.get_overview()
+```
+
+返回系统的基本信息，包括服务器状态、实例数量等。
+
+### 用户管理 API
+
+#### 获取用户列表
+
+```python
+users = await mcsm.get_user_list(
+    page=1,           # 页码
+    page_size=10,     # 每页数量
+    userName="",      # 可选：用户名筛选
+    role=1           # 可选：角色筛选
+)
+```
+
+#### 创建用户
+
+```python
+result = await mcsm.create_user(
+    username="new_user",
+    password="password123",
+    permission=1  # 权限级别
+)
+```
+
+#### 更新用户信息
+
+```python
+result = await mcsm.update_user({
+    "uuid": "user_uuid",
+    "username": "updated_name",
+    "permission": 2
+})
+```
+
+#### 删除用户
+
+```python
+result = await mcsm.delete_user(["user_uuid_1", "user_uuid_2"])
+```
+
+### 实例管理 API
+
+#### 获取实例列表
+
+```python
+instances = await mcsm.get_instances_list(
+    daemonId="daemon_id",
+    page=1,
+    page_size=10,
+    status="running",        # 状态筛选
+    instance_name=""         # 可选：实例名称筛选
+)
+```
+
+#### 获取实例详细信息
+
+```python
+instance_info = await mcsm.get_instances_info(
+    daemonId="daemon_id",
+    page=1,
+    page_size=10,
+    status="running",
+    instance_id="instance_uuid"
+)
+```
+
+#### 创建实例
+
+```python
+result = await mcsm.create_instance(
+    daemonId="daemon_id",
+    data={
+        "nickname": "我的服务器",
+        "startCommand": "java -jar server.jar",
+        "stopCommand": "stop",
+        "cwd": "/path/to/server",
+        "ie": "utf-8",
+        "oe": "utf-8"
+    }
+)
+```
+
+#### 实例操作
+
+支持单个实例和批量实例操作：
+
+```python
+# 单个实例操作
+result = await mcsm.instances_operate(
+    method="start",           # 操作类型：start, stop, restart, kill
+    daemonId="daemon_id",
+    instance_id="instance_uuid"
+)
+
+# 批量实例操作
+result = await mcsm.instances_operate(
+    method="start",
+    isBatch=True,
+    instance_list=[
+        {
+            "daemonId": "daemon-123",
+            "instanceUuids": ["uuid-1", "uuid-2", "uuid-3"]
+        },
+        {
+            "daemonId": "daemon-456", 
+            "instanceUuids": ["uuid-4", "uuid-5"]
+        }
+    ]
+)
+```
+
+支持的操作类型：
+- `start` - 启动实例
+- `stop` - 停止实例
+- `restart` - 重启实例
+- `kill` - 强制终止实例
+
+#### 更新实例
+
+```python
+result = await mcsm.update_instance(
+    daemonId="daemon_id",
+    uuid="instance_uuid"
+)
+```
+
+## 错误处理
+
+SDK 使用 `httpx` 的异常处理机制：
+
+```python
+import httpx
+
+try:
+    result = await mcsm.get_overview()
+except httpx.HTTPStatusError as e:
+    print(f"HTTP 错误: {e.response.status_code}")
+    print(f"响应内容: {e.response.text}")
+except httpx.RequestError as e:
+    print(f"请求错误: {e}")
+```
+
+## 配置要求
+
+- Python 3.9+
+- httpx >= 0.28.1
+
+## 项目结构
+
+```
+mcsm_sdk_python/
+├── __init__.py          # 主入口，导出 McsmSdk 类
+├── base.py             # 基础类，提供通用功能
+├── dashboard.py        # 仪表板相关 API
+├── users.py           # 用户管理 API
+├── instance.py        # 实例管理 API
+├── daemon.py          # 守护进程 API（待实现）
+├── fileManager.py     # 文件管理 API（待实现）
+└── imageManager.py    # 镜像管理 API（待实现）
+```
+
+## 开发计划
+
+- [ ] 守护进程管理 API
+- [ ] 文件管理 API
+- [ ] 镜像管理 API
+- [ ] 单元测试
+- [ ] 文档完善
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 许可证
+
+MIT License
+
+## 相关链接
+
+- [MCSManager 官方网站](https://mcsmanager.com/)
+- [MCSManager GitHub](https://github.com/MCSManager/MCSManager)
+
+---
+
+**注意**: 这是一个非官方的 SDK，与 MCSManager 官方团队无关。使用前请确保你的 MCSManager 版本支持相应的 API。

mcsm_sdk_python-1.0.6/mcsm_sdk_python.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+mcsm_sdk_python/__init__.py
+mcsm_sdk_python/base.py
+mcsm_sdk_python/daemon.py
+mcsm_sdk_python/dashboard.py
+mcsm_sdk_python/fileManager.py
+mcsm_sdk_python/imageManager.py
+mcsm_sdk_python/instance.py
+mcsm_sdk_python/users.py
+mcsm_sdk_python.egg-info/PKG-INFO
+mcsm_sdk_python.egg-info/SOURCES.txt
+mcsm_sdk_python.egg-info/dependency_links.txt
+mcsm_sdk_python.egg-info/requires.txt
+mcsm_sdk_python.egg-info/top_level.txt

mcsm_sdk_python-1.0.6/mcsm_sdk_python.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mcsm_sdk_python-1.0.6/mcsm_sdk_python.egg-info/requires.txt

@@ -0,0 +1,4 @@
+build>=1.4.0
+httpx>=0.28.1
+ruff>=0.13.3
+twine>=6.2.0

mcsm_sdk_python-1.0.6/mcsm_sdk_python.egg-info/top_level.txt

@@ -0,0 +1 @@
+mcsm_sdk_python

mcsm_sdk_python-1.0.6/pyproject.toml

@@ -0,0 +1,12 @@
+[project]
+name = "mcsm_sdk_python"
+version = "1.0.6"
+description = "An unoffical SDK for the MCSManager"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "build>=1.4.0",
+    "httpx>=0.28.1",
+    "ruff>=0.13.3",
+    "twine>=6.2.0",
+]

mcsm_sdk_python-1.0.6/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+