add command history

minor bump

.github/workflows/publish.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip 
-          pip install "virtualenv<21" hatch
+          pip install hatch
 
       - name: Build package
         run: hatch build

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

README.md

@@ -66,6 +66,12 @@ Q3RCON_TUI_RAW=false
 Q3RCON_TUI_APPEND=false
 ```
 
+## Use
+
+Type in your Rcon command and press ENTER.
+
+Press `Ctrl+q` to exit from the application.
+
 ## Special Thanks
 
 - [lapetus-11](https://github.com/Iapetus-11) for writing the [aio-q3-rcon](https://github.com/Iapetus-11/aio-q3-rcon) package.

src/q3rcon_tui/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2026-present onyx-and-iris <code@onyxandiris.online>
 #
 # SPDX-License-Identifier: MIT
-__version__ = '0.7.0'
+__version__ = '0.8.0'

src/q3rcon_tui/configscreen.py

@@ -1,3 +1,5 @@
+from typing import Literal
+
 from pydantic import ValidationError
 from textual.app import ComposeResult
 from textual.containers import Horizontal, Vertical
@@ -51,15 +53,13 @@ class ConfigScreen(ModalScreen[bool]):
         self._clear_field_errors()
 
         try:
-            new_host = self.query_one('#host-input', Input).value.strip() or 'localhost'
-            new_port = self.query_one('#port-input', Input).value
-            new_password = self.query_one('#password-input', Input).value
-
-            try:
-                new_port = int(new_port or '28960')
-            except ValueError:
-                self._show_field_error('port-input', 'Port must be a valid number')
-                return
+            new_host: str = (
+                self.query_one('#host-input', Input).value.strip() or 'localhost'
+            )
+            new_port: int | Literal[28960] = (
+                self.query_one('#port-input', Input).value or 28960
+            )
+            new_password: str = self.query_one('#password-input', Input).value
 
             self._settings.host = new_host
             self._settings.port = new_port

src/q3rcon_tui/history.py

@@ -0,0 +1,23 @@
+from collections import UserList
+
+
+class CommandHistory(UserList):
+    """A simple list to store command history."""
+
+    def add(self, command: str):
+        """Add a command to the history if it's not empty and not a duplicate of the last."""
+        command = command.strip()
+        if command and (not self.data or command != self.data[-1]):
+            self.data.append(command)
+
+    def get_previous(self, index: int) -> str:
+        """Get the previous command based on the current index."""
+        if 0 <= index < len(self.data):
+            return self.data[index]
+        return ''
+
+    def get_next(self, index: int) -> str:
+        """Get the next command based on the current index."""
+        if 0 <= index < len(self.data):
+            return self.data[index]
+        return ''

src/q3rcon_tui/tui.py

@@ -4,17 +4,29 @@ from textual.containers import Grid
 from textual.widgets import Button, Input, RichLog
 
 from .configscreen import ConfigScreen
+from .history import CommandHistory
 from .settings import Settings
 from .writable import Writable
 
 
 class Q3RconTUI(App):
     CSS_PATH = 'q3rcon_tui.tcss'
+    CMD_CONFIG = {
+        'status': (2, 0.25, False),
+        'fast_restart': (3, 1, True),
+        'map_restart': (3, 1, True),
+        'map': (3, 1, True),
+        'map_rotate': (3, 1, True),
+    }
+    DEFAULT_TIMEOUT = 2
+    DEFAULT_FRAGMENT_READ_TIMEOUT = 0.25
 
     def __init__(self):
         super().__init__()
         self._settings = Settings()
         self.writable = Writable(self)
+        self._command_history = CommandHistory()
+        self._history_index = None
 
     def compose(self) -> ComposeResult:
         yield Grid(
@@ -31,9 +43,33 @@ class Q3RconTUI(App):
         if self.screen and isinstance(self.screen, ConfigScreen):
             return
 
+        command_input = self.query_one('#command', Input)
         match event.key:
-            case 'enter' if self.query_one('#command', Input).has_focus:
+            case 'enter' if command_input.has_focus:
+                value = command_input.value.strip()
+                if value:
+                    self._command_history.add(value)
+                self._history_index = None
                 self.query_one('#send', Button).press()
+            case 'up' if command_input.has_focus:
+                if self._command_history:
+                    if self._history_index is None:
+                        self._history_index = len(self._command_history) - 1
+                    elif self._history_index > 0:
+                        self._history_index -= 1
+                    command_input.value = self._command_history.get_previous(
+                        self._history_index
+                    )
+            case 'down' if command_input.has_focus:
+                if self._command_history and self._history_index is not None:
+                    if self._history_index < len(self._command_history) - 1:
+                        self._history_index += 1
+                        command_input.value = self._command_history.get_next(
+                            self._history_index
+                        )
+                    else:
+                        self._history_index = None
+                        command_input.value = ''
             case 'f2':
                 self.query_one('#config', Button).press()
 
@@ -65,11 +101,20 @@ class Q3RconTUI(App):
             self.app.bell()
             return
 
+        timeout, fragment_read_timeout, interpret = Q3RconTUI.CMD_CONFIG.get(
+            cmd.split()[0].lower(),
+            (Q3RconTUI.DEFAULT_TIMEOUT, Q3RconTUI.DEFAULT_FRAGMENT_READ_TIMEOUT, False),
+        )
+
         try:
             async with Client(
-                self._settings.host, self._settings.port, self._settings.password
+                self._settings.host,
+                self._settings.port,
+                self._settings.password,
+                timeout=timeout,
+                fragment_read_timeout=fragment_read_timeout,
             ) as client:
-                response = await client.send_command(cmd)
+                response = await client.send_command(cmd, interpret=interpret)
                 self.query_one('#response', RichLog).write(
                     self.writable.parse(cmd, response)
                 )