Skip to main content

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

Project description

MCSM API

Supported MCSManager Versions Python Version PyPI Downloads

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.

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

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

# 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()

# Get MCSM version
mcsm_version = mcsm.overview().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.

Project details


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.2.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcsmapi-0.1.2-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file mcsmapi-0.1.2.tar.gz.

File metadata

  • Download URL: mcsmapi-0.1.2.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for mcsmapi-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f3ad7ba67b0e886895b2c2497a48d76a14fd8859ba324d5327b523e482c193f7
MD5 1bad826e8450915c1eeb2b7127bee282
BLAKE2b-256 91e81292e8713abdf542a50ff13c66f5d6e3ae14dc561a728a3c4bc4188f3e51

See more details on using hashes here.

File details

Details for the file mcsmapi-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: mcsmapi-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for mcsmapi-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 35c38c65cf2e8610f4af03c5e6dd3dd53a94d98dc6cd05bccad3fe6c3ab3dd81
MD5 f3bc94426f29efbd258ea0fa37a88142
BLAKE2b-256 1c925d0ede4460ed2243831e07be95ee402ea094f8f615f8c9b8bcad7fe2c832

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page