| Name | berconpy JSON |
| Version |
2.1.4
JSON |
| download |
| home_page | None |
| Summary | An async wrapper for the BattlEye RCON protocol |
| upload_time | 2024-04-05 16:16:11 |
| maintainer | None |
| docs_url | None |
| author | thegamecracks |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# berconpy
[](https://pypi.org/project/berconpy/)
[](http://berconpy.readthedocs.io/)
An asynchronous Python wrapper over the
[BattlEye RCON protocol][1].
## Features
- Easy to use event-based interface
- Automatic network loss recovery
- Included extension for using Arma-related commands
## Basic Usage
```py
import asyncio
import berconpy
client = berconpy.AsyncRCONClient()
IP = "XXX.XXX.XXX.XXX"
PORT = 9999
PASSWORD = "ASCII_PASSWORD"
@client.dispatch.on_login
async def on_login():
print("We have logged in!")
async def main():
async with client.connect(IP, PORT, PASSWORD):
players = await client.send_command("players")
print(players)
asyncio.run(main())
```
See the [documentation][2] for more details.
## Installation
(**Python 3.10** or higher is required)
This package can be installed from PyPi using the following command:
```
# Linux/macOS
python3 -m pip install berconpy
# Windows
py -m pip install berconpy
```
If you want to install the development version instead, and you have git installed:
```
pip install git+https://github.com/thegamecracks/berconpy
```
## Related resources
- [BattlEye RCON protocol specification][1]
- [BattlEye RCON commands](https://www.battleye.com/support/documentation/)
- [Arma server commands](https://community.bistudio.com/wiki/Multiplayer_Server_Commands)
## License
This project uses the [MIT][3] License.
[1]: https://github.com/thegamecracks/berconpy/blob/main/docs/source/BERConProtocol.txt
[2]: http://berconpy.readthedocs.io/
[3]: https://github.com/thegamecracks/berconpy/blob/main/LICENSE
Raw data
{
"_id": null,
"home_page": null,
"name": "berconpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "thegamecracks",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4b/7d/cc87942306940fb2a96d8fdde77d106d33e2e25d4493b6fd299c8155a19f/berconpy-2.1.4.tar.gz",
"platform": null,
"description": "# berconpy\n\n[](https://pypi.org/project/berconpy/)\n[](http://berconpy.readthedocs.io/)\n\nAn asynchronous Python wrapper over the\n[BattlEye RCON protocol][1].\n\n## Features\n\n- Easy to use event-based interface\n- Automatic network loss recovery\n- Included extension for using Arma-related commands\n\n## Basic Usage\n\n```py\nimport asyncio\nimport berconpy\n\nclient = berconpy.AsyncRCONClient()\n\nIP = \"XXX.XXX.XXX.XXX\"\nPORT = 9999\nPASSWORD = \"ASCII_PASSWORD\"\n\n@client.dispatch.on_login\nasync def on_login():\n print(\"We have logged in!\")\n\nasync def main():\n async with client.connect(IP, PORT, PASSWORD):\n players = await client.send_command(\"players\")\n print(players)\n\nasyncio.run(main())\n```\n\nSee the [documentation][2] for more details.\n\n## Installation\n\n(**Python 3.10** or higher is required)\n\nThis package can be installed from PyPi using the following command:\n\n```\n# Linux/macOS\npython3 -m pip install berconpy\n\n# Windows\npy -m pip install berconpy\n```\n\nIf you want to install the development version instead, and you have git installed:\n\n```\npip install git+https://github.com/thegamecracks/berconpy\n```\n\n## Related resources\n\n- [BattlEye RCON protocol specification][1]\n- [BattlEye RCON commands](https://www.battleye.com/support/documentation/)\n- [Arma server commands](https://community.bistudio.com/wiki/Multiplayer_Server_Commands)\n\n## License\n\nThis project uses the [MIT][3] License.\n\n[1]: https://github.com/thegamecracks/berconpy/blob/main/docs/source/BERConProtocol.txt\n[2]: http://berconpy.readthedocs.io/\n[3]: https://github.com/thegamecracks/berconpy/blob/main/LICENSE\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An async wrapper for the BattlEye RCON protocol",
"version": "2.1.4",
"project_urls": {
"Documentation": "http://berconpy.readthedocs.io/",
"Homepage": "https://github.com/thegamecracks/berconpy",
"Issue Tracker": "https://github.com/thegamecracks/berconpy/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0dd605c30c994a9b93109fcdef968eb0e2338063c60429ebe3340b77d08b4d80",
"md5": "c7cee9ece387ed0ed84173ea9372eb15",
"sha256": "200001dafe14bf4672e295768c954977ac8ecee3d44e85a795747d77c5f462b5"
},
"downloads": -1,
"filename": "berconpy-2.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7cee9ece387ed0ed84173ea9372eb15",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 43080,
"upload_time": "2024-04-05T16:16:09",
"upload_time_iso_8601": "2024-04-05T16:16:09.474095Z",
"url": "https://files.pythonhosted.org/packages/0d/d6/05c30c994a9b93109fcdef968eb0e2338063c60429ebe3340b77d08b4d80/berconpy-2.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b7dcc87942306940fb2a96d8fdde77d106d33e2e25d4493b6fd299c8155a19f",
"md5": "1ca872359da9df0d0efb3517c88a1a2e",
"sha256": "b8af3a66963bc1b35e1b538d47c78c5a7c0dd74160f0d2726f3d06c2a1df4420"
},
"downloads": -1,
"filename": "berconpy-2.1.4.tar.gz",
"has_sig": false,
"md5_digest": "1ca872359da9df0d0efb3517c88a1a2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 34245,
"upload_time": "2024-04-05T16:16:11",
"upload_time_iso_8601": "2024-04-05T16:16:11.222220Z",
"url": "https://files.pythonhosted.org/packages/4b/7d/cc87942306940fb2a96d8fdde77d106d33e2e25d4493b6fd299c8155a19f/berconpy-2.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 16:16:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thegamecracks",
"github_project": "berconpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "berconpy"
}
