Skip to main content

WebRcon Package

Install

pip install webrcon
or
pip install https://github.com/lewdneko/webrcon/archive/master.zip

Docs

webrcon.RconConnector(host, port, password, message_callback=None, console_callback=None)

Initialises the class
host: str - the IP/hostname of the server accepting WebRcon
port: Union[str, int] - the port the server is accepting WebRcon on
password: str - the password used to connect over WebRcon
message_callback: func - a sync or async function that is called whenever a chat message is sent
console_callback: func - a sync or async function that is called whenever a console message is sent

await RconConnector.start(loop, **kwargs)

Opens a connection to the server
loop - an asyncio event loop, can be obtained through asyncio.get_event_loop()
kwargs - passed to websockets.client.connect - read the docs

await RconConnector.close()

Closes the connection to the server

await RconConnector.command(command, callback)

Sends a command over RCON to the server
command: str - The command you want to be sent to the server
callback: func - A sync/async function that should take a single argument. The passed value will be a dict consisting of the output from the RCON server.
The response to your command will be under the Message key.

webrcon.InvalidServer

Your host/port/password combination is incorrect or the server isn't running.

webrcon.ConnectionClosed

You closed the connection and still tried to send a command. Good one.

Metadata

Release files for webrcon 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for webrcon 1.1.0
File Size Uploaded
webrcon-1.1.0.tar.gz 4.0 kB Details

Release files / webrcon-1.1.0.tar.gz

Download URL webrcon-1.1.0.tar.gz
Size 4.0 kB
Tags Source
SHA-256 checksum
How to use checksums
f9fa9d19b51c600ea3e7b84afaaf757853547ffac53f19527fc46772ab8d00d2
BLAKE2b-256 checksum
How to use checksums
7615c4b03b764b593c077854a368126e58b41ac28b9d8a1074143a25cc88582d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.2

Release history Release notifications | RSS feed

This release

1.1.0 This release

1 release file

1.0.8

1 release file

1.0.7

1 release file

1.0.6

1 release file

1.0.5

1 release file

1.0.4

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page