customizable descriptions for all drivers

this allows override of the default strings to show up in the jmp shell CLI.
exporter:
  driver_x:
    type: x
    description: "this command does x"

Author: michalskrivanek

packages/jumpstarter-driver-composite/jumpstarter_driver_composite/client.py

@@ -34,7 +34,7 @@ def close(self):
                 v.close()
 
     def cli(self):
-        @click.group
+        @click.group(help=self.description or "Generic composite device")
         @click.option(
             "--log-level",
             "log_level",
@@ -44,7 +44,6 @@ def cli(self):
             callback=_opt_log_level_callback,
         )
         def base():
-            """Generic composite device"""
             pass
 
         for k, v in self.children.items():

packages/jumpstarter-driver-flashers/jumpstarter_driver_flashers/client.py

@@ -750,9 +750,8 @@ def _validate_bearer_token(self, token: str | None) -> str | None:
         return token
 
     def cli(self):
-        @click.group
+        @click.group(help=self.description or "Software-defined flasher interface")
         def base():
-            """Software-defined flasher interface"""
             pass
 
         @base.command()

packages/jumpstarter-driver-gpiod/jumpstarter_driver_gpiod/client.py

@@ -34,9 +34,8 @@ def read(self):
         return PinState(int(self.call("read_pin")))
 
     def cli(self):
-        @click.group()
+        @click.group(help=self.description or "GPIO power control commands.")
         def gpio():
-            """GPIO power control commands."""
             pass
 
         for cmd in super().cli().commands.values():
@@ -79,9 +78,8 @@ def read(self):
         return PinState(int(self.call("read_pin")))
 
     def cli(self):
-        @click.group()
+        @click.group(help=self.description or "GPIO input commands.")
         def gpio():
-            """GPIO input commands."""
             pass
 
         @gpio.command()

packages/jumpstarter-driver-network/jumpstarter_driver_network/client.py

@@ -20,9 +20,8 @@ def address(self):
         return self.call("address")
 
     def cli(self):
-        @click.group
+        @click.group(help=self.description or "Generic Network Connection")
         def base():
-            """Generic Network Connection"""
             pass
 
         @base.command()

packages/jumpstarter-driver-power/jumpstarter_driver_power/client.py

@@ -35,9 +35,8 @@ def read(self) -> Generator[PowerReading, None, None]:
             yield PowerReading.model_validate(v, strict=True)
 
     def cli(self):
-        @click.group
+        @click.group(help=self.description or "Generic power")
         def base():
-            """Generic power"""
             pass
 
         @base.command()

packages/jumpstarter-driver-pyserial/jumpstarter_driver_pyserial/client.py

@@ -36,9 +36,8 @@ def pexpect(self):
             yield adapter
 
     def cli(self):
-        @click.group
+        @click.group(help=self.description or "Serial port client")
         def base():
-            """Serial port client"""
             pass
 
         @base.command()

packages/jumpstarter-driver-ridesx/jumpstarter_driver_ridesx/client.py

@@ -102,7 +102,7 @@ def flash(
     def cli(self):
         generic_cli = FlasherClient.cli(self)
 
-        @click.group()
+        @click.group(help=self.description or "RideSX storage operations")
         def storage():
             pass
 

packages/jumpstarter-driver-shell/jumpstarter_driver_shell/client.py

@@ -41,9 +41,8 @@ def execute(*args, **kwargs):
 
     def cli(self):
         """Create CLI interface for dynamically configured shell methods"""
-        @click.group
+        @click.group(help=self.description or "Shell command executor")
         def base():
-            """Shell command executor"""
             pass
 
         # Get available methods from the driver
@@ -80,12 +79,12 @@ def method_command(args, env):
         except Exception:
             description = f"Execute {method_name}"
 
-        # Decorate and register the command
-        method_command.__doc__ = description
+        # Decorate and register the command with help text
         method_command = click.argument('args', nargs=-1, type=click.UNPROCESSED)(method_command)
         method_command = click.option('--env', '-e', multiple=True,
                      help='Environment variables in KEY=VALUE format')(method_command)
         method_command = group.command(
             name=method_name,
+            help=description,
             context_settings={"ignore_unknown_options": True, "allow_interspersed_args": False},
         )(method_command)

packages/jumpstarter-driver-snmp/jumpstarter_driver_snmp/client.py

@@ -17,9 +17,8 @@ def off(self):
         self.call("off")
 
     def cli(self):
-        @click.group()
+        @click.group(help=self.description or "SNMP power control commands")
         def snmp():
-            """SNMP power control commands"""
             pass
 
         for cmd in super().cli().commands.values():

packages/jumpstarter-driver-tmt/jumpstarter_driver_tmt/driver_test.py

@@ -1,6 +1,5 @@
 from unittest.mock import MagicMock, patch
 
-import click
 import pytest
 from click.testing import CliRunner
 from jumpstarter_driver_network.driver import TcpNetwork