# 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": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "rcon, mcrcon, async, remote console, minecraft",
"author": "Milo Weinberg",
"author_email": "iapetus011@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d6/41/faee444fc870dc3398c1df6d7b48b9fca13100b05a2e5d4bb3144ef0e43e/aio_mc_rcon-3.4.0.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.4.0",
"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",
" remote console",
" minecraft"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56aeb8bde3e098d8d7f9d58c536f4e98863ccb164a9bc511658eaeb2045c2c1b",
"md5": "39402d37c64f21536769ed8718ce3273",
"sha256": "de7988bf77be1f392254663ca700909980fb4e8c727672dd6bd0beaf96ff7b52"
},
"downloads": -1,
"filename": "aio_mc_rcon-3.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39402d37c64f21536769ed8718ce3273",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 4826,
"upload_time": "2025-01-19T02:54:40",
"upload_time_iso_8601": "2025-01-19T02:54:40.789241Z",
"url": "https://files.pythonhosted.org/packages/56/ae/b8bde3e098d8d7f9d58c536f4e98863ccb164a9bc511658eaeb2045c2c1b/aio_mc_rcon-3.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d641faee444fc870dc3398c1df6d7b48b9fca13100b05a2e5d4bb3144ef0e43e",
"md5": "16e9165fb5922e92e2b1aee7d46037a1",
"sha256": "ebba092155a08315256f01f1090d85a4e20b6c01f77e3e6d948a12312557936f"
},
"downloads": -1,
"filename": "aio_mc_rcon-3.4.0.tar.gz",
"has_sig": false,
"md5_digest": "16e9165fb5922e92e2b1aee7d46037a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 3759,
"upload_time": "2025-01-19T02:54:42",
"upload_time_iso_8601": "2025-01-19T02:54:42.424253Z",
"url": "https://files.pythonhosted.org/packages/d6/41/faee444fc870dc3398c1df6d7b48b9fca13100b05a2e5d4bb3144ef0e43e/aio_mc_rcon-3.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 02:54:42",
"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
