rconx 0.1.0__tar.gz

rconx-0.1.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

rconx-0.1.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: rconx
+Version: 0.1.0
+Summary: A Python implementation of the Source RCON protocol with client, server, and Minecraft compatibility
+Author: Fallen_Breath
+License-Expression: LGPL-3.0-only
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: dataclasses>=0.8 ; python_full_version < '3.7'
+Requires-Dist: importlib-metadata>=1.0 ; python_full_version < '3.8'
+Requires-Dist: typing-extensions>=4.1
+Requires-Dist: rconx-cli>=0.1.0 ; extra == 'cli'
+Requires-Python: >=3.6
+Project-URL: Repository, https://github.com/Fallen-Breath/rconx
+Project-URL: Issues, https://github.com/Fallen-Breath/rconx/issues
+Provides-Extra: cli
+Description-Content-Type: text/markdown
+
+# rconx
+
+[![License](https://img.shields.io/badge/license-LGPL--3.0--only-blue.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/rconx.svg)](https://pypi.org/project/rconx/)
+[![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)](#installation)
+
+rconx is a Python library for communicating with TCP servers [that use the Source RCON packet format](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol). It provides synchronous and asynchronous clients for authentication and command execution, together with servers for exposing an application's own command handlers over RCON.
+
+The clients collect command results using selectable presets, including SRCDS, Minecraft, and Cuberite. Low-level clients and servers are available for applications that need to exchange individual RCON packets. The command-line interface executes commands from a terminal or script.
+
+## Installation
+
+rconx supports Python 3.8 and later, with best-effort compatibility for Python 3.6 and 3.7. The examples below use Python 3.8 or later.
+
+rconx is available on [PyPI](https://pypi.org/project/rconx/):
+
+```sh
+python -m pip install rconx
+```
+
+## Quick start
+
+These examples execute `list` on a Minecraft server with RCON enabled.
+
+### Synchronous client
+
+```python
+from rconx import RconClient, RconPreset
+
+with RconClient.create("127.0.0.1", 25575, RconPreset.minecraft) as client:
+	client.connect()
+	client.authenticate("your-rcon-password")
+	response = client.execute("list")
+	print(response.text)
+```
+
+### Asynchronous client
+
+```python
+import asyncio
+
+from rconx import AsyncRconClient, RconPreset
+
+
+async def main():
+	async with AsyncRconClient.create("127.0.0.1", 25575, RconPreset.minecraft) as client:
+		await client.connect()
+		await client.authenticate("your-rcon-password")
+		response = await client.execute("list")
+		print(response.text)
+
+
+asyncio.run(main())
+```
+
+## Documentation
+
+- The [client guide](docs/client.md) describes client usage, presets, command results, and error handling. It also records compatibility and testing status for individual servers.
+- The [server guide](docs/server.md) describes business callbacks, connection handling, and service lifecycle.
+- The [command-line guide](docs/cli.md) describes installation, command execution, interactive mode, and output handling.
+
+## License
+
+rconx is licensed under [LGPL-3.0-only](LICENSE).

rconx-0.1.0/README.md

@@ -0,0 +1,64 @@
+# rconx
+
+[![License](https://img.shields.io/badge/license-LGPL--3.0--only-blue.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/rconx.svg)](https://pypi.org/project/rconx/)
+[![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)](#installation)
+
+rconx is a Python library for communicating with TCP servers [that use the Source RCON packet format](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol). It provides synchronous and asynchronous clients for authentication and command execution, together with servers for exposing an application's own command handlers over RCON.
+
+The clients collect command results using selectable presets, including SRCDS, Minecraft, and Cuberite. Low-level clients and servers are available for applications that need to exchange individual RCON packets. The command-line interface executes commands from a terminal or script.
+
+## Installation
+
+rconx supports Python 3.8 and later, with best-effort compatibility for Python 3.6 and 3.7. The examples below use Python 3.8 or later.
+
+rconx is available on [PyPI](https://pypi.org/project/rconx/):
+
+```sh
+python -m pip install rconx
+```
+
+## Quick start
+
+These examples execute `list` on a Minecraft server with RCON enabled.
+
+### Synchronous client
+
+```python
+from rconx import RconClient, RconPreset
+
+with RconClient.create("127.0.0.1", 25575, RconPreset.minecraft) as client:
+	client.connect()
+	client.authenticate("your-rcon-password")
+	response = client.execute("list")
+	print(response.text)
+```
+
+### Asynchronous client
+
+```python
+import asyncio
+
+from rconx import AsyncRconClient, RconPreset
+
+
+async def main():
+	async with AsyncRconClient.create("127.0.0.1", 25575, RconPreset.minecraft) as client:
+		await client.connect()
+		await client.authenticate("your-rcon-password")
+		response = await client.execute("list")
+		print(response.text)
+
+
+asyncio.run(main())
+```
+
+## Documentation
+
+- The [client guide](docs/client.md) describes client usage, presets, command results, and error handling. It also records compatibility and testing status for individual servers.
+- The [server guide](docs/server.md) describes business callbacks, connection handling, and service lifecycle.
+- The [command-line guide](docs/cli.md) describes installation, command execution, interactive mode, and output handling.
+
+## License
+
+rconx is licensed under [LGPL-3.0-only](LICENSE).

rconx-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "rconx"
+version = "0.1.0"
+description = "A Python implementation of the Source RCON protocol with client, server, and Minecraft compatibility"
+license = "LGPL-3.0-only"
+license-files = ["LICENSE"]
+readme = "README.md"
+requires-python = ">=3.6"
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "dataclasses>=0.8 ; python_full_version < '3.7'",
+    "importlib-metadata>=1.0 ; python_version < '3.8'",
+    "typing-extensions>=4.1",
+]
+
+[[project.authors]]
+name = "Fallen_Breath"
+
+[project.urls]
+Repository = "https://github.com/Fallen-Breath/rconx"
+Issues = "https://github.com/Fallen-Breath/rconx/issues"
+
+[project.optional-dependencies]
+cli = ["rconx_cli>=0.1.0"]
+
+[build-system]
+requires = ["uv_build>=0.13.1,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=0.971",
+    "pytest>=7.0.1",
+]
+
+[tool.uv.sources.rconx_cli]
+path = "rconx_cli"

rconx-0.1.0/pyproject.toml.orig

@@ -0,0 +1,54 @@
+[project]
+name = "rconx"
+version = "0.1.0"
+description = "A Python implementation of the Source RCON protocol with client, server, and Minecraft compatibility"
+
+license = "LGPL-3.0-only"
+license-files = ["LICENSE"]
+readme = "README.md"
+requires-python = ">=3.6"
+authors = [
+    { name = "Fallen_Breath" }
+]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "dataclasses>=0.8 ; python_full_version < '3.7'",
+    "importlib-metadata>=1.0 ; python_version < '3.8'",
+    "typing-extensions>=4.1",
+]
+
+[project.urls]
+Repository = "https://github.com/Fallen-Breath/rconx"
+Issues = "https://github.com/Fallen-Breath/rconx/issues"
+
+[project.optional-dependencies]
+cli = [
+    "rconx_cli>=0.1.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.13.1,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=0.971",
+    "pytest>=7.0.1",
+]
+
+# https://docs.astral.sh/uv/concepts/projects/dependencies/#dependency-sources
+[tool.uv.sources]
+rconx_cli = { path = "rconx_cli" }

rconx-0.1.0/src/rconx/__init__.py

@@ -0,0 +1,68 @@
+from rconx.client.client import AsyncRconClient, RconClient
+from rconx.client.client_options import RconClientOptions
+from rconx.client.preset import RconPreset
+from rconx.client.raw import AsyncRawRconClient, LocalAddress, RawRconClient
+from rconx.common.connection import AsyncConnection, Connection
+from rconx.common.connection_info import ConnectionAddress, ConnectionInfo
+from rconx.common.connection_options import ConnectionOptions
+from rconx.common.content import RconContent
+from rconx.common.exceptions import (
+	RconAuthenticationError,
+	RconConnectionError,
+	RconError,
+	RconPacketDecodeError,
+	RconProtocolError,
+	RconStateError,
+	RconTimeoutError,
+)
+from rconx.common.protocol import Packet, PacketType
+from rconx.server.raw import AsyncRawRconServer, RawRconServer
+from rconx.server.raw_options import RawRconServerOptions
+from rconx.server.server import AsyncRconServer, RconServer
+from rconx.server.server_options import RconServerOptions
+
+__all__ = [
+	# High-level clients
+	'RconClient',
+	'AsyncRconClient',
+	'RconPreset',
+	'RconClientOptions',
+
+	# Low-level clients
+	'RawRconClient',
+	'AsyncRawRconClient',
+	'LocalAddress',
+
+	# High-level servers
+	'RconServer',
+	'AsyncRconServer',
+	'RconServerOptions',
+
+	# Low-level servers
+	'RawRconServer',
+	'AsyncRawRconServer',
+	'RawRconServerOptions',
+
+	# Low-level connections
+	'Connection',
+	'AsyncConnection',
+	'ConnectionOptions',
+
+	# Shared data
+	'RconContent',
+	'ConnectionInfo',
+	'ConnectionAddress',
+
+	# Protocol
+	'Packet',
+	'PacketType',
+
+	# Exceptions
+	'RconError',
+	'RconConnectionError',
+	'RconTimeoutError',
+	'RconPacketDecodeError',
+	'RconAuthenticationError',
+	'RconStateError',
+	'RconProtocolError',
+]

rconx-0.1.0/src/rconx/__main__.py

@@ -0,0 +1,5 @@
+from rconx.cli.main import main
+
+
+if __name__ == '__main__':
+	main()

rconx-0.1.0/src/rconx/cli/arguments.py

@@ -0,0 +1,128 @@
+import argparse
+import dataclasses
+import os
+import sys
+from typing import List, Optional
+
+from rconx.client.preset import RconPreset
+from rconx.common.connection_info import ConnectionAddress
+from rconx.common.utils import validate_packet_size_limit, validate_timeout
+
+
+def __get_self_version() -> str:
+	try:
+		if sys.version_info >= (3, 8):
+			from importlib.metadata import version
+		else:
+			from importlib_metadata import version
+		return version('rconx')
+	except Exception:
+		return 'unknown'
+
+
+@dataclasses.dataclass(frozen=True)
+class SizeLimit:
+	value: Optional[int]
+
+
+@dataclasses.dataclass(frozen=True)
+class CliOptions:
+	address: ConnectionAddress
+	password: str = dataclasses.field(repr=False)
+	commands: List[str]
+	preset: RconPreset
+	interactive: bool
+	timeout: Optional[float]
+	idle_window: Optional[float]
+	encoding: Optional[str]
+	raw: bool
+	max_send_packet_size: Optional[SizeLimit]
+	max_receive_packet_size: Optional[SizeLimit]
+	max_response_size: Optional[SizeLimit]
+
+
+def compute_address(value: str) -> ConnectionAddress:
+	if value.startswith('['):
+		closing = value.find(']')
+		if closing < 0 or value[closing + 1:closing + 2] != ':':
+			raise ValueError('expected HOST:PORT or [IPv6]:PORT')
+		host = value[1:closing]
+		port_text = value[closing + 2:]
+		if ':' not in host or '[' in host:
+			raise ValueError('expected [IPv6]:PORT')
+	else:
+		host, separator, port_text = value.rpartition(':')
+		if not separator or ':' in host or '[' in host or ']' in host:
+			raise ValueError('expected HOST:PORT or [IPv6]:PORT')
+	if not host:
+		raise ValueError('host must not be empty')
+	if not port_text or any(character < '0' or character > '9' for character in port_text):
+		raise ValueError('port must be a decimal integer from 1 to 65535')
+	port = int(port_text)
+	if not 1 <= port <= 65535:
+		raise ValueError('port must be from 1 to 65535')
+	return ConnectionAddress(host, port)
+
+
+def seconds(value: str) -> float:
+	seconds = float(value)
+	validate_timeout(seconds)
+	return seconds
+
+
+def timeout(value: str) -> Optional[float]:
+	return None if value == 'none' else seconds(value)
+
+
+def size_limit(value: str) -> SizeLimit:
+	size = None if value == 'none' else int(value)
+	validate_packet_size_limit(size, 'size limit')
+	return SizeLimit(size)
+
+
+def parse_args() -> CliOptions:
+	parser = argparse.ArgumentParser(
+		prog='rconx',
+		usage='%(prog)s [OPTIONS] HOST:PORT [COMMAND ...]',
+		description='Put every local option before HOST:PORT; use [IPv6]:PORT for IPv6 addresses.',
+		epilog='Each COMMAND is one complete command string. After HOST:PORT, all arguments are commands, including --help, -i and --. '
+			'Without -i, zero commands check the connection and authentication. With -i, interaction follows the startup commands.',
+	)
+	password_source = parser.add_mutually_exclusive_group(required=True)
+	password_source.add_argument('-p', '--password', metavar='PASSWORD', help='password; an explicitly empty value is allowed')
+	password_source.add_argument('--password-env', metavar='NAME', help='read the password from environment variable NAME')
+	parser.add_argument('-P', '--preset', choices=[preset.name for preset in RconPreset], default='minecraft', help='RCON exchange preset (default: %(default)s)')
+	parser.add_argument('-i', '--interactive', action='store_true', help='read commands interactively after the startup commands')
+	parser.add_argument('-t', '--timeout', type=timeout, default=10.0, metavar='SECONDS|none', help='timeout for each connect, authentication or command operation (default: 10 seconds)')
+	parser.add_argument('--idle-window', type=seconds, metavar='SECONDS', help='response quiet window; required and valid only for the idle_timeout preset')
+	parser.add_argument('--encoding', metavar='NAME', help='password, command and response text encoding (default: core utf8)')
+	parser.add_argument('--raw', action='store_true', help='write response bytes; incompatible with -i')
+	parser.add_argument('--max-send-packet-size', type=size_limit, metavar='BYTES|none', help='send packet size limit; none disables it (default: selected preset)')
+	parser.add_argument('--max-receive-packet-size', type=size_limit, metavar='BYTES|none', help='receive packet size limit; none disables it (default: core limit)')
+	parser.add_argument('--max-response-size', type=size_limit, metavar='BYTES|none', help='accumulated response size limit; none disables it (default: core limit)')
+	parser.add_argument('--version', action='version', version='%(prog)s {}'.format(__get_self_version()))
+	parser.add_argument('items', nargs=argparse.REMAINDER, metavar='HOST:PORT [COMMAND ...]', help='target address followed by zero or more complete command strings')
+	arguments = parser.parse_args()
+
+	if not arguments.items:
+		raise ValueError('HOST:PORT is required')
+	if (arguments.preset == 'idle_timeout') != (arguments.idle_window is not None):
+		raise ValueError('--idle-window is required and valid only for idle_timeout')
+	if arguments.raw and arguments.interactive:
+		raise ValueError('--raw cannot be combined with --interactive')
+	password = os.environ[arguments.password_env] if arguments.password_env is not None else arguments.password
+
+	return CliOptions(
+		address=compute_address(arguments.items[0]),
+		password=password,
+		commands=arguments.items[1:],
+		preset=RconPreset[arguments.preset],
+		interactive=arguments.interactive,
+		timeout=arguments.timeout,
+		idle_window=arguments.idle_window,
+		encoding=arguments.encoding,
+		raw=arguments.raw,
+		max_send_packet_size=arguments.max_send_packet_size,
+		max_receive_packet_size=arguments.max_receive_packet_size,
+		max_response_size=arguments.max_response_size,
+	)