| Name | mcsmapi JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | https://github.com/molanp/mcsmapi |
| Summary | A Pypi package based on MCSManager, designed to simplify interaction with MCSM API. |
| upload_time | 2024-08-12 11:51:24 |
| maintainer | None |
| docs_url | None |
| author | molanp |
| 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 Client
English|[简体中文](README_zh-cn.md)
## Introduction
`mcsmapi` is a Pypi package based on [MCSManager](https://github.com/MCSManager/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`:
```bash
pip install mcsmapi
```
## Usage method
### Example code
Here are some examples of how to use `mcsmapi`:
```python
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
- [x] Login (`(func) login`)
- [x] Dashboard Data (`(cls) Overview`)
- [x] User Management (`(cls) Users`)
- [x] Instance Management (`(cls) Instance`)
- [x] Daemon Management (`(cls) Daemon`)
- [x] File Management (`(cls) File`)
- [x] 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](https://github.com/molanp/mcsmapi-client/issues) or create a [Pull Request](https://github.com/molanp/mcsmapi-client/pulls).
## License
[MIT License](https://opensource.org/licenses/MIT).
Please refer to [LICENSE](LICENSE) File for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/molanp/mcsmapi",
"name": "mcsmapi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "molanp",
"author_email": "luotian233@foxmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/ce/d4a1ad10002f44fbcb949f60a01112d10bb645fe6d14747b620730bd602d/mcsmapi-0.1.1.tar.gz",
"platform": null,
"description": "# MCSM API Client\n\n\n\n\n\nEnglish|[\u7b80\u4f53\u4e2d\u6587](README_zh-cn.md)\n\n## Introduction\n\n`mcsmapi` is a Pypi package based on [MCSManager](https://github.com/MCSManager/MCSManager), designed to simplify interaction with MCSM API.\n\nThrough this library, you can easily access and operate various functions provided by MCSM.\n\n## Installation\n\nYou can use `pip` to install `mcsmapi`:\n\n```bash\npip install mcsmapi\n```\n\n## Usage method\n\n### Example code\n\nHere are some examples of how to use `mcsmapi`:\n\n```python\nfrom mcsmapi import overview\n\n# if you have a apikey, you can use this method\nclient = Overview(url=\" https://example.com/\",apikey=\"your_api_key\")\n\n# if you do not have a apikey, you can use this method\nclient = Overview(url=\" https://example.com/\")\n# login\nclient.login(username=\"your_username\",password=\"your_password\")\n\n# Get dashboard data\nresponse = client.getData()\nprint(response.json())\n```\n\n### Supported functions\n\n- [x] Login (`(func) login`)\n- [x] Dashboard Data (`(cls) Overview`)\n- [x] User Management (`(cls) Users`)\n- [x] Instance Management (`(cls) Instance`)\n- [x] Daemon Management (`(cls) Daemon`)\n- [x] File Management (`(cls) File`)\n- [x] Image Management (`(cls) Image`)\n\n## Supported MCSM versions\n\nThe current version of MCSMAPI client supports the following MCSM versions:\n\n- 10.2.1\n- 10.1.0\n\n## Compatible Python versions\n\n- Python version 3.7 and above.\n\n## Contribution\n\nIf you find any issues or have improvement suggestions, please feel free to submit [Issue](https://github.com/molanp/mcsmapi-client/issues) or create a [Pull Request](https://github.com/molanp/mcsmapi-client/pulls).\n\n## License\n\n[MIT License](https://opensource.org/licenses/MIT).\n\nPlease refer to [LICENSE](LICENSE) File for more information.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Pypi package based on MCSManager, designed to simplify interaction with MCSM API.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/molanp/mcsmapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c9ba6d7b7d4d99cd6593915a67d8e8d5158b86a0d07be806b0bb5a95e9594e4",
"md5": "5caa008c2f5f52f1adffa99d5bb5a66a",
"sha256": "3b7bc41a68c679ae1b82229035db1ec300ff0014596db803da63ae3d6aca82cc"
},
"downloads": -1,
"filename": "mcsmapi-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5caa008c2f5f52f1adffa99d5bb5a66a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12333,
"upload_time": "2024-08-12T11:51:23",
"upload_time_iso_8601": "2024-08-12T11:51:23.352174Z",
"url": "https://files.pythonhosted.org/packages/2c/9b/a6d7b7d4d99cd6593915a67d8e8d5158b86a0d07be806b0bb5a95e9594e4/mcsmapi-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "38ced4a1ad10002f44fbcb949f60a01112d10bb645fe6d14747b620730bd602d",
"md5": "529219004b0fec5e4aa2b4f7d4a49364",
"sha256": "aec6f5f484214233b43163509916e46a91dda5dd9b61c63e754f227ffa4fdd5a"
},
"downloads": -1,
"filename": "mcsmapi-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "529219004b0fec5e4aa2b4f7d4a49364",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10361,
"upload_time": "2024-08-12T11:51:24",
"upload_time_iso_8601": "2024-08-12T11:51:24.579907Z",
"url": "https://files.pythonhosted.org/packages/38/ce/d4a1ad10002f44fbcb949f60a01112d10bb645fe6d14747b620730bd602d/mcsmapi-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 11:51:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "molanp",
"github_project": "mcsmapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mcsmapi"
}
