poetry-plugin-ivcap 0.5.2__py3-none-any.whl → 0.6.1__py3-none-any.whl

poetry_plugin_ivcap/constants.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2025 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
+# Copyright (c) 2025-2026 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file. See the AUTHORS file for names of contributors.
 #

poetry_plugin_ivcap/docker.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2025 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
+# Copyright (c) 2025-2026 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file. See the AUTHORS file for names of contributors.
 #
@@ -145,7 +145,7 @@ def docker_cfg(data: dict, line, arch = None) -> DockerConfig:
             config.arch = subprocess.check_output(['uname', '-m']).decode().strip()
         except Exception as e:
             line(f"<error>ERROR: cannot obtain build architecture: {e}</error>")
-            os.exit(1)
+            sys.exit(1)
 
     return config
 
@@ -173,9 +173,9 @@ def docker_push(docker_img, line):
             line(f"<error>ERROR: package push failed with exit code {exit_code}</error>")
             sys.exit(1)
 
-        # Lookginf for "45a06508-5c3a-4678-8e6d-e6399bf27538/gene_onology_term_mapper_amd64:9a9a7cc pushed\n"
+        # Looking for "45a06508-5c3a-4678-8e6d-e6399bf27538/gene_onology_term_mapper_amd64:9a9a7cc pushed\n"
         pattern = re.compile(
-            r'([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[^\s]+) pushed'
+            r'(?:(?:[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12})/)?([^\s]+) pushed'
         )
         package_name = None
         with open(tmp_path, 'r') as f:

poetry_plugin_ivcap/ivcap.py

@@ -1,8 +1,9 @@
 #
-# Copyright (c) 2025 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
+# Copyright (c) 2025-2026 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file. See the AUTHORS file for names of contributors.
 #
+from typing import Optional
 import argparse
 import os
 import re
@@ -35,6 +36,30 @@ def docker_publish(data, line):
     pkg_name = docker_push(dname, line)
 
 def service_register(data, line):
+    svc = service_description(data, line)
+
+    with tempfile.NamedTemporaryFile(mode='w+', delete=False) as tmp:
+        tmp.write(svc)
+        tmp_path = tmp.name  # Save the file name for subprocess
+
+    try:
+        policy = get_policy(data, line)
+        service_id = get_service_id(data, False, line)
+        up_cmd = ["ivcap", "aspect", "update", "--policy", policy, service_id, "-f", tmp_path]
+        try:
+            line(f"<debug>Running: {' '.join(up_cmd)} </debug>")
+            jaid = subprocess.check_output(up_cmd).decode().strip()
+            p = re.compile(r'.*(urn:[^"]*)')
+            aid = p.search(jaid).group(1)
+            line(f"<info>INFO: service definition successfully uploaded - {aid}</info>")
+        except Exception as e:
+            line(f"<error>ERROR: cannot upload service definitiion: {e}</error>")
+            sys.exit(1)
+    finally:
+        if os.path.exists(tmp_path):
+            os.remove(tmp_path)
+
+def service_description(data, line):
     check_ivcap_cmd(line)
     config = data.get("tool", {}).get(PLUGIN_NAME, {})
 
@@ -60,6 +85,10 @@ def service_register(data, line):
 
     svc = svc.replace("#DOCKER_IMG#", pkg.strip())\
             .replace("#SERVICE_ID#", service_id)
+    return svc
+
+def tool_register(data, line):
+    svc = tool_description(data, line)
 
     with tempfile.NamedTemporaryFile(mode='w+', delete=False) as tmp:
         tmp.write(svc)
@@ -67,21 +96,22 @@ def service_register(data, line):
 
     try:
         policy = get_policy(data, line)
+        service_id = get_service_id(data, False, line)
         up_cmd = ["ivcap", "aspect", "update", "--policy", policy, service_id, "-f", tmp_path]
         try:
             line(f"<debug>Running: {' '.join(up_cmd)} </debug>")
             jaid = subprocess.check_output(up_cmd).decode().strip()
             p = re.compile(r'.*(urn:[^"]*)')
             aid = p.search(jaid).group(1)
-            line(f"<info>INFO: service definition successfully uploaded - {aid}</info>")
+            line(f"<info>INFO: tool description successfully uploaded - {aid}</info>")
         except Exception as e:
-            line(f"<error>ERROR: cannot upload service definitiion: {e}</error>")
+            line(f"<error>ERROR: cannot upload tool description: {e}</error>")
             sys.exit(1)
     finally:
         if os.path.exists(tmp_path):
             os.remove(tmp_path)
 
-def tool_register(data, line):
+def tool_description(data, line) -> str:
     check_ivcap_cmd(line)
     config = data.get("tool", {}).get(PLUGIN_NAME, {})
 
@@ -98,26 +128,7 @@ def tool_register(data, line):
 
     service_id = get_service_id(data, False, line)
     svc = svc.replace("#SERVICE_ID#", service_id)
-
-    with tempfile.NamedTemporaryFile(mode='w+', delete=False) as tmp:
-        tmp.write(svc)
-        tmp_path = tmp.name  # Save the file name for subprocess
-
-    try:
-        policy = get_policy(data, line)
-        up_cmd = ["ivcap", "aspect", "update", "--policy", policy, service_id, "-f", tmp_path]
-        try:
-            line(f"<debug>Running: {' '.join(up_cmd)} </debug>")
-            jaid = subprocess.check_output(up_cmd).decode().strip()
-            p = re.compile(r'.*(urn:[^"]*)')
-            aid = p.search(jaid).group(1)
-            line(f"<info>INFO: tool description successfully uploaded - {aid}</info>")
-        except Exception as e:
-            line(f"<error>ERROR: cannot upload tool description: {e}</error>")
-            sys.exit(1)
-    finally:
-        if os.path.exists(tmp_path):
-            os.remove(tmp_path)
+    return svc
 
 def get_service_id(data, is_silent, line):
     service_id = data.get("tool", {}).get(PLUGIN_NAME, {}).get(SERVICE_ID_OPT)
@@ -399,4 +410,24 @@ def check_ivcap_cmd(line, is_silent=False):
     if not command_exists("ivcap"):
         line("<error>'ivcap' command not found. Please install the IVCAP CLI tool.</error>")
         line("<error>... see https://github.com/ivcap-works/ivcap-cli?tab=readme-ov-file#install-released-binaries for instructions</error>")
-        os.exit(1)
+        sys.exit(1)
+
+def ivcap_cli_version() -> Optional[str]:
+    # Best-effort: also report the installed external `ivcap` CLI version.
+    # Expected output:
+    #   ivcap version 0.47.0|a4f9b30|2026-01-30T04:45:00Z
+    ivcap_version = None
+    try:
+        res = subprocess.run(
+            ["ivcap", "--version"],
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+        raw = (res.stdout or res.stderr or "").strip()
+        m = re.search(r"\bivcap\s+version\s+([0-9]+(?:\.[0-9]+)+)", raw)
+        if m:
+            return m.group(1)
+    except FileNotFoundError:
+        # `ivcap` is not installed / not on PATH
+        return

poetry_plugin_ivcap/plugin.py

@@ -1,9 +1,10 @@
 #
-# Copyright (c) 2025 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
+# Copyright (c) 2025-2026 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file. See the AUTHORS file for names of contributors.
 #
 import os
+import re
 from poetry.plugins.application_plugin import ApplicationPlugin
 from cleo.commands.command import Command
 from cleo.helpers import argument, option
@@ -17,7 +18,32 @@ from poetry_plugin_ivcap.util import get_version
 
 from .ivcap import create_service_id, exec_job, get_service_id, service_register, tool_register
 from .docker import docker_build, docker_run
-from .ivcap import docker_publish
+from .ivcap import docker_publish, ivcap_cli_version, service_description, tool_description
+
+
+_SUBCOMMANDS = [
+    ("run", "Run the service locally"),
+    ("docker-build", "Build the docker image for this service"),
+    ("docker-run", "Run the service's docker image locally for testing"),
+    (
+        "deploy",
+        "Deploy the service to IVCAP (calls docker-publish, service-register and tool-register)",
+    ),
+    ("job-exec file_name", "Execute a job defined in 'file_name'"),
+    ("docker-publish", "Publish the service's docker image to IVCAP"),
+    ("service-register", "Register the service with IVCAP"),
+    ("tool-register", "Register the service as an AI Tool with IVCAP"),
+    ("create-service-id", "Create a unique service ID for the service"),
+    ("get-service-id", "Return the service ID for the service"),
+    ("get-service-description", "Return the service description as json"),
+    ("get-tool-description", "Return the tool description as json"),
+    ("version", "Print the version of this plugin"),
+]
+
+_SUBCOMMANDS_COL_WIDTH = max(len(cmd) for cmd, _ in _SUBCOMMANDS)
+_SUBCOMMANDS_HELP = "\n".join(
+    f"    {cmd.ljust(_SUBCOMMANDS_COL_WIDTH)}  {desc}" for cmd, desc in _SUBCOMMANDS
+)
 
 class IvcapCommand(Command):
     name = "ivcap"
@@ -29,21 +55,12 @@ IVCAP plugin
 Supporting the development of services and tools for the IVCAP platform
 
 Available subcommands:
-    run                 Run the service locally
-    docker-build        Build the docker image for this service
-    docker-run          Run the service's docker image locally for testing
-    deploy              Deploy the service to IVCAP (calls docker-publish, service-register and tool-register)
-    job-exec file_name  Execute a job defined in 'file_name'
-    docker-publish      Publish the service's docker image to IVCAP
-    service-register    Register the service with IVCAP
-    create-service-id   Create a unique service ID for the service
-    get-service-id      Return the service ID for the service
-    tool-register       Register the service as an AI Tool with IVCAP
-    version             Print the version of this plugin
+{_SUBCOMMANDS_HELP}
 
 Example:
   poetry {PLUGIN_CMD} run -- --port 8080
   poetry {PLUGIN_CMD} job-exec request.json -- --timeout 0 # don't wait for result
+  poetry {PLUGIN_CMD} job-exec request.json -- --watch # shows all the events produced by the service
 
 Configurable options in pyproject.toml:
 
@@ -71,15 +88,18 @@ Configurable options in pyproject.toml:
     def handle(self):
 
         sub = self.argument("subcommand")
+        poetry = self.application.poetry
+
         if sub == "version":
-            #v = poetry.get_plugin('ivcap').version
             v = version(PLUGIN_NAME)
-            print(f"IVCAP plugin (version {v})")
+            ivcap_version = ivcap_cli_version()
+            if ivcap_version:
+                print(f"IVCAP plugin (version {v} - cli {ivcap_version})")
+            else:
+                print(f"IVCAP plugin (version {v})")
             return
 
-        poetry = self.application.poetry
         data = poetry.pyproject.data
-
         args = self.argument("args")
         is_silent = self.option("silent")
 
@@ -105,6 +125,12 @@ Configurable options in pyproject.toml:
         elif sub == "get-service-id":
             sid = get_service_id(data, is_silent, self.line)
             print(sid)
+        elif sub == "get-service-description":
+            sd = service_description(data, self.line)
+            print(sd)
+        elif sub == "get-tool-description":
+            td = tool_description(data, self.line)
+            print(td)
         elif sub == "tool-register":
             tool_register(data, self.line)
 

poetry_plugin_ivcap/types.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2025 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
+# Copyright (c) 2025-2026 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file. See the AUTHORS file for names of contributors.
 #

poetry_plugin_ivcap/util.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2025 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
+# Copyright (c) 2025-2026 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file. See the AUTHORS file for names of contributors.
 #

{poetry_plugin_ivcap-0.5.2.dist-info → poetry_plugin_ivcap-0.6.1.dist-info}/METADATA

@@ -1,14 +1,13 @@
 Metadata-Version: 2.3
 Name: poetry-plugin-ivcap
-Version: 0.5.2
+Version: 0.6.1
 Summary: A custom Poetry command for IVCAP deployments
 License: MIT
 Author: Max Ott
 Author-email: max.ott@csiro.au
-Requires-Python: >=3.9
+Requires-Python: >=3.10,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -84,6 +83,27 @@ Configurable optiosn in pyproject.toml:
 
 ## Development
 
+### Test the plugin as part of the "global" installed poetry
+
+```shell
+# 1) remove any existing installed copy first
+poetry self remove poetry-plugin-ivcap
+
+# 2) install this checkout as an editable plugin
+poetry self add -e $PWD
+
+# 3) verify Poetry sees the plugin
+poetry self show plugins
+```
+
+
+Switch back:
+
+```
+poetry self remove poetry-plugin-ivcap
+poetry self add poetry-plugin-ivcap@latest
+```
+
 ### Build the Plugin Package
 
 ```bash

poetry_plugin_ivcap-0.6.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+poetry_plugin_ivcap/constants.py,sha256=NllPHV4w3YDQmEPBz_rKveXiwOqGowih17XoEgkKJrM,1331
+poetry_plugin_ivcap/docker.py,sha256=CIPKbHJ9yQDZMYqKPFZRGz3wpmrHvIoIZgPyluiryCU,7711
+poetry_plugin_ivcap/ivcap.py,sha256=zAqrv5987rD2bcNH5R1wm-JWiGsZnT3qh7BlF9o4PSQ,16454
+poetry_plugin_ivcap/plugin.py,sha256=gZ92h3ZRFpj9cM8ZqRxWF4gHmEir4B0nXBprLDMGYdw,6567
+poetry_plugin_ivcap/types.py,sha256=m8UEziKacHBe2LLV-UlkNYwn3vZ4CnEDtxDwPkraR8c,1356
+poetry_plugin_ivcap/util.py,sha256=5mKL5sCmtHe2e0pENda2HZNxpwe6VUMC-cOWEIrL2Bc,3434
+poetry_plugin_ivcap-0.6.1.dist-info/AUTHORS.md,sha256=s9xR4_HAHQgbNlj505LViebt5AtACQmhPf92aJvNYgg,88
+poetry_plugin_ivcap-0.6.1.dist-info/LICENSE,sha256=dsQrDPPwW7iJs9pxahgJKDW8RNPf5FyXG70MFUlxcuk,1587
+poetry_plugin_ivcap-0.6.1.dist-info/METADATA,sha256=l53tGbI8BiLLXfdqiYkWwoQOhU60-3gEhkovx8dFhOE,3390
+poetry_plugin_ivcap-0.6.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+poetry_plugin_ivcap-0.6.1.dist-info/entry_points.txt,sha256=3xagEFBkGgrVe8WyjmhlHLr4JDEWPN_W4DwxnIBWbNY,74
+poetry_plugin_ivcap-0.6.1.dist-info/RECORD,,

poetry_plugin_ivcap-0.5.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-poetry_plugin_ivcap/constants.py,sha256=jD8j_kBwo0i-IupEGBJRvI_Uwyfde_IaRghYASxf4tA,1326
-poetry_plugin_ivcap/docker.py,sha256=QR3DJRn6l3RFxCiAvn8Kai_6e_mJ3YVuR_Pmnd1szqY,7714
-poetry_plugin_ivcap/ivcap.py,sha256=yRS_mhS5P8sbIEofE9f7PRfsuZNGeyRrfjSNRg8shFY,15464
-poetry_plugin_ivcap/plugin.py,sha256=hBsJaQzOlYnTjoBcS7AVSpsD2v0MtzcAabP70-cG2cs,5627
-poetry_plugin_ivcap/types.py,sha256=gpoMnKZgO8JV-RFJs67cymuSj3d1RrLDJ8160_7NsKY,1351
-poetry_plugin_ivcap/util.py,sha256=bcjjbKoV_pAgeuC7Ws9XbJa3phFpNVyrRAlFJ1VubRg,3429
-poetry_plugin_ivcap-0.5.2.dist-info/AUTHORS.md,sha256=s9xR4_HAHQgbNlj505LViebt5AtACQmhPf92aJvNYgg,88
-poetry_plugin_ivcap-0.5.2.dist-info/LICENSE,sha256=dsQrDPPwW7iJs9pxahgJKDW8RNPf5FyXG70MFUlxcuk,1587
-poetry_plugin_ivcap-0.5.2.dist-info/METADATA,sha256=wUm9lrn8ZZokYRXBXp603XVEGHvG-B0AXcIsudrhSrY,3032
-poetry_plugin_ivcap-0.5.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-poetry_plugin_ivcap-0.5.2.dist-info/entry_points.txt,sha256=3xagEFBkGgrVe8WyjmhlHLr4JDEWPN_W4DwxnIBWbNY,74
-poetry_plugin_ivcap-0.5.2.dist-info/RECORD,,