Merge pull request #131 from ggozad/fix/prompt-widget

Allow customizing select key bindings.

CHANGES.txt

@@ -4,6 +4,9 @@ Changelog
 0.6.5 - 
 ------------------
 
+- Allow customizing select key bindings.
+  [ggozad]
+
 - Fixed erroneous OLLAMA_URL documentaion.
   [gerroon] 
 

README.md

@@ -19,6 +19,7 @@ the text-based terminal client for [Ollama](https://github.com/ollama/ollama).
     - [Customizing models](#customizing-models)
     - [Chat session storage](#chat-session-storage)
     - [App configuration](#app-configuration)
+    - [Key bindings](#key-bindings)
     - [Screenshots](#screenshots)
   - [License](#license)
 
@@ -178,6 +179,22 @@ You can set the following options in the configuration file:
 
 `theme` can be either `dark` or `light`. `splash-screen` controls whether the splash screen is shown on startup.
 
+### Key bindings
+
+We strive to have sane default key bindings, but there will always be cases where your terminal emulator or shell will interfere. You can customize select keybindings by editing the app config `config.json` file. The following are the defaults:
+
+```json
+{
+  ...
+  "keymap": {
+    "next.chat": "ctrl+tab",
+    "prev.chat": "ctrl+shift+tab",
+    "quit": "ctrl+q",
+    "newline": "shift+enter",
+  }
+}
+```
+
 ### Screenshots
 ![Splash](screenshots/splash.gif)
 The splash screen animation that greets users when they start oterm.

pyproject.toml

@@ -20,7 +20,7 @@ classifiers = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "textual>=0.81.0",
+    "textual>=0.83.0",
     "typer>=0.12.4",
     "python-dotenv>=1.0.1",
     "aiosql>=11.1",

src/oterm/app/oterm.py

@@ -3,6 +3,7 @@
 
 from textual import on, work
 from textual.app import App, ComposeResult, SystemCommand
+from textual.binding import Binding
 from textual.screen import Screen
 from textual.widgets import Footer, Header, TabbedContent, TabPane
 
@@ -20,9 +21,9 @@ class OTerm(App):
     SUB_TITLE = "A terminal-based Ollama client."
     CSS_PATH = "oterm.tcss"
     BINDINGS = [
-        ("ctrl+tab", "cycle_chat(+1)", "next chat"),
-        ("ctrl+shift+tab", "cycle_chat(-1)", "prev chat"),
-        ("ctrl+q", "quit", "quit"),
+        Binding("ctrl+tab", "cycle_chat(+1)", "next chat", id="next.chat"),
+        Binding("ctrl+shift+tab", "cycle_chat(-1)", "prev chat", id="prev.chat"),
+        Binding("ctrl+q", "quit", "quit", id="quit"),
     ]
 
     def get_system_commands(self, screen: Screen) -> Iterable[SystemCommand]:
@@ -164,6 +165,11 @@ async def on_mount(self) -> None:
         self.dark = appConfig.get("theme") == "dark"
         saved_chats = await store.get_chats()
 
+        # Apply any remap of key bindings.
+        keymap = appConfig.get("keymap")
+        if keymap:
+            self.set_keymap(keymap)
+
         async def on_splash_done(message) -> None:
             if not saved_chats:
                 # Pyright suggests awaiting here which has bitten me twice

src/oterm/app/widgets/prompt.py

@@ -36,6 +36,7 @@ class PostableTextArea(TextArea):
             show=True,
             key_display=None,
             priority=True,
+            id="newline",
         ),
     ]
 
@@ -54,7 +55,7 @@ def action_submit(self) -> None:
     def action_newline(self) -> None:
         cur = self.cursor_location
         lines = self.text.split("\n")
-        lines[cur[0]] = lines[cur[0]][:cur[1]] + "\n" + lines[cur[0]][cur[1]:]
+        lines[cur[0]] = lines[cur[0]][: cur[1]] + "\n" + lines[cur[0]][cur[1] :]
         self.text = "\n".join(lines)
         self.cursor_location = (cur[0] + 1, 0)
 
@@ -68,6 +69,7 @@ class PastableInput(Input):
             show=True,
             key_display=None,
             priority=True,
+            id="toggle.multiline",
         ),
     ]
 
@@ -92,7 +94,7 @@ class FlexibleInput(Widget):
     text = reactive("")
 
     BINDINGS = [
-        ("ctrl+i", "add_image", "add image"),
+        Binding("ctrl+i", "add_image", "add image", id="add.image"),
     ]
 
     @dataclass

tests/test_ollama_api.py

@@ -12,7 +12,6 @@ def test_list():
 def test_show():
     llm = OllamaLLM()
     response = llm.show("llama3.2")
-    print(response.keys())
     for key in [
         "modelfile",
         "parameters",