A Pypi package based on MCSManager, designed to simplify interaction with MCSM API.
Project description
MCSM API Client
English|简体中文
Introduction
mcsmapi
is a Pypi package based on MCSManager, designed to simplify interaction with MCSM API.
Through this library, you can easily access and operate various functions provided by MCSM.
Installation
You can use pip
to install mcsmapi
:
pip install mcsmapi
Usage method
Example code
Here are some examples of how to use mcsmapi
:
from mcsmapi import overview
# if you have a apikey, you can use this method
client = Overview(url=" https://example.com/",apikey="your_api_key")
# if you do not have a apikey, you can use this method
client = Overview(url=" https://example.com/")
# login
client.login(username="your_username",password="your_password")
# Get dashboard data
response = client.getData()
print(response.json())
Supported functions
- Login (
(func) login
) - Dashboard Data (
(cls) Overview
) - User Management (
(cls) Users
) - Instance Management (
(cls) Instance
) - Daemon Management (
(cls) Daemon
) - File Management (
(cls) File
) - Image Management (
(cls) Image
)
Supported MCSM versions
The current version of MCSMAPI client supports the following MCSM versions:
- 10.2.1
- 10.1.0
Compatible Python versions
- Python version 3.7 and above.
Contribution
If you find any issues or have improvement suggestions, please feel free to submit Issue or create a Pull Request.
License
Please refer to LICENSE File for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mcsmapi-0.1.1.tar.gz
(10.4 kB
view hashes)
Built Distribution
mcsmapi-0.1.1-py3-none-any.whl
(12.3 kB
view hashes)