mcsmapi 0.1.8b2

Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包

MCSM API

English|Chinese Simplified

[!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 deepwiki-mcsmapi

You can also find:

📄 Work-in-progress docs: docs

💡 Example: example

Introduction

mcsmapi is a PyPI package based on MCSManager, designed to simplify interactions with the MCSM API.

With this library, you can more easily access and operate the various features provided by MCSM.

Installation

You can install mcsmapi using pip:

pip install mcsmapi

If you need the latest build files, please visit Actions

Supported Features

• Dashboard data (Overview)
• User management (User)
• Instance management (Instance)
• Daemon management (Daemon)
• File management (File)
• Image management (Image)

Supported MCSM Versions

MCSM Version	Support Status
10.x	✅

Quick Example

from mcsmapi import MCSMAPI

# Initialize
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")

# Log in with API key (API permissions depend on the API key permissions)
mcsm.login_with_apikey("apikey")

# Get dashboard data
overview = mcsm.overview()
overview_data = overview.overview()

# Get MCSM version
mcsm_version = overview_data.version

Contributing

If you encounter any issues or have suggestions for improvements, feel free to submit an Issue or create a Pull Request.

License

mcsmapi is licensed under the MIT License.

Please refer to the LICENSE file for more details.