| Name | mcsmapi JSON |
| Version |
0.1.7
JSON |
| download |
| home_page | None |
| Summary | Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包 |
| upload_time | 2025-08-15 07:48:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MCSM API
[](https://deepwiki.com/molanp/mcsmapi)
English|[Chinese Simplified](README_zh-cn.md)
> [!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](https://deepwiki.com/molanp/mcsmapi)
You can also find:
📄 Work-in-progress docs: [docs](docs)
💡 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 (untested), 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()
# 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](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.
Raw data
{
"_id": null,
"home_page": null,
"name": "mcsmapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "molanp <molanpp@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/1f/34/98e5f434874fc57c5974ea06fd6597de37bfb6bf2ce8cfbf3dcaa10536ad/mcsmapi-0.1.7.tar.gz",
"platform": null,
"description": "# MCSM API\n\n\n\n\n[](https://deepwiki.com/molanp/mcsmapi)\n\nEnglish|[Chinese Simplified](README_zh-cn.md)\n\n> [!important]\n> 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.\n\n## Documentation\n\nThe documentation is not yet complete, if you need it, please visit [deepwiki-mcsmapi](https://deepwiki.com/molanp/mcsmapi)\n\nYou can also find: \n\n\ud83d\udcc4 Work-in-progress docs: [docs](docs)\n\n\ud83d\udca1 Example: [example](example)\n\n## Introduction\n\n`mcsmapi` is a PyPI package based on [MCSManager](https://github.com/MCSManager/MCSManager), designed to simplify interactions with the MCSM API.\n\nWith this library, you can more easily access and operate the various features provided by MCSM.\n\n## Installation\n\nYou can install `mcsmapi` using `pip`:\n\n```bash\npip install mcsmapi\n```\n\nIf you need the latest build files (untested), please visit\n[Actions](https://github.com/molanp/mcsmapi/actions/workflows/auto-build.yml)\n\n## Supported Features\n\n- [x] Dashboard data (`Overview`)\n- [x] User management (`User`)\n- [x] Instance management (`Instance`)\n- [x] Daemon management (`Daemon`)\n- [x] File management (`File`)\n- [x] Image management (`Image`)\n\n## Supported MCSM Versions\n\n| MCSM Version | Support Status |\n| :---: | :---: |\n| 10.x | \u2705 |\n\n### Quick Example\n\n```python\nfrom mcsmapi import MCSMAPI\n\n# Initialize\nmcsm = MCSMAPI(\"https://example.com\") # https or http required\n\n# Log in with username and password (API permissions depend on the account permissions)\nmcsm.login(\"username\", \"password\")\n\n# Log in with API key (API permissions depend on the API key permissions)\nmcsm.login_with_apikey(\"apikey\")\n\n# Get dashboard data\noverview = mcsm.overview()\n\n# Get MCSM version\nmcsm_version = mcsm.overview().version\n```\n\n## Contributing\n\nIf 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).\n\n## License\n\n`mcsmapi` is licensed under the [MIT License](https://opensource.org/licenses/MIT).\n\nPlease refer to the [LICENSE](LICENSE) file for more details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Shortcut the pypi package of MCSM./\u5feb\u6377\u64cd\u4f5cMCSM\u7684pypi\u5305",
"version": "0.1.7",
"project_urls": {
"Source": "https://github.com/molanp/mcsmapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4d66d688c5a32fea19a5206e9906ef11ffff74408dc3399e9868655fa1fea744",
"md5": "6501ff807b7bec69b3a2d3646d80130a",
"sha256": "38e743810b3f6eef4e7824ad58082c2db53a97240d10c4d3a0bbaf2893f40f66"
},
"downloads": -1,
"filename": "mcsmapi-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6501ff807b7bec69b3a2d3646d80130a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 25587,
"upload_time": "2025-08-15T07:48:27",
"upload_time_iso_8601": "2025-08-15T07:48:27.527000Z",
"url": "https://files.pythonhosted.org/packages/4d/66/d688c5a32fea19a5206e9906ef11ffff74408dc3399e9868655fa1fea744/mcsmapi-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1f3498e5f434874fc57c5974ea06fd6597de37bfb6bf2ce8cfbf3dcaa10536ad",
"md5": "248862a998efb4a9018e6d4dbc877161",
"sha256": "390e758c99a79ac0fa9e44177f2ac87a535f206d5b797c30ca85b9b0199fd2b0"
},
"downloads": -1,
"filename": "mcsmapi-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "248862a998efb4a9018e6d4dbc877161",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19267,
"upload_time": "2025-08-15T07:48:29",
"upload_time_iso_8601": "2025-08-15T07:48:29.271853Z",
"url": "https://files.pythonhosted.org/packages/1f/34/98e5f434874fc57c5974ea06fd6597de37bfb6bf2ce8cfbf3dcaa10536ad/mcsmapi-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-15 07:48:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "molanp",
"github_project": "mcsmapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mcsmapi"
}
