| Name | python-mcstatus JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | The unofficial python library for interacting with the mcstatus.io API. |
| upload_time | 2024-09-02 22:18:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python MCStatus
[](https://pypi.org/project/python-mcstatus)
[](https://pypi.org/project/python-mcstatus)
[](https://github.com/pypa/hatch)
-----
Python MCStatus is a library which wraps around the [mcstatus.io](https://mcstatus.io) API. It is developed very similar
to the [node-mcstatus](https://www.npmjs.com/package/node-mcstatus) npm package. It's essentially the same just ported to python.
**Table of Contents**
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## Installation
To install this package open your terminal for your workspace and use the following command:
```console
pip install python-mcstatus
```
## Usage
### Java Status
```python
from python_mcstatus import JavaStatusResponse, statusJava
host = 'demo.mcstatus.io'
port = 25565
query = True
response: JavaStatusResponse = statusJava(host, port, query) # port is optional and defaults to 25565
# You can receive and error in the above when the response is not 200, this copies the functionality from the node library.
```
### Bedrock Status
```python
from python_mcstatus import BedrockStatusResponse, statusBedrock
host = 'demo.mcstatus.io'
port = 19132
response: BedrockStatusResponse = statusBedrock(host, port) # port argument is optional and defaults to 19132
```
## License
`python-mcstatus` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "python-mcstatus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Duve3 <Duv3tabest@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/16/f9/3b87209b6f492aa15993403a5ba54bf152c3b0ae55bdf7485669193975b3/python_mcstatus-0.0.2.tar.gz",
"platform": null,
"description": "# Python MCStatus\n\n[](https://pypi.org/project/python-mcstatus)\n[](https://pypi.org/project/python-mcstatus)\n[](https://github.com/pypa/hatch)\n\n-----\nPython MCStatus is a library which wraps around the [mcstatus.io](https://mcstatus.io) API. It is developed very similar\nto the [node-mcstatus](https://www.npmjs.com/package/node-mcstatus) npm package. It's essentially the same just ported to python.\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#license)\n\n## Installation\n\nTo install this package open your terminal for your workspace and use the following command:\n```console\npip install python-mcstatus\n```\n\n## Usage\n### Java Status\n```python\nfrom python_mcstatus import JavaStatusResponse, statusJava\n\nhost = 'demo.mcstatus.io'\nport = 25565\nquery = True\n\nresponse: JavaStatusResponse = statusJava(host, port, query) # port is optional and defaults to 25565\n# You can receive and error in the above when the response is not 200, this copies the functionality from the node library.\n```\n\n### Bedrock Status\n```python\nfrom python_mcstatus import BedrockStatusResponse, statusBedrock\n\nhost = 'demo.mcstatus.io'\nport = 19132\n\nresponse: BedrockStatusResponse = statusBedrock(host, port) # port argument is optional and defaults to 19132\n```\n\n\n## License\n\n`python-mcstatus` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": null,
"summary": "The unofficial python library for interacting with the mcstatus.io API.",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://github.com/Duve3/python-mcstatus#readme",
"Issues": "https://github.com/Duve3/python-mcstatus/issues",
"Source": "https://github.com/Duve3/python-mcstatus"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e7a3255b0b31349eae62b195523dc454f9c88f67dae3220f10a4211ecc76c03c",
"md5": "725e2da57e09bd5a1b824f5b3092a507",
"sha256": "000a643ea3d68138a3c439daf566570a6d6ea1db95e54f324471fa0a52e5b738"
},
"downloads": -1,
"filename": "python_mcstatus-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "725e2da57e09bd5a1b824f5b3092a507",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5425,
"upload_time": "2024-09-02T22:18:11",
"upload_time_iso_8601": "2024-09-02T22:18:11.259568Z",
"url": "https://files.pythonhosted.org/packages/e7/a3/255b0b31349eae62b195523dc454f9c88f67dae3220f10a4211ecc76c03c/python_mcstatus-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "16f93b87209b6f492aa15993403a5ba54bf152c3b0ae55bdf7485669193975b3",
"md5": "6d34975830211ecccd06207d9a403fe5",
"sha256": "5e696c0faa30dd12584147196de2cd292cfb740ccbfc0cd32c0780e7dbaf4b9c"
},
"downloads": -1,
"filename": "python_mcstatus-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "6d34975830211ecccd06207d9a403fe5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 10133,
"upload_time": "2024-09-02T22:18:12",
"upload_time_iso_8601": "2024-09-02T22:18:12.493222Z",
"url": "https://files.pythonhosted.org/packages/16/f9/3b87209b6f492aa15993403a5ba54bf152c3b0ae55bdf7485669193975b3/python_mcstatus-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 22:18:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Duve3",
"github_project": "python-mcstatus#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "python-mcstatus"
}
