poetry-plugin-ivcap 0.1.0__tar.gz → 0.2.0__tar.gz

{poetry_plugin_ivcap-0.1.0 → poetry_plugin_ivcap-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: poetry-plugin-ivcap
-Version: 0.1.0
+Version: 0.2.0
 Summary: A custom Poetry command for IVCAP deployments
 License: MIT
 Author: Max Ott
@@ -40,8 +40,44 @@ poetry self add poetry-plugin-ivcap
 ## Usage
 
 ```bash
-poetry ivcap
-poetry ivcap docker
+poetry ivcap run
+poetry ivcap docker-build
+poetry ivcap docker-run
+poetry ivcap docker-publish
+poetry ivcap service-register
+poetry ivcap create-service-id
+poetry ivcap tool-register
+```
+
+To get help on the currently installed version
+```
+% poetry ivcap
+
+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
+    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
+    tool-register       Register the service as an AI Tool with IVCAP
+
+Example:
+  poetry ivcap run
+
+Configurable optiosn 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
+
+  docker-build-template = "docker buildx build -t #DOCKER_NAME#  ."
+  docker-run-template = "docker run -rm -p #PORT#:#PORT#"
 ```
 
 ## Development

poetry_plugin_ivcap-0.2.0/README.md

@@ -0,0 +1,101 @@
+# poetry-plugin-ivcap
+
+A custom Poetry plugin that adds a `poetry ivcap` command for local and Docker-based deployments.
+
+## Example Configuration
+
+Add to your `pyproject.toml`:
+
+```toml
+[tool.poetry-plugin-ivcap]
+default_target = "docker"
+docker_tag = "myapp:dev"
+```
+
+## Installation
+
+```bash
+poetry self add poetry-plugin-ivcap
+```
+
+## Usage
+
+```bash
+poetry ivcap run
+poetry ivcap docker-build
+poetry ivcap docker-run
+poetry ivcap docker-publish
+poetry ivcap service-register
+poetry ivcap create-service-id
+poetry ivcap tool-register
+```
+
+To get help on the currently installed version
+```
+% poetry ivcap
+
+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
+    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
+    tool-register       Register the service as an AI Tool with IVCAP
+
+Example:
+  poetry ivcap run
+
+Configurable optiosn 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
+
+  docker-build-template = "docker buildx build -t #DOCKER_NAME#  ."
+  docker-run-template = "docker run -rm -p #PORT#:#PORT#"
+```
+
+## Development
+
+### Build the Plugin Package
+
+```bash
+poetry build
+```
+
+This creates .whl and .tar.gz files in the dist/ directory.
+
+### Publish to PyPI
+
+Create an account at https://pypi.org/account/register/
+
+Add your credentials:
+```bash
+poetry config pypi-token.pypi <your-token>
+```
+
+Publish:
+```bash
+poetry publish --build
+```
+
+### Optional: Test on TestPyPI First
+
+To verify your setup without publishing to the real PyPI:
+
+```bash
+poetry config repositories.test-pypi https://test.pypi.org/legacy/
+poetry publish -r test-pypi --build
+```
+
+Then test installing via:
+
+```bash
+poetry self add --source test-pypi poetry-plugin-deploy
+```

{poetry_plugin_ivcap-0.1.0 → poetry_plugin_ivcap-0.2.0}/poetry_plugin_ivcap/plugin.py

@@ -16,14 +16,32 @@ class IvcapCommand(Command):
     name = "ivcap"
     description = "IVCAP plugin `poetry ivcap <subcommand>`"
     help = """\
+
 IVCAP plugin
 
+Supporting the development of services and tools for the IVCAP platform
+
 Available subcommands:
-  run       Run the configured service
-  deploy    Deploy using configured settings
+    run                 Run the service locally
+    docker-build        Build the docker image for this service
+    docker-run          Run the service's docker image locally
+    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
+    tool-register       Register the service as an AI Tool with IVCAP
 
 Example:
   poetry ivcap run
+
+Configurable optiosn 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
+
+  docker-build-template = "docker buildx build -t #DOCKER_NAME#  ."
+  docker-run-template = "docker run -rm -p #PORT#:#PORT#"
 """
     arguments = [
         argument("subcommand", optional=True, description="Subcommand: run, deploy, etc.")
@@ -50,7 +68,9 @@ Example:
         elif sub == "tool-register":
             tool_register(data, self.line)
         else:
-            self.line(f"<error>Unknown subcommand: {sub}</error>")
+            if not (sub == None or sub == "help"):
+                self.line(f"<error>Unknown subcommand: {sub}</error>")
+            print(self.help)
 
     def run_service(self, data):
         config = data.get("tool", {}).get("poetry-plugin-ivcap", {})

{poetry_plugin_ivcap-0.1.0 → poetry_plugin_ivcap-0.2.0}/pyproject.toml

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

poetry_plugin_ivcap-0.1.0/README.md

@@ -1,65 +0,0 @@
-# poetry-plugin-ivcap
-
-A custom Poetry plugin that adds a `poetry ivcap` command for local and Docker-based deployments.
-
-## Example Configuration
-
-Add to your `pyproject.toml`:
-
-```toml
-[tool.poetry-plugin-ivcap]
-default_target = "docker"
-docker_tag = "myapp:dev"
-```
-
-## Installation
-
-```bash
-poetry self add poetry-plugin-ivcap
-```
-
-## Usage
-
-```bash
-poetry ivcap
-poetry ivcap docker
-```
-
-## Development
-
-### Build the Plugin Package
-
-```bash
-poetry build
-```
-
-This creates .whl and .tar.gz files in the dist/ directory.
-
-### Publish to PyPI
-
-Create an account at https://pypi.org/account/register/
-
-Add your credentials:
-```bash
-poetry config pypi-token.pypi <your-token>
-```
-
-Publish:
-```bash
-poetry publish --build
-```
-
-### Optional: Test on TestPyPI First
-
-To verify your setup without publishing to the real PyPI:
-
-```bash
-poetry config repositories.test-pypi https://test.pypi.org/legacy/
-poetry publish -r test-pypi --build
-```
-
-Then test installing via:
-
-```bash
-poetry self add --source test-pypi poetry-plugin-deploy
-```