| Name | mcsmapi JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包 |
| upload_time | 2025-02-08 03:27:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MCSM API
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.
## 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
```
## Supported Features
- [x] Dashboard data ([Overview](doc/en/Overview.md))
- [x] User management ([User](doc/en/User.md))
- [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")
# 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": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "molanp <molanpp@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/15/0e/e3e8a932e5b20eb7ff7cde006d0bbe65b9404b9b167b3427191d8d44a2db/mcsmapi-0.1.3.tar.gz",
"platform": null,
"description": "# MCSM API\n\n\n\n\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## 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\n## Supported Features\n\n- [x] Dashboard data ([Overview](doc/en/Overview.md))\n- [x] User management ([User](doc/en/User.md))\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\")\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.3",
"project_urls": {
"Source": "https://github.com/molanp/mcsmapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ee82e26fa39994c6d58f5b43d06e4bdf17b597ce7b513c3a45ff2744d3128a33",
"md5": "e1b588028b7fe3f938f8eb7b9687713a",
"sha256": "6b1229bbbc8098e3d7898b5b9ab25115b4e6bad995d8c8a4e2e4369522fad196"
},
"downloads": -1,
"filename": "mcsmapi-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1b588028b7fe3f938f8eb7b9687713a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19887,
"upload_time": "2025-02-08T03:27:49",
"upload_time_iso_8601": "2025-02-08T03:27:49.937202Z",
"url": "https://files.pythonhosted.org/packages/ee/82/e26fa39994c6d58f5b43d06e4bdf17b597ce7b513c3a45ff2744d3128a33/mcsmapi-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "150ee3e8a932e5b20eb7ff7cde006d0bbe65b9404b9b167b3427191d8d44a2db",
"md5": "8f7fd7a89f8745fb788fcae9365eda9c",
"sha256": "f364e7fd00f82723360434f4c48b036de00a6eacabbd37e81988a4d0b0b1d90f"
},
"downloads": -1,
"filename": "mcsmapi-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "8f7fd7a89f8745fb788fcae9365eda9c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15807,
"upload_time": "2025-02-08T03:27:52",
"upload_time_iso_8601": "2025-02-08T03:27:52.420613Z",
"url": "https://files.pythonhosted.org/packages/15/0e/e3e8a932e5b20eb7ff7cde006d0bbe65b9404b9b167b3427191d8d44a2db/mcsmapi-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-08 03:27:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "molanp",
"github_project": "mcsmapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mcsmapi"
}
