edge-containers-cli 5.0.1b2__tar.gz → 5.2.0__tar.gz

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 5.0.0a3-3-g238de53
+_commit: 5.0.2
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: giles.knap@gmail.com
 author_name: Giles Knap

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/.github/CONTRIBUTING.md

@@ -24,4 +24,4 @@ It is recommended that developers use a [vscode devcontainer](https://code.visua
 
 This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects.
 
-For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/5.0.0a3/how-to.html).
+For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/5.0.2/how-to.html).

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/.github/workflows/_test.yml

@@ -9,9 +9,6 @@ on:
         type: string
         description: The runner to run this job on
         required: true
-    secrets:
-      CODECOV_TOKEN:
-        required: true
 
 env:
   # https://github.com/pytest-dev/pytest/issues/2042
@@ -40,5 +37,3 @@ jobs:
         with:
           name: ${{ inputs.python-version }}/${{ inputs.runs-on }}
           files: cov.xml
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/.github/workflows/ci.yml

@@ -25,8 +25,6 @@ jobs:
     with:
       runs-on: ${{ matrix.runs-on }}
       python-version: ${{ matrix.python-version }}
-    secrets:
-      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   container:
     needs: test

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     rev: v5.0.0
     hooks:
       - id: check-added-large-files
-        args: ["--maxkb=1000"] # uv.lock is more than 500kB
+        exclude: ^uv.lock
       - id: check-yaml
         # omit helm templates which are not valid yaml
         exclude: ^.*configmap.yaml$

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edge-containers-cli
-Version: 5.0.1b2
+Version: 5.2.0
 Summary: CLI for deploying and managing epics containers IOCs and services
 Author-email: Giles Knap <giles.knap@gmail.com>
 License:                                  Apache License
@@ -220,7 +220,7 @@ Requires-Dist: requests
 Requires-Dist: ruamel.yaml
 Requires-Dist: jinja2
 Requires-Dist: polars-lts-cpu
-Requires-Dist: textual
+Requires-Dist: textual>=7.4
 Requires-Dist: urllib3<2.4.0
 Dynamic: license-file
 

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/pyproject.toml

@@ -20,7 +20,7 @@ dependencies = [
     "ruamel.yaml",
     "jinja2",
     "polars-lts-cpu",
-    "textual",
+    "textual>=7.4",
     # urllib>=2.4.0 fails to validate DLS Kubernetes certificates
     # https://github.com/kubernetes-client/python/issues/2394
     "urllib3<2.4.0",
@@ -117,7 +117,7 @@ commands = [
     [
         "pyright",
         "--pythonpath",
-        ".venv/bin/python",
+        "{env:VIRTUAL_ENV}/bin/python",
         "src",
         "tests",
         { replace = "posargs", default = [

edge_containers_cli-5.2.0/renovate.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  "lockFileMaintenance": {
+    "description": "Keep uv.lock up to date, merging if tests pass",
+    "enabled": true,
+    "automerge": true
+  },
+  "packageRules": [
+    {
+      "description": "Disable python version as that is managed by python-copier-template",
+      "matchManagers": [
+        "pyenv"
+      ],
+      "enabled": false
+    },
+    {
+      "description": "Disable github actions that are managed by python-copier-template",
+      "matchPackageNames": [
+        "actions/checkout",
+        "astral-sh/setup-uv",
+        "actions/upload-artifact",
+        "actions/download-artifact",
+        "softprops/action-gh-release",
+        "codecov/codecov-action",
+        "docker/setup-buildx-action",
+        "docker/login-action",
+        "docker/build-push-action",
+        "docker/metadata-action",
+        "pypa/gh-action-pypi-publish"
+      ],
+      "matchManagers": [
+        "github-actions"
+      ],
+      "enabled": false
+    }
+  ]
+}

edge_containers_cli-5.2.0/src/edge_containers_cli/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '5.2.0'
+__version_tuple__ = version_tuple = (5, 2, 0)
+
+__commit_id__ = commit_id = 'g400995ffa'

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/src/edge_containers_cli/autocomplete.py

@@ -9,7 +9,12 @@ from edge_containers_cli.cmds.commands import CommandError
 from edge_containers_cli.definitions import ECContext
 from edge_containers_cli.git import GitError, create_version_map
 from edge_containers_cli.shell import ShellError
-from edge_containers_cli.utils import cache_dict, new_workdir, read_cached_dict
+from edge_containers_cli.utils import (
+    _run_async,
+    cache_dict,
+    new_workdir,
+    read_cached_dict,
+)
 
 
 def url_encode(in_string: str) -> str:
@@ -32,11 +37,13 @@ def fetch_service_graph(repo: str) -> dict:
     )
     if not version_map:
         with new_workdir() as path:
-            version_map = create_version_map(
-                repo,
-                Path(globals.SERVICES_DIR),
-                path,
-                shared_files=[globals.SHARED_VALUES],
+            version_map = _run_async(
+                create_version_map(
+                    repo,
+                    Path(globals.SERVICES_DIR),
+                    path,
+                    shared_files=[globals.SHARED_VALUES],
+                )
             )
             cache_dict(
                 globals.CACHE_ROOT / url_encode(repo),

{edge_containers_cli-5.0.1b2 → edge_containers_cli-5.2.0}/src/edge_containers_cli/cli.py

@@ -1,6 +1,8 @@
 import os
+import re
 from pathlib import Path
 
+import rich
 import typer
 
 import edge_containers_cli.globals as globals
@@ -17,14 +19,26 @@ from edge_containers_cli.definitions import ENV
 from edge_containers_cli.git import GitError, list_all, list_instances
 from edge_containers_cli.logging import log
 from edge_containers_cli.shell import ShellError
+from edge_containers_cli.utils import async_command
 
 
 def confirmation(message: str, yes: bool):
-    typer.echo(message)
+    rich.print(message)
     if not (yes or typer.confirm("Are you sure?")):
         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:
@@ -38,7 +52,8 @@ cli = ErrorHandlingTyper(pretty_exceptions_show_locals=False)
 
 
 @cli.command()
-def attach(
+@async_command
+async def attach(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service to attach to",
@@ -49,11 +64,12 @@ def attach(
     """
     Attach to the console of a live service
     """
-    backend.commands.attach(service_name)
+    await backend.commands.attach(service_name)
 
 
 @cli.command()
-def delete(
+@async_command
+async def delete(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service to delete",
@@ -69,11 +85,12 @@ def delete(
         f"Remove {service_name} from the target `{backend.commands.target}`",
         yes,
     )
-    backend.commands.delete(service_name)
+    await backend.commands.delete(service_name)
 
 
 @cli.command()
-def deploy(
+@async_command
+async def deploy(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service to deploy",
@@ -86,6 +103,12 @@ def deploy(
         autocompletion=avail_versions,
         show_default=False,
     ),
+    description: str | None = typer.Option(
+        None,
+        "--desc",
+        help="Custom description label for the service",
+        callback=_check_description,
+    ),
     wait: bool = typer.Option(False, "--wait", help="Waits for readiness"),
     yes: bool = typer.Option(False, "-y", "--yes", help="Skip confirmation prompt"),
     args: str = typer.Option(
@@ -96,20 +119,28 @@ def deploy(
     Add a service to the cluster from its source repository
     """
 
-    def confirm_callback(svc_version):
+    def confirm_callback(svc_version: str, current_desc: str | None):
+        message = (
+            f"[bold]Deploy [white]{service_name.lower()}[/white]"
+            f" version [white]{svc_version}[/white] to target [white]{backend.commands.target}[/white] with \
+{'existing ' if description is None else ''}description [white]{current_desc}[/white][/bold]"
+        )
+
         confirmation(
-            f"Deploy {service_name.lower()} "
-            f" version `{svc_version}` to target `{backend.commands.target}`",
+            message,
             yes,
         )
 
     args = args if not wait else args + " --wait"
     version = version if version != "latest tag" else ""
-    backend.commands.deploy(service_name, version, args, confirm_callback)
+    await backend.commands.deploy(
+        service_name, version, description, args, confirm_callback
+    )
 
 
 @cli.command()
-def deploy_local(
+@async_command
+async def deploy_local(
     svc_instance: Path = typer.Argument(
         ...,
         help="folder of local service definition",
@@ -133,7 +164,7 @@ def deploy_local(
             yes,
         )
 
-    backend.commands.deploy_local(svc_instance, args, confirm_callback)
+    await backend.commands.deploy_local(svc_instance, args, confirm_callback)
 
 
 @cli.command()
@@ -144,7 +175,8 @@ def env():
 
 
 @cli.command()
-def exec(
+@async_command
+async def exec(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service container to run in",
@@ -153,11 +185,12 @@ def exec(
     ),
 ):
     """Execute a bash prompt in a running container"""
-    backend.commands.exec(service_name)
+    await backend.commands.exec(service_name)
 
 
 @cli.command()
-def instances(
+@async_command
+async def instances(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service to inspect",
@@ -167,7 +200,7 @@ def instances(
 ):
     """List all versions of the specified service in the repository"""
     print(
-        list_instances(
+        await list_instances(
             service_name,
             backend.commands.repo,
             Path(globals.SERVICES_DIR),
@@ -177,10 +210,11 @@ def instances(
 
 
 @cli.command(name="list")
-def _list():
+@async_command
+async def _list():
     """List all services available in the service repository"""
     print(
-        list_all(
+        await list_all(
             backend.commands.repo,
             Path(globals.SERVICES_DIR),
             shared_files=[globals.SHARED_VALUES],
@@ -189,7 +223,8 @@ def _list():
 
 
 @cli.command()
-def log_history(
+@async_command
+async def log_history(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service to inspect",
@@ -198,11 +233,12 @@ def log_history(
     ),
 ):
     """Open historical logs for a service"""
-    backend.commands.log_history(service_name)
+    await backend.commands.log_history(service_name)
 
 
 @cli.command()
-def logs(
+@async_command
+async def logs(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service to inspect",
@@ -217,7 +253,7 @@ def logs(
     ),
 ):
     """Show logs for current and previous instances of a service"""
-    backend.commands.logs(service_name, prev)
+    await backend.commands.logs(service_name, prev)
 
 
 @cli.command()
@@ -246,7 +282,8 @@ def ps(
 
 
 @cli.command()
-def restart(
+@async_command
+async def restart(
     service_name: str = typer.Argument(
         ...,
         help="Name of the container to restart",
@@ -255,47 +292,54 @@ def restart(
     ),
 ):
     """Restart a service"""
-    backend.commands.restart(service_name)
+    await backend.commands.restart(service_name)
 
 
 @cli.command()
-def start(
+@async_command
+async def start(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service container to start",
         autocompletion=all_svc,
         show_default=False,
     ),
-    commit: bool = typer.Option(True, help="Commits the values to the git repo"),
+    commit: bool = typer.Option(
+        False, help="Also commit the change to the git repo for an audit trail"
+    ),
 ):
     """Start a service"""
     try:
-        backend.commands.start(service_name, commit=commit)
+        await backend.commands.start(service_name, commit=commit)
     except GitError as e:
         msg = f"{str(e)} - Commit failed. Try 'ec start <service> --no-commit to set values without updating git"
         raise GitError(msg) from e
 
 
 @cli.command()
-def stop(
+@async_command
+async def stop(
     service_name: str = typer.Argument(
         ...,
         help="Name of the service container to stop",
         autocompletion=running_svc,
         show_default=False,
     ),
-    commit: bool = typer.Option(True, help="Commits the values to the git repo"),
+    commit: bool = typer.Option(
+        False, help="Also commit the change to the git repo for an audit trail"
+    ),
 ):
     """Stop a service"""
     try:
-        backend.commands.stop(service_name, commit=commit)
+        await backend.commands.stop(service_name, commit=commit)
     except GitError as e:
         msg = f"{str(e)} - Commit failed. Try ec stop <service> --no-commit to set values without updating git"
         raise GitError(msg) from e
 
 
 @cli.command()
-def template(
+@async_command
+async def template(
     svc_instance: Path = typer.Argument(
         ...,
         help="folder of local service definition",
@@ -311,7 +355,7 @@ def template(
     Print out the helm template generated from a local service instance
     """
     args = f"{args} --debug"
-    backend.commands.template(svc_instance, args)
+    await backend.commands.template(svc_instance, args)
 
 
 def drop_methods(ctx: typer.Context, to_drop: list[str]):