edge-containers-cli 4.0.0__tar.gz → 4.1.1__tar.gz

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.copier-answers.yml

@@ -1,15 +1,15 @@
 # Changes here will be overwritten by Copier
-_commit: 1.3.0
+_commit: 2.3.0
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: giles.knap@gmail.com
 author_name: Giles Knap
-component_owner: group:default/sscc
 description: CLI for deploying and managing epics containers IOCs and services
 distribution_name: edge-containers-cli
-docker: false
+docker: true
 docs_type: README
 git_platform: github.com
 github_org: epics-containers
 package_name: edge_containers_cli
+pypi: true
 repo_name: edge-containers-cli
 type_checker: pyright

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.devcontainer/devcontainer.json

@@ -43,4 +43,4 @@
     "workspaceMount": "source=${localWorkspaceFolder}/..,target=/workspaces,type=bind",
     // After the container is created, install the python project in editable form
     "postCreateCommand": "pip install $([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e '.[dev]' && pre-commit install"
-}
+}

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.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/1.3.0/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/2.3.0/how-to.html).

edge_containers_cli-4.1.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug Report
+about: The template to use for reporting bugs and usability issues
+title: " "
+labels: 'bug'
+assignees: ''
+
+---
+
+Describe the bug, including a clear and concise description of the expected behavior, the actual behavior and the context in which you encountered it (ideally include details of your environment).
+
+## Steps To Reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+
+## Acceptance Criteria
+- Specific criteria that will be used to judge if the issue is fixed

edge_containers_cli-4.1.1/.github/ISSUE_TEMPLATE/issue.md

@@ -0,0 +1,13 @@
+---
+name: Issue
+about: The standard template to use for feature requests, design discussions and tasks
+title: " "
+labels: ''
+assignees: ''
+
+---
+
+A brief description of the issue, including specific stakeholders and the business case where appropriate
+
+## Acceptance Criteria
+- Specific criteria that will be used to judge if the issue is fixed

edge_containers_cli-4.1.1/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,8 @@
+Fixes #ISSUE
+
+### Instructions to reviewer on how to test:
+1. Do thing x
+2. Confirm thing y happens
+
+### Checks for reviewer
+- [ ] Would the PR title make sense to a user on a set of release notes

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.github/pages/index.html

@@ -8,4 +8,4 @@
     <link rel="canonical" href="main/index.html">
 </head>
 
-</html>
+</html>

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.github/pages/make_switcher.py

@@ -1,12 +1,14 @@
+"""Make switcher.json to allow docs to switch between different versions."""
+
 import json
 import logging
 from argparse import ArgumentParser
 from pathlib import Path
 from subprocess import CalledProcessError, check_output
-from typing import Optional
 
 
 def report_output(stdout: bytes, label: str) -> list[str]:
+    """Print and return something received frm stdout."""
     ret = stdout.decode().strip().split("\n")
     print(f"{label}: {ret}")
     return ret
@@ -24,7 +26,7 @@ def get_sorted_tags_list() -> list[str]:
     return report_output(stdout, "Tags list")
 
 
-def get_versions(ref: str, add: Optional[str]) -> list[str]:
+def get_versions(ref: str, add: str | None) -> list[str]:
     """Generate the file containing the list of all GitHub Pages builds."""
     # Get the directories (i.e. builds) from the GitHub Pages branch
     try:
@@ -53,7 +55,8 @@ def get_versions(ref: str, add: Optional[str]) -> list[str]:
     return versions
 
 
-def write_json(path: Path, repository: str, versions: str):
+def write_json(path: Path, repository: str, versions: list[str]):
+    """Write the JSON switcher to path."""
     org, repo_name = repository.split("/")
     struct = [
         {"version": version, "url": f"https://{org}.github.io/{repo_name}/{version}/"}
@@ -65,6 +68,7 @@ def write_json(path: Path, repository: str, versions: str):
 
 
 def main(args=None):
+    """Parse args and write switcher."""
     parser = ArgumentParser(
         description="Make a versions.json file from gh-pages directories"
     )

edge_containers_cli-4.1.1/.github/workflows/_container.yml

@@ -0,0 +1,60 @@
+on:
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Docker Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and export to Docker local cache
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        with:
+          context: .
+          # Need load and tags so we can test it below
+          load: true
+          tags: tag_for_testing
+
+      - name: Test cli works in cached runtime image
+        run: docker run --rm tag_for_testing --help
+
+      - name: Create tags for publishing image
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=tag
+            type=raw,value=latest
+
+      - name: Push cached image to container registry
+        if: github.ref_type == 'tag'
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        # This does not build the image again, it will find the image in the
+        # Docker cache and publish it
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.github/workflows/_pypi.yml

@@ -1,8 +1,5 @@
 on:
   workflow_call:
-    secrets:
-        PYPI_TOKEN:
-          required: true
 
 jobs:
   upload:
@@ -18,5 +15,3 @@ jobs:
 
       - name: Publish to PyPI using trusted publishing
         uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          password: ${{ secrets.PYPI_TOKEN }}

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.github/workflows/_release.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Create GitHub Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # v0.1.15
+        uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # v2.0.8
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.github/workflows/ci.yml

@@ -34,6 +34,14 @@ jobs:
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+  container:
+    needs: check
+    if: needs.check.outputs.branch-pr == ''
+    uses: ./.github/workflows/_container.yml
+    permissions:
+      contents: read
+      packages: write
+
   dist:
     needs: check
     if: needs.check.outputs.branch-pr == ''
@@ -45,8 +53,6 @@ jobs:
     uses: ./.github/workflows/_pypi.yml
     permissions:
       id-token: write
-    secrets:
-      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 
   release:
     if: github.ref_type == 'tag'

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.gitignore

@@ -55,6 +55,7 @@ cov.xml
 
 # Sphinx documentation
 docs/_build/
+docs/_api
 
 # PyBuilder
 target/

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.pre-commit-config.yaml

@@ -5,6 +5,7 @@ repos:
       - id: check-added-large-files
       - id: check-yaml
       - id: check-merge-conflict
+      - id: end-of-file-fixer
 
   - repo: local
     hooks:

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.vscode/extensions.json

@@ -2,4 +2,4 @@
     "recommendations": [
         "ms-vscode-remote.remote-containers",
     ]
-}
+}

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.vscode/launch.json

@@ -6,7 +6,7 @@
     "configurations": [
         {
             "name": "Debug Unit Test",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "justMyCode": false,
             "program": "${file}",
@@ -14,6 +14,10 @@
                 "debug-test"
             ],
             "console": "integratedTerminal",
+            "env": {
+                // Enable break on exception when debugging tests (see: tests/conftest.py)
+                "PYTEST_RAISE": "1",
+            },
         }
     ]
-}
+}

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.vscode/settings.json

@@ -5,7 +5,8 @@
     "editor.codeActionsOnSave": {
         "source.organizeImports": "explicit"
     },
+    "files.insertFinalNewline": true,
     "[python]": {
         "editor.defaultFormatter": "charliermarsh.ruff",
     },
-}
+}

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/.vscode/tasks.json

@@ -13,4 +13,4 @@
             "problemMatcher": [],
         }
     ]
-}
+}

edge_containers_cli-4.1.1/Dockerfile

@@ -0,0 +1,31 @@
+# The devcontainer should use the developer target and run as root with podman
+# or docker with user namespaces.
+ARG PYTHON_VERSION=3.11
+FROM python:${PYTHON_VERSION} as developer
+
+# Add any system dependencies for the developer/build environment here
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    graphviz \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set up a virtual environment and put it in PATH
+RUN python -m venv /venv
+ENV PATH=/venv/bin:$PATH
+
+# The build stage installs the context into the venv
+FROM developer as build
+COPY . /context
+WORKDIR /context
+RUN touch dev-requirements.txt && pip install -c dev-requirements.txt .
+
+# The runtime stage copies the built venv into a slim runtime container
+FROM python:${PYTHON_VERSION}-slim as runtime
+# Add apt-get system dependecies for runtime here if needed
+COPY --from=build /venv/ /venv/
+ENV PATH=/venv/bin:$PATH
+RUN pip install textual-dev
+
+# change this entrypoint if it is not the same as the repo
+# Usage: serve "ec -b DEMO monitor" -p 8081
+ENTRYPOINT ["textual", "serve"]
+CMD ["--version"]

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edge-containers-cli
-Version: 4.0.0
+Version: 4.1.1
 Summary: CLI for deploying and managing epics containers IOCs and services
 Author-email: Giles Knap <giles.knap@gmail.com>
 License:                                  Apache License
@@ -250,6 +250,7 @@ https://epics-containers.github.io/
 Source          | <https://github.com/epics-containers/edge-containers-cli>
 :---:           | :---:
 PyPI            | `pip install edge-containers-cli`
+Docker          | `docker run ghcr.io/epics-containers/edge-containers-cli:latest`
 Releases        | <https://github.com/epics-containers/edge-containers-cli/releases>
 
 
@@ -258,4 +259,3 @@ and perform the following::
 
     pip install edge-containers-cli
     ec --version
-

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/README.md

@@ -15,6 +15,7 @@ https://epics-containers.github.io/
 Source          | <https://github.com/epics-containers/edge-containers-cli>
 :---:           | :---:
 PyPI            | `pip install edge-containers-cli`
+Docker          | `docker run ghcr.io/epics-containers/edge-containers-cli:latest`
 Releases        | <https://github.com/epics-containers/edge-containers-cli/releases>
 
 
@@ -23,4 +24,3 @@ and perform the following::
 
     pip install edge-containers-cli
     ec --version
-

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/docs/developer/explanations/decisions.rst

@@ -14,4 +14,4 @@ Below is the list of our current ADRs.
     :maxdepth: 1
     :glob:
 
-    decisions/*
+    decisions/*

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/docs/developer/how-to/make-release.rst

@@ -13,4 +13,4 @@ To make a new release, please follow this checklist:
 Note that tagging and pushing to the main branch has the same effect except that
 you will not get the option to edit the release notes.
 
-.. _release: https://github.com/epics-containers/edge-containers-cli/releases
+.. _release: https://github.com/epics-containers/edge-containers-cli/releases

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/docs/images/dls-logo.svg

@@ -8,4 +8,4 @@
         <path id="path2859" d="m156.09 651.68-0.30524-2.1354c1.4474 0.12317 2.8387 0.4409 4.1468 0.93101l-2.4011 1.8011c-0.67345 0.5049-1.3214 0.23639-1.4405-0.5967" fill="#fddd04" />
         <path id="path2861" d="m148.46 656.04-7.3723 0.918c1.3908-2.2598 3.3397-4.1371 5.6539-5.4455l2.3151 3.0873c0.5049 0.67295 0.23639 1.3212-0.5967 1.4402" fill="#fddd04" />
     </g>
-</svg>
+</svg>

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=64", "setuptools_scm[toml]>=6.2"]
+requires = ["setuptools>=64", "setuptools_scm[toml]>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -54,9 +54,10 @@ name = "Giles Knap"
 
 
 [tool.setuptools_scm]
-write_to = "src/edge_containers_cli/_version.py"
+version_file = "src/edge_containers_cli/_version.py"
 
 [tool.pyright]
+typeCheckingMode = "standard"
 reportMissingImports = false # Ignore missing stubs in imported modules
 
 [tool.pytest.ini_options]
@@ -100,7 +101,7 @@ allowlist_externals =
     pre-commit
     pyright
 commands =
-    pre-commit: pre-commit run --all-files {posargs}
+    pre-commit: pre-commit run --all-files --show-diff-on-failure {posargs}
     type-checking: pyright src tests {posargs}
     tests: pytest --cov=edge_containers_cli --cov-report term --cov-report xml:cov.xml {posargs}
 """
@@ -115,11 +116,18 @@ lint.ignore = [
     "UP007", # Do not complain about Optional[] (TODO: remove once typer is patched)
 ]
 lint.select = [
-    "B",  # flake8-bugbear - https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
-    "C4", # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
-    "E",  # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
-    "F",  # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
-    "W",  # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
-    "I",  # isort - https://docs.astral.sh/ruff/rules/#isort-i
-    "UP", # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    "B",   # flake8-bugbear - https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+    "C4",  # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
+    "E",   # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
+    "F",   # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "W",   # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
+    "I",   # isort - https://docs.astral.sh/ruff/rules/#isort-i
+    "UP",  # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    "SLF", # self - https://docs.astral.sh/ruff/settings/#lintflake8-self
 ]
+
+[tool.ruff.lint.per-file-ignores]
+# By default, private member access is allowed in tests
+# See https://github.com/DiamondLightSource/python-copier-template/issues/154
+# Remove this line to forbid private member access in tests
+"tests/**/*" = ["SLF001"]

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/src/edge_containers_cli/__main__.py

@@ -23,15 +23,22 @@ def version_callback(value: bool):
 
 def backend_callback(ctx: typer.Context, backend: ECBackends):
     init_backend(backend)
+
     # Dynamically drop any method not implemented
     not_implemented = [
-        mthd.replace("_", "-") for mthd in ec_backend.get_notimplemented()
+        mthd.replace("_", "-") for mthd in ec_backend.get_notimplemented_cmds()
     ]
+    typer_commands = ctx.command.commands  # type: ignore
     for command in not_implemented:
-        typer_commands = ctx.command.commands  # type: ignore
         if command in typer_commands:
             typer_commands.pop(command)
 
+    # Dynamically drop any cli options as specified
+    for cmd_name, drop_params in ec_backend.get_notimplemented_params().items():
+        for index, param in enumerate(typer_commands[cmd_name].params):
+            if param.name in drop_params:
+                typer_commands[cmd_name].params.pop(index)
+
     return backend.value
 
 

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/src/edge_containers_cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '4.0.0'
-__version_tuple__ = version_tuple = (4, 0, 0)
+__version__ = version = '4.1.1'
+__version_tuple__ = version_tuple = (4, 1, 1)

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/src/edge_containers_cli/autocomplete.py

@@ -81,7 +81,7 @@ def force_plain_completion() -> list[str]:
 def running_svc(ctx: typer.Context) -> list[str]:
     autocomplete_backend_init(ctx)
     try:
-        return ec_backend.commands._running_services()
+        return ec_backend.commands._running_services()  # noqa: SLF001
     except (CommandError, ShellError) as e:
         typer.echo(f"\n{e}", nl=False, err=True)
         return []
@@ -90,7 +90,7 @@ def running_svc(ctx: typer.Context) -> list[str]:
 def all_svc(ctx: typer.Context) -> list[str]:
     autocomplete_backend_init(ctx)
     try:
-        return ec_backend.commands._all_services()
+        return ec_backend.commands._all_services()  # noqa: SLF001
     except (CommandError, ShellError) as e:
         typer.echo(f"\n{e}", nl=False, err=True)
         return []

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/src/edge_containers_cli/backend.py

@@ -4,6 +4,7 @@ Manage a backend for the project
 
 from edge_containers_cli.cmds.argo_commands import ArgoCommands
 from edge_containers_cli.cmds.commands import Commands
+from edge_containers_cli.cmds.demo_commands import DemoCommands
 from edge_containers_cli.cmds.k8s_commands import K8sCommands
 from edge_containers_cli.definitions import ECBackends, ECContext
 from edge_containers_cli.utils import public_methods
@@ -20,6 +21,13 @@ class Backend:
         self._Commands: type | None = None
         self._commands: Commands | None = None
 
+    @property
+    def Commands(self):
+        if self._Commands is None:
+            raise BackendError("Backend commands not set")
+        else:
+            return self._Commands
+
     @property
     def commands(self):
         if self._commands is None:
@@ -29,10 +37,13 @@ class Backend:
 
     def set_backend(self, backend: ECBackends):
         self._value = backend
-        if backend == ECBackends.K8S:
-            self._Commands = K8sCommands
-        elif backend == ECBackends.ARGOCD:
-            self._Commands = ArgoCommands
+        match backend:
+            case ECBackends.DEMO:
+                self._Commands = DemoCommands
+            case ECBackends.K8S:
+                self._Commands = K8sCommands
+            case ECBackends.ARGOCD:
+                self._Commands = ArgoCommands
 
     def set_context(self, context: ECContext):
         """
@@ -44,7 +55,7 @@ class Backend:
             self._cxt = context
             self._commands = self._Commands(context)
 
-    def get_notimplemented(self) -> list[str]:
+    def get_notimplemented_cmds(self) -> list[str]:
         notimplemented = []
         if self._Commands is None:
             return []
@@ -54,6 +65,9 @@ class Backend:
                     notimplemented.append(command)
         return notimplemented
 
+    def get_notimplemented_params(self) -> dict[str, list[str]]:
+        return self.Commands.params_opt_out
+
 
 backend = Backend()
 

{edge_containers_cli-4.0.0 → edge_containers_cli-4.1.1}/src/edge_containers_cli/cli.py

@@ -234,9 +234,14 @@ def start(
     service_name: str = typer.Argument(
         ..., help="Name of the service container to start", autocompletion=all_svc
     ),
+    temp: bool = typer.Option(False, help="Directly overrides the controller values"),
 ):
     """Start a service"""
-    backend.commands.start(service_name)
+    try:
+        backend.commands.start(service_name, temp)
+    except GitError as e:
+        msg = f"{str(e)} - Try 'ec start <service> --temp' to bypass the git server"
+        raise GitError(msg) from e
 
 
 @cli.command()
@@ -246,9 +251,14 @@ def stop(
         help="Name of the service container to stop",
         autocompletion=running_svc,
     ),
+    temp: bool = typer.Option(False, help="Directly overrides the controller values"),
 ):
     """Stop a service"""
-    backend.commands.stop(service_name)
+    try:
+        backend.commands.stop(service_name, temp)
+    except GitError as e:
+        msg = f"{str(e)} - Try ec stop <service> --temp to bypass the git server"
+        raise GitError(msg) from e
 
 
 @cli.command()