https://github.com/molanp/mcsmapi
Shortcut the pypi package of MCSManager./快捷操作MCSManager的pypi包
https://github.com/molanp/mcsmapi
mcsm mcsmanager mcsmanager-sdk pypi pypi-package
Last synced: 9 months ago
JSON representation
Shortcut the pypi package of MCSManager./快捷操作MCSManager的pypi包
- Host: GitHub
- URL: https://github.com/molanp/mcsmapi
- Owner: molanp
- License: mit
- Created: 2024-08-09T18:51:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-06T08:54:08.000Z (9 months ago)
- Last Synced: 2025-10-06T10:33:46.535Z (9 months ago)
- Topics: mcsm, mcsmanager, mcsmanager-sdk, pypi, pypi-package
- Language: Python
- Homepage: https://mcsmapi.awkchan.top/
- Size: 2.21 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MCSM API
[](https://deepwiki.com/molanp/mcsmapi)
English|[Chinese Simplified](README_zh-cn.md)
## Documentation
📄 Docs: [docs](https://mcsmapi.awkchan.top/en/)
💡 Example: [example](example)
## Introduction
`mcsmapi` is a PyPI package based on [MCSManager](https://github.com/MCSManager/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`:
```bash
pip install mcsmapi
```
If you need the latest build files, please visit
[Actions](https://github.com/molanp/mcsmapi/actions/workflows/auto-build.yml)
## Supported Features
- [x] Dashboard data (`Overview`)
- [x] User management (`User`)
- [x] Instance management (`Instance`)
- [x] Daemon management (`Daemon`)
- [x] File management (`File`)
- [x] Image management (`Image`)
## Supported MCSM Versions
| MCSM Version | Support Status |
| :----------: | :------------: |
| 10.x | ✅ |
### Quick Example
```python
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](https://github.com/molanp/mcsmapi/issues) or create a [Pull Request](https://github.com/molanp/mcsmapi/pulls).
## License
`mcsmapi` is licensed under the [MIT License](https://opensource.org/licenses/MIT).
Please refer to the [LICENSE](LICENSE) file for more details.