🔀 Merge pull request #152 from davep/key-bindings

Add support for rebinding commands to different keys

Author: davep

ChangeLog.md

@@ -1,5 +1,20 @@
 # Braindrop ChangeLog
 
+## Unreleased
+
+**Released: WiP**
+
+- Added support for rebinding the keys for application commands.
+  ([#152](https://github.com/davep/braindrop/pull/152))
+- Added `--bindings` as a command line switch.
+  ([#152](https://github.com/davep/braindrop/pull/152))
+- Added `--help` as a command line switch.
+  ([#152](https://github.com/davep/braindrop/pull/152))
+- Added `--license` as a command line switch.
+  ([#152](https://github.com/davep/braindrop/pull/152))
+- Added `--version` as a command line switch.
+  ([#152](https://github.com/davep/braindrop/pull/152))
+
 ## v0.7.3
 
 **Released: 2025-04-27**

src/braindrop/__main__.py

@@ -1,25 +1,106 @@
 """Main entry point for the application."""
 
+##############################################################################
+# Python imports.
+from argparse import ArgumentParser, Namespace
+from inspect import cleandoc
+from operator import attrgetter
+
+##############################################################################
+# Textual enhanced imports.
+from textual_enhanced.commands import Command
+
 ##############################################################################
 # Local imports.
+from . import __doc__, __version__
 from .app import Braindrop
 from .app.data import ExitState
 
 
+##############################################################################
+def get_args() -> Namespace:
+    """Get the command line arguments.
+
+    Returns:
+        The arguments.
+    """
+
+    # Build the parser.
+    parser = ArgumentParser(
+        prog="braindrop",
+        description=__doc__,
+        epilog=f"v{__version__}",
+    )
+
+    # Add --version
+    parser.add_argument(
+        "-v",
+        "--version",
+        help="Show version information",
+        action="version",
+        version=f"%(prog)s v{__version__}",
+    )
+
+    # Add --license
+    parser.add_argument(
+        "--license",
+        "--licence",
+        help="Show license information",
+        action="store_true",
+    )
+
+    # Add --bindings
+    parser.add_argument(
+        "-b",
+        "--bindings",
+        help="List commands that can have their bindings changed",
+        action="store_true",
+    )
+
+    # Finally, parse the command line.
+    return parser.parse_args()
+
+
+##############################################################################
+def show_bindable_commands() -> None:
+    """Show the commands that can have bindings applied."""
+    from rich.console import Console
+    from rich.markup import escape
+
+    from .app.screens import Main
+
+    console = Console(highlight=False)
+    command: type[Command]
+    for command in sorted(Main.COMMAND_MESSAGES, key=attrgetter("__name__")):
+        if command().has_binding:
+            console.print(
+                f"[bold]{escape(command.__name__)}[/] [dim italic]- {escape(command.tooltip())}[/]"
+            )
+            console.print(
+                f"    [dim italic]Default: {escape(command.binding().key)}[/]"
+            )
+
+
 ##############################################################################
 def main() -> None:
     """Main entry point."""
-    match Braindrop().run():
-        case ExitState.TOKEN_FORGOTTEN:
-            if Braindrop.environmental_token():
-                print(
-                    "It looks like your token is held in an environment variable. "
-                    "If you wish to have that forgotten you will need to remove it yourself."
-                )
-            else:
-                print("The locally-held copy of your API token has been removed.")
-        case ExitState.TOKEN_NEEDED:
-            print("An API token is needed to be able to connect to raindrop.io.")
+    args = get_args()
+    if args.license:
+        print(cleandoc(Braindrop.HELP_LICENSE))
+    elif args.bindings:
+        show_bindable_commands()
+    else:
+        match Braindrop().run():
+            case ExitState.TOKEN_FORGOTTEN:
+                if Braindrop.environmental_token():
+                    print(
+                        "It looks like your token is held in an environment variable. "
+                        "If you wish to have that forgotten you will need to remove it yourself."
+                    )
+                else:
+                    print("The locally-held copy of your API token has been removed.")
+            case ExitState.TOKEN_NEEDED:
+                print("An API token is needed to be able to connect to raindrop.io.")
 
 
 ##############################################################################

src/braindrop/app/braindrop.py

@@ -64,6 +64,7 @@ def __init__(self) -> None:
                 self.theme = configuration.theme
             except InvalidThemeError:
                 pass
+        self.update_keymap(configuration.bindings)
 
     def watch_theme(self) -> None:
         """Save the application's theme when it's changed."""

src/braindrop/app/data/config.py

@@ -3,7 +3,7 @@
 ##############################################################################
 # Python imports.
 from contextlib import contextmanager
-from dataclasses import asdict, dataclass
+from dataclasses import asdict, dataclass, field
 from functools import lru_cache
 from json import dumps, loads
 from pathlib import Path
@@ -31,6 +31,9 @@ class Configuration:
     compact_mode: bool = False
     """Use compact mode?"""
 
+    bindings: dict[str, str] = field(default_factory=dict)
+    """Command keyboard binding overrides."""
+
 
 ##############################################################################
 def configuration_file() -> Path: