edge-containers-cli 5.3.0__tar.gz → 5.4.0__tar.gz

{edge_containers_cli-5.3.0 → edge_containers_cli-5.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edge-containers-cli
-Version: 5.3.0
+Version: 5.4.0
 Summary: CLI for deploying and managing epics containers IOCs and services
 Author-email: Giles Knap <giles.knap@gmail.com>
 License:                                  Apache License
@@ -216,12 +216,12 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: natsort
-Requires-Dist: typer[all]
+Requires-Dist: typer
 Requires-Dist: requests
 Requires-Dist: ruamel.yaml
 Requires-Dist: jinja2
 Requires-Dist: polars-lts-cpu
-Requires-Dist: textual>=7.4
+Requires-Dist: textual<9,>=7.4
 Requires-Dist: urllib3<2.4.0
 Dynamic: license-file
 

{edge_containers_cli-5.3.0 → edge_containers_cli-5.4.0}/docs/reference/cli.md

@@ -135,20 +135,46 @@ List all tagged versions of `SERVICE` found in the repository.
 #### `ec ps`
 
 ```
-$ ec ps [-r/--running-only]
+$ ec ps [-r/--running-only] [-w/--wide]
 ```
 
-List the services in the current target as a table. `-r/--running-only`
-restricts the output to services that are currently running.
+List the services in the current target as a table, with these columns:
+
+| Column | Meaning |
+|---|---|
+| name | The service name |
+| health | Argo CD's health for the service: `Healthy`, `Progressing`, `Degraded`, `Suspended`, `Missing` or `Unknown`, with ` (Stopped)` appended after `ec stop` |
+| sync | Argo CD's sync status: `Synced`, `OutOfSync` or `Unknown` |
+| version | The version the service is deployed at (its target revision) |
+| last sync | When Argo CD last finished syncing the service. A deploy and `ec restart` both update it |
+| description | The service's description (see `ec set-desc`), empty when unset |
+
+`-w/--wide` adds a `properties` column with the service's labels.
+`-r/--running-only` restricts the output to services that are `Healthy` and
+not stopped.
+
+On the Argo CD backend, `ec ps` makes a single `argocd app list` call however
+many services there are. The K8S backend shows a service as `Healthy` when a
+replica is ready and `Degraded` otherwise, leaves `sync` and `properties`
+empty, and shows the StatefulSet's creation time as `last sync`.
 
 #### `ec monitor`
 
 ```
-$ ec monitor [-r/--running-only]
+$ ec monitor [-r/--running-only] [-w/--wide]
 ```
 
-Open the interactive TUI monitor. `-r/--running-only` starts it showing only
-running services. The monitor can also be served as a web application — see the
+Open the interactive TUI monitor. It shows the same columns as `ec ps`, with
+`description` as a real column; `-w/--wide` adds `properties`, as for `ec ps`.
+`-r/--running-only` starts it showing only running services.
+
+Click a column header, or press `o`, to sort by it — the sorted column's
+header is marked `▲` (ascending) or `▼` (descending). Pressing `o` again
+cycles to the next column (always ascending); clicking the header that's
+already the sort column, or pressing `d`, toggles its direction instead.
+Sort order is kept across the monitor's background refreshes.
+
+The monitor can also be served as a web application — see the
 [README](https://github.com/epics-containers/edge-containers-cli#monitor).
 
 #### `ec logs SERVICE`

{edge_containers_cli-5.3.0 → edge_containers_cli-5.4.0}/pyproject.toml

@@ -16,12 +16,15 @@ description = "CLI for deploying and managing epics containers IOCs and services
 
 dependencies = [
     "natsort",
-    "typer[all]",
+    "typer",
     "requests",
     "ruamel.yaml",
     "jinja2",
     "polars-lts-cpu",
-    "textual>=7.4",
+    # <9: MonitorApp overrides the private _set_pointer_shape (see monitor.py)
+    # to silence Textual's unconditional OSC 22 pointer-shape escape, which
+    # some terminals print as garbage. Re-check that override on any bump.
+    "textual>=7.4,<9",
     # urllib>=2.4.0 fails to validate DLS Kubernetes certificates
     # https://github.com/kubernetes-client/python/issues/2394
     "urllib3<2.4.0",

{edge_containers_cli-5.3.0 → edge_containers_cli-5.4.0}/src/edge_containers_cli/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '5.3.0'
-__version_tuple__ = version_tuple = (5, 3, 0)
+__version__ = version = '5.4.0'
+__version_tuple__ = version_tuple = (5, 4, 0)
 
-__commit_id__ = commit_id = 'gd1a3f17c8'
+__commit_id__ = commit_id = 'ge3b4c5ecd'

{edge_containers_cli-5.3.0 → edge_containers_cli-5.4.0}/src/edge_containers_cli/cli.py

@@ -1,5 +1,5 @@
 import os
-import re
+import sys
 from pathlib import Path
 
 import rich
@@ -28,24 +28,19 @@ def confirmation(message: str, yes: bool):
         raise typer.Abort()
 
 
-def _check_description(desc_text: str | None):
-    _desc_re = r"^[a-zA-Z0-9](?:(?!--)[a-zA-Z0-9-]){0,62}$"
-    if desc_text is not None:
-        if not re.match(_desc_re, desc_text):
-            raise typer.BadParameter(
-                f"The description '{desc_text}' is not kebab-case or uses illegal characters.\n\
-Only alphanumeric characters and '-' are allowed."
-            )
-    return desc_text
-
-
 class ErrorHandlingTyper(typer.Typer):
     def __call__(self, *args, **kwargs):
         try:
             super().__call__(*args, **kwargs)
         except (CommandError, ShellError, GitError) as e:
+            # super().__call__() has already returned/raised by this point,
+            # so we are outside typer/click's own invocation context and
+            # `raise typer.Exit(1)` here would do nothing but propagate as
+            # an unhandled RuntimeError - it is only meaningful when raised
+            # from inside a command. sys.exit() is what actually reports
+            # the failure to the calling shell.
             log.error(e)
-            typer.Exit(1)
+            sys.exit(1)
 
 
 cli = ErrorHandlingTyper(pretty_exceptions_show_locals=False)
@@ -106,8 +101,8 @@ async def deploy(
     description: str | None = typer.Option(
         None,
         "--desc",
-        help="Custom description label for the service",
-        callback=_check_description,
+        help="Free-text description for the service (Argo CD backend only). "
+        "Pass an empty string to clear it.",
     ),
     wait: bool = typer.Option(False, "--wait", help="Waits for readiness"),
     yes: bool = typer.Option(False, "-y", "--yes", help="Skip confirmation prompt"),
@@ -261,13 +256,16 @@ def monitor(
     running_only: bool = typer.Option(
         False, "-r", "--running-only", help="list only services that are running"
     ),
+    wide: bool = typer.Option(
+        False, "-w", "--wide", help="also show each service's properties (labels)"
+    ),
 ):
     """Open monitor TUI"""
     from edge_containers_cli.cmds.monitor import (
         MonitorApp,  # Lazy import for performace
     )
 
-    app = MonitorApp(backend.commands, running_only)
+    app = MonitorApp(backend.commands, running_only, wide)
     app.run()
 
 
@@ -276,9 +274,12 @@ def ps(
     running_only: bool = typer.Option(
         False, "-r", "--running-only", help="list only services that are running"
     ),
+    wide: bool = typer.Option(
+        False, "-w", "--wide", help="also show each service's properties (labels)"
+    ),
 ):
     """List the services running in the current target"""
-    backend.commands.ps(running_only)
+    backend.commands.ps(running_only, wide)
 
 
 @cli.command()
@@ -295,6 +296,41 @@ async def restart(
     await backend.commands.restart(service_name)
 
 
+@cli.command(name="set-desc")
+@async_command
+async def set_desc(
+    service_name: str = typer.Argument(
+        ...,
+        help="Name of the service to update",
+        autocompletion=all_svc,
+        show_default=False,
+    ),
+    description: str = typer.Argument(
+        ...,
+        help="New free-text description for the service. Pass an empty "
+        "string to clear it.",
+        show_default=False,
+    ),
+    yes: bool = typer.Option(False, "-y", "--yes", help="Skip confirmation prompt"),
+):
+    """
+    Change a service's description without a version or --desc round trip.
+
+    Does not restart the service, and does not change its deployed
+    version or enabled state.
+    """
+
+    def confirm_callback(old_desc: str | None, new_desc: str):
+        message = (
+            f"[bold]Set description of [white]{service_name.lower()}[/white]"
+            f" on target [white]{backend.commands.target}[/white]"
+            f" from [white]{old_desc}[/white] to [white]{new_desc}[/white][/bold]"
+        )
+        confirmation(message, yes)
+
+    await backend.commands.set_description(service_name, description, confirm_callback)
+
+
 @cli.command()
 @async_command
 async def start(