# Aio-MC-RCON   
An asynchronous RCON client/wrapper written in Python for Minecraft Java Edition servers!
## Installation
```
pip install -U aio-mc-rcon
```
## Example Usage
- See the [examples folder](https://github.com/Iapetus-11/aio-mc-rcon/tree/main/examples).
## Documentation
#### *class* aiomcrcon.**Client**(host: *str*, port: *int*, password: *str*):
- Arguments:
- `host: str` - *The hostname / ip of the server to connect to.*
- `port: int` - *The port of the server to connect to.*
- `password: str` - *The password to connect, can be found as the value under `rcon.password` in the `server.properties` file.*
- Methods:
- `connect(timeout: int = 2)` - *where `timeout` has a default value of 2 seconds.*
- `send_cmd(cmd: str, timeout: int = 2)` - *where `cmd` is the command to be executed on the server and timeout has a default value of 2 seconds.*
- `close()` - *closes the connection between the client and server.*
#### *exception* aiomcrcon.**RCONConnectionError**
- *Raised when the connection to the server fails.*
#### *exception* aiomcrcon.**IncorrectPasswordError**
- *Raised when the provided password/authentication is invalid.*
#### *exception* aiomcrcon.**ClientNotConnectedError**
- *Raised when the connect() method hasn't been called yet, and commands cannot be sent.*
Raw data
{
"_id": null,
"home_page": "https://github.com/Iapetus-11/aio-mc-rcon",
"name": "aio-mc-rcon",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "rcon,mcrcon,async",
"author": "Milo Weinberg",
"author_email": "iapetus011@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/39/44/3a1f9756de33ca320c99c2f248f5d3143f82f16d6f5a738373e34ce153bd/aio_mc_rcon-3.2.2.tar.gz",
"platform": null,
"description": "# Aio-MC-RCON   \nAn asynchronous RCON client/wrapper written in Python for Minecraft Java Edition servers!\n\n## Installation\n```\npip install -U aio-mc-rcon\n```\n\n## Example Usage\n- See the [examples folder](https://github.com/Iapetus-11/aio-mc-rcon/tree/main/examples).\n\n## Documentation\n#### *class* aiomcrcon.**Client**(host: *str*, port: *int*, password: *str*):\n- Arguments:\n - `host: str` - *The hostname / ip of the server to connect to.*\n - `port: int` - *The port of the server to connect to.*\n - `password: str` - *The password to connect, can be found as the value under `rcon.password` in the `server.properties` file.*\n- Methods:\n - `connect(timeout: int = 2)` - *where `timeout` has a default value of 2 seconds.*\n - `send_cmd(cmd: str, timeout: int = 2)` - *where `cmd` is the command to be executed on the server and timeout has a default value of 2 seconds.*\n - `close()` - *closes the connection between the client and server.*\n\n#### *exception* aiomcrcon.**RCONConnectionError**\n- *Raised when the connection to the server fails.*\n\n#### *exception* aiomcrcon.**IncorrectPasswordError**\n- *Raised when the provided password/authentication is invalid.*\n\n#### *exception* aiomcrcon.**ClientNotConnectedError**\n- *Raised when the connect() method hasn't been called yet, and commands cannot be sent.*\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An async library for utilizing remote console on Minecraft Java Edition servers",
"version": "3.2.2",
"project_urls": {
"Homepage": "https://github.com/Iapetus-11/aio-mc-rcon",
"Repository": "https://github.com/Iapetus-11/aio-mc-rcon"
},
"split_keywords": [
"rcon",
"mcrcon",
"async"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b97503122cdc5639eda618e671e6c8cfae8b708479b294d48d78d5292cbdc0f2",
"md5": "e7bd4a9116a99cb8636034d45c464e38",
"sha256": "3eab224a323e2499a4bc996593691356ac7eb458aed020fbe826d98a22b2452a"
},
"downloads": -1,
"filename": "aio_mc_rcon-3.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7bd4a9116a99cb8636034d45c464e38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 4807,
"upload_time": "2023-12-30T20:33:24",
"upload_time_iso_8601": "2023-12-30T20:33:24.007165Z",
"url": "https://files.pythonhosted.org/packages/b9/75/03122cdc5639eda618e671e6c8cfae8b708479b294d48d78d5292cbdc0f2/aio_mc_rcon-3.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39443a1f9756de33ca320c99c2f248f5d3143f82f16d6f5a738373e34ce153bd",
"md5": "0fbc41c75271be9ff8532ad61331964d",
"sha256": "59439a0cafd2a51ad579bc91271b8dc8ff02417d31dd9cc35e56ba68fe52e1ed"
},
"downloads": -1,
"filename": "aio_mc_rcon-3.2.2.tar.gz",
"has_sig": false,
"md5_digest": "0fbc41c75271be9ff8532ad61331964d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4040,
"upload_time": "2023-12-30T20:33:25",
"upload_time_iso_8601": "2023-12-30T20:33:25.603679Z",
"url": "https://files.pythonhosted.org/packages/39/44/3a1f9756de33ca320c99c2f248f5d3143f82f16d6f5a738373e34ce153bd/aio_mc_rcon-3.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-30 20:33:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Iapetus-11",
"github_project": "aio-mc-rcon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aio-mc-rcon"
}
JSON
