poetry-plugin-ivcap 0.2.6__tar.gz → 0.2.8__tar.gz

{poetry_plugin_ivcap-0.2.6 → poetry_plugin_ivcap-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: poetry-plugin-ivcap
-Version: 0.2.6
+Version: 0.2.8
 Summary: A custom Poetry command for IVCAP deployments
 License: MIT
 Author: Max Ott

poetry_plugin_ivcap-0.2.8/poetry_plugin_ivcap/constants.py

@@ -0,0 +1,47 @@
+#
+# Copyright (c) 2025 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.
+#
+
+PLUGIN_NAME = "poetry-plugin-ivcap"
+PLUGIN_CMD = "ivcap"
+
+SERVICE_ID_OPT = "service-id"
+SERVICE_FILE_OPT = "service-file"
+SERVICE_TYPE_OPT = "service-type"
+PORT_OPT = "port"
+POLICY_OPT = "policy"
+
+DOCKER_RUN_TEMPLATE_OPT = "docker-run-template"
+DOCKER_RUN_OPT = "docker-run-opts"
+DOCKER_BUILD_TEMPLATE_OPT = "docker-build-template"
+
+DEF_POLICY = "urn:ivcap:policy:ivcap.base.metadata"
+DEF_PORT = 8000
+
+DOCKER_BUILD_TEMPLATE = """
+docker buildx build
+    -t #DOCKER_NAME#
+    --platform linux/#ARCH#
+    --build-arg VERSION=#VERSION#
+    --build-arg BUILD_PLATFORM=linux/#ARCH#
+    -f #PROJECT_DIR#/#DOCKERFILE#
+    --load #PROJECT_DIR#
+"""
+
+DOCKER_LAMBDA_RUN_TEMPLATE = """
+	docker run -it
+        -p #PORT#:#PORT#
+		--platform=linux/#ARCH#
+		--rm \
+		#NAME#_#ARCH#:#TAG#
+"""
+
+DOCKER_BATCH_RUN_TEMPLATE = """
+	docker run -it
+		--platform=linux/#ARCH#
+        -v #PROJECT_DIR#:/data
+		--rm \
+		#NAME#_#ARCH#:#TAG#
+"""

{poetry_plugin_ivcap-0.2.6 → poetry_plugin_ivcap-0.2.8}/poetry_plugin_ivcap/docker.py

@@ -12,34 +12,9 @@ from typing import Dict, List, Optional
 from pydantic import BaseModel, Field
 import subprocess
 
+from .constants import DEF_PORT, DOCKER_BATCH_RUN_TEMPLATE, DOCKER_BUILD_TEMPLATE, DOCKER_BUILD_TEMPLATE_OPT, DOCKER_LAMBDA_RUN_TEMPLATE, DOCKER_RUN_OPT, DOCKER_RUN_TEMPLATE_OPT, PLUGIN_NAME, SERVICE_TYPE_OPT
 from .util import command_exists, get_name, get_version
 
-DOCKER_BUILD_TEMPLATE = """
-docker buildx build
-    -t #DOCKER_NAME#
-    --platform linux/#ARCH#
-    --build-arg VERSION=#VERSION#
-    --build-arg BUILD_PLATFORM=linux/#ARCH#
-    -f #PROJECT_DIR#/#DOCKERFILE#
-    --load #PROJECT_DIR#
-"""
-
-DOCKER_LAMBDA_RUN_TEMPLATE = """
-	docker run -it
-        -p #PORT#:#PORT#
-		--platform=linux/#ARCH#
-		--rm \
-		#NAME#_#ARCH#:#TAG#
-"""
-
-DOCKER_BATCH_RUN_TEMPLATE = """
-	docker run -it
-		--platform=linux/#ARCH#
-        -v #PROJECT_DIR#:/data
-		--rm \
-		#NAME#_#ARCH#:#TAG#
-"""
-
 class DockerConfig(BaseModel):
     name: Optional[str] = Field(None)
     tag: Optional[str] = Field(None)
@@ -53,8 +28,8 @@ class DockerConfig(BaseModel):
         return f"{self.name}_{self.arch}:{self.tag}"
 
     def from_build_template(self, data: dict) -> str:
-        pdata = data.get("tool", {}).get("poetry-plugin-ivcap", {})
-        template = pdata.get("docker-build-template", DOCKER_BUILD_TEMPLATE).strip()
+        pdata = data.get("tool", {}).get(PLUGIN_NAME, {})
+        template = pdata.get(DOCKER_BUILD_TEMPLATE_OPT, DOCKER_BUILD_TEMPLATE).strip()
         t = template.strip()\
             .replace("#DOCKER_NAME#", self.docker_name)\
             .replace("#NAME#", self.name)\
@@ -67,35 +42,29 @@ class DockerConfig(BaseModel):
         return t
 
     def from_run_template(self, data, args, line) -> List[any]:
-        pdata = data.get("tool", {}).get("poetry-plugin-ivcap", {})
-        template = pdata.get("docker-run-template")
+        pdata = data.get("tool", {}).get(PLUGIN_NAME, {})
+        template = pdata.get(DOCKER_RUN_TEMPLATE_OPT)
+        smode = pdata.get(SERVICE_TYPE_OPT)
+        if smode is None:
+            line(f"<error>ERROR: 'service-type' is not defined in [{PLUGIN_NAME}]</error>")
+            sys.exit(1)
         if template is None:
-            smode = pdata.get("service-type")
-            if smode is None:
-                line("<error>ERROR: 'service-type' is not defined in [poetry-plugin-ivcap]</error>")
-                sys.exit(1)
             if smode == "lambda":
                 template = DOCKER_LAMBDA_RUN_TEMPLATE
             elif smode == "batch":
                 template = DOCKER_BATCH_RUN_TEMPLATE
             else:
-                line(f"<error>ERROR: Unknown service type '{smode}' in [poetry-plugin-ivcap]</error>")
+                line(f"<error>ERROR: Unknown service type '{smode}' in [{PLUGIN_NAME}]</error>")
                 sys.exit(1)
 
-        opts = pdata.get("docker-run-opts", [])
+        opts = pdata.get(DOCKER_RUN_OPT, [])
         port = get_port_value(args)
         port_in_args = True
         if not port:
             port = get_port_value(opts)
         if not port:
             port_in_args = False
-            port = str(pdata.get("port", 8000))
-
-        # elif opts.get('port') is not None:
-        #     opts['port'] = opts.get('port')
-        # elif '--port' in template:
-        #     # If the template has a port but no port is provided, use a default
-        #     opts['port'] = '8000'
+            port = str(pdata.get("port", DEF_PORT))
 
         t = template.strip()\
             .replace("#NAME#", self.name)\
@@ -105,11 +74,6 @@ class DockerConfig(BaseModel):
             .replace("#VERSION#", self.version)\
             .replace("#PROJECT_DIR#", self.project_dir)
 
-        # for key, value in opts.items():
-        #     if key != "port":
-        #         t = t.replace(f"#{key.upper()}#", str(value))
-
-
         cmd = t.split()
         cmd.extend(opts)
         cmd.extend(args)
@@ -146,7 +110,7 @@ def docker_run(data: dict, args, line) -> None:
 def docker_cfg(data: dict, line, arch = None) -> DockerConfig:
     name = get_name(data)
 
-    pdata = data.get("tool", {}).get("poetry-plugin-ivcap", {})
+    pdata = data.get("tool", {}).get(PLUGIN_NAME, {})
     config = DockerConfig(name=name, **pdata.get("docker", {}))
     if arch:
         # override architecture if provided

{poetry_plugin_ivcap-0.2.6 → poetry_plugin_ivcap-0.2.8}/poetry_plugin_ivcap/ivcap.py

@@ -11,8 +11,10 @@ import tempfile
 import uuid
 import humanize
 
+from .constants import DEF_POLICY, PLUGIN_NAME, POLICY_OPT, SERVICE_FILE_OPT, SERVICE_ID_OPT
+
 from .docker import docker_cfg, docker_build, docker_push
-from .util import command_exists, execute_subprocess_and_capture_output, get_name, string_to_number
+from .util import command_exists, get_name, string_to_number
 
 def docker_publish(data, line):
     check_ivcap_cmd(line)
@@ -29,11 +31,11 @@ def docker_publish(data, line):
 
 def service_register(data, line):
     check_ivcap_cmd(line)
-    config = data.get("tool", {}).get("poetry-plugin-ivcap", {})
+    config = data.get("tool", {}).get(PLUGIN_NAME, {})
 
-    service = config.get("service-file")
+    service = config.get(SERVICE_FILE_OPT)
     if not service:
-        line("<error>Missing 'service-file' in [tool.poetry-plugin-ivcap]</error>")
+        line(f"<error>Missing '{SERVICE_FILE_OPT}' in [tool.{PLUGIN_NAME}]</error>")
         return
 
     dcfg = docker_cfg(data, line, "amd64")
@@ -74,11 +76,11 @@ def service_register(data, line):
 
 def tool_register(data, line):
     check_ivcap_cmd(line)
-    config = data.get("tool", {}).get("poetry-plugin-ivcap", {})
+    config = data.get("tool", {}).get(PLUGIN_NAME, {})
 
     service = config.get("service-file")
     if not service:
-        line("<error>Missing 'service-file' in [tool.poetry-plugin-ivcap]</error>")
+        line(f"<error>Missing 'service-file' in [tool.{PLUGIN_NAME}]</error>")
         return
 
     cmd = ["poetry", "run", "python", service, "--print-tool-description"]
@@ -109,7 +111,7 @@ def tool_register(data, line):
             os.remove(tmp_path)
 
 def get_service_id(data, is_silent, line):
-    service_id = data.get("tool", {}).get("poetry-plugin-ivcap", {}).get("service-id")
+    service_id = data.get("tool", {}).get(PLUGIN_NAME, {}).get(SERVICE_ID_OPT)
     if not service_id:
         service_id = create_service_id(data, is_silent, line)
     return service_id
@@ -122,9 +124,9 @@ def create_service_id(data, is_silent, line):
     return f"urn:ivcap:service:{id}"
 
 def get_policy(data, line):
-    policy = data.get("tool", {}).get("poetry-plugin-ivcap", {}).get("policy")
+    policy = data.get("tool", {}).get(PLUGIN_NAME, {}).get(POLICY_OPT)
     if not policy:
-        policy = "urn:ivcap:policy:ivcap.open.metadata"
+        policy = DEF_POLICY
     return policy
 
 def get_account_id(data, line, is_silent=False):

{poetry_plugin_ivcap-0.2.6 → poetry_plugin_ivcap-0.2.8}/poetry_plugin_ivcap/plugin.py

@@ -10,6 +10,7 @@ from cleo.helpers import argument, option
 import subprocess
 from importlib.metadata import version
 
+from poetry_plugin_ivcap.constants import DOCKER_BUILD_TEMPLATE_OPT, DOCKER_RUN_TEMPLATE_OPT, PLUGIN_CMD, PLUGIN_NAME, PORT_OPT, SERVICE_FILE_OPT, SERVICE_ID_OPT, SERVICE_TYPE_OPT
 from poetry_plugin_ivcap.util import get_version
 
 from .ivcap import create_service_id, get_service_id, service_register, tool_register
@@ -18,8 +19,8 @@ from .ivcap import docker_publish
 
 class IvcapCommand(Command):
     name = "ivcap"
-    description = "IVCAP plugin `poetry ivcap <subcommand>`"
-    help = """\
+    description = f"IVCAP plugin `poetry {PLUGIN_CMD} <subcommand>`"
+    help = f"""\
 
 IVCAP plugin
 
@@ -34,19 +35,21 @@ Available subcommands:
     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
 
 Example:
-  poetry ivcap run -- --port 8080
+  poetry {PLUGIN_CMD} run -- --port 8080
 
 Configurable options in pyproject.toml:
 
-  [tool.poetry-plugin-ivcap]
-  service-file = "service.py"  # The Python file that implements the service
-  service-file = "service.py"
-  service-id = "urn:ivcap:service:ac158a1f-dfb4-5dac-bf2e-9bf15e0f2cc7" # A unique identifier for the service
+  [tool.{PLUGIN_NAME}]
+  {SERVICE_FILE_OPT} = "service.py"  # The Python file that implements the service
+  {SERVICE_ID_OPT} = "urn:ivcap:service:ac158a1f-dfb4-5dac-bf2e-9bf15e0f2cc7" # A unique identifier for the service
+  {SERVICE_TYPE_OPT} = "lambda
 
-  docker-build-template = "docker buildx build -t #DOCKER_NAME#  ."
-  docker-run-template = "docker run -rm -p #PORT#:#PORT#"
+  # Optional
+  {DOCKER_BUILD_TEMPLATE_OPT} = "docker buildx build -t #DOCKER_NAME#  ."
+  {DOCKER_RUN_TEMPLATE_OPT} = "docker run -rm -p #PORT#:#PORT#"
 """
     arguments = [
         argument("subcommand", optional=True, description="Subcommand: run, deploy, etc."),
@@ -64,7 +67,7 @@ Configurable options in pyproject.toml:
         sub = self.argument("subcommand")
         if sub == "version":
             #v = poetry.get_plugin('ivcap').version
-            v = version("poetry-plugin-ivcap")
+            v = version(PLUGIN_NAME)
             print(f"IVCAP plugin (version {v})")
             return
 
@@ -99,15 +102,15 @@ Configurable options in pyproject.toml:
             print(self.help)
 
     def run_service(self, data, args, line):
-        config = data.get("tool", {}).get("poetry-plugin-ivcap", {})
+        config = data.get("tool", {}).get(PLUGIN_NAME, {})
 
-        service = config.get("service-file")
+        service = config.get(SERVICE_FILE_OPT)
         if not service:
-            self.line("<error>Missing 'service-file' in [tool.poetry-plugin-ivcap]</error>")
+            self.line(f"<error>Missing '{SERVICE_FILE_OPT}' in [tool.{PLUGIN_NAME}]</error>")
             return
 
         if not '--port' in args:
-            port = config.get("port")
+            port = config.get(PORT_OPT)
             if port:
                 args.extend(["--port", str(port)])
 
@@ -121,4 +124,4 @@ Configurable options in pyproject.toml:
 
 class IvcapPlugin(ApplicationPlugin):
     def activate(self, application):
-        application.command_loader.register_factory("ivcap", lambda: IvcapCommand())
+        application.command_loader.register_factory(PLUGIN_CMD, lambda: IvcapCommand())

{poetry_plugin_ivcap-0.2.6 → poetry_plugin_ivcap-0.2.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "poetry-plugin-ivcap"
-version = "0.2.6"
+version = "0.2.8"
 description = "A custom Poetry command for IVCAP deployments"
 authors = ["Max Ott <max.ott@csiro.au>"]
 license = "MIT"