README_zh-cn.md

MCSM API

简体中文|English

简介

mcsmapi 是一个基于 MCSManager 的 Pypi 包，旨在简化与 MCSM API 的交互。

通过这个库，您可以更轻松地访问和操作 MCSM 提供的各种功能。

文档

📄 文档: docs

💡 示例: example

安装

您可以使用 pip 安装 mcsmapi：

pip install mcsmapi

如果你需要最新的构建文件，请访问 Actions

支持的功能

• 仪表盘数据(Overview)
• 用户管理(User)
• 实例管理(Instance)
• 节点管理(Daemon)
• 文件管理(File)
• 镜像管理(Image)
• 计划任务管理(Schedule)

支持的 MCSM 版本

MCSM 版本	支持状态
10.x	✅

快速示例

from mcsmapi import MCSMAPI

# 初始化
mcsm = MCSMAPI("https://example.com")

# 使用账号密码登录(API权限取决于账号权限)
mcsm.login("username", "password")

# 使用apikey登录(API权限取决于apikey权限)
mcsm.login_with_apikey("apikey")

# 获取仪表盘数据
overview = mcsm.overview
overview_data = overview.overview()

# 获取 MCSM 版本
mcsm_version = overview_data.version

贡献

如果您发现任何问题或有改进建议，欢迎提交 Issue 或者创建 Pull Request。

许可

mcsmapi 使用 MIT 许可证。

请参阅 LICENSE 文件以获取更多信息。