Ease of use (#65)

* split schema from main plugin script

* initial rename script

* rename directories first

* correct entrypoint in Dockerfile

* add input check to rename script

* fix for github workflow

* rename configs to inputs

.github/workflows/workflow.yaml

@@ -25,4 +25,4 @@ jobs:
       contents: write
       pull-requests: write
     with:
-      plugin_path: "arcaflow_plugin_template_python/arcaflow_plugin_template_python.py"
+      plugin_path: "arcaflow_plugin_template_python/template_python_plugin.py"

Dockerfile

@@ -40,7 +40,7 @@ RUN python -m pip install -r requirements.txt
 
 WORKDIR /app/${package}
 
-ENTRYPOINT ["python", "arcaflow_plugin_template_python.py"]
+ENTRYPOINT ["python", "template_python_plugin.py"]
 CMD []
 
 LABEL org.opencontainers.image.source="https://github.com/arcalot/arcaflow-plugin-template-python"

README.md

@@ -1,11 +1,6 @@
-# Python Plugin Template Project
+# Python Plugin Template
 
-## Image Building
-
-You can change this plugin's image version tag in
-`.github/workflows/carpenter.yaml` by editing the
-`IMAGE_TAG` variable, and pushing that change to the
-branch designated in that workflow.
+This plugin serves as a template from which new plugins can be built.
 
 # Autogenerated Input/Output Documentation by Arcaflow-Docsgen Below
 

arcaflow_plugin_template_python/arcaflow_plugin_template_python.py → arcaflow_plugin_template_python/template_python_plugin.py

@@ -2,36 +2,12 @@
 
 import sys
 import typing
-from dataclasses import dataclass
-from arcaflow_plugin_sdk import plugin, validation
-
-
-@dataclass
-class InputParams:
-    """
-    This is the data structure for the input parameters of the step defined
-    below.
-    """
-
-    name: typing.Annotated[str, validation.min(1)]
-
-
-@dataclass
-class SuccessOutput:
-    """
-    This is the output data structure for the success case.
-    """
-
-    message: str
-
-
-@dataclass
-class ErrorOutput:
-    """
-    This is the output data structure in the error  case.
-    """
-
-    error: str
+from arcaflow_plugin_sdk import plugin
+from template_python_schema import (
+    InputParams,
+    SuccessOutput,
+    ErrorOutput,
+)
 
 
 @plugin.step(

arcaflow_plugin_template_python/template_python_schema.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+
+import typing
+from dataclasses import dataclass
+from arcaflow_plugin_sdk import validation
+
+
+@dataclass
+class InputParams:
+    """
+    This is the data structure for the input parameters of the step defined
+    below.
+    """
+
+    name: typing.Annotated[str, validation.min(1)]
+
+
+@dataclass
+class SuccessOutput:
+    """
+    This is the output data structure for the success case.
+    """
+
+    message: str
+
+
+@dataclass
+class ErrorOutput:
+    """
+    This is the output data structure in the error  case.
+    """
+
+    error: str

docker-compose.yaml

@@ -4,6 +4,6 @@ services:
     image: quay.io/arcalot/arcaflow-plugin-template-python
     build: .
     volumes:
-      - source: ./example.yaml
+      - source: ./inputs/example.yaml
         target: /config/example.yaml
         type: bind

pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Arcalot"]
 license = "Apache-2.0+GPL-2.0-only"
 
 packages = [
-   { include="arcaflow_plugin_template_python.py", from="./arcaflow_plugin_template_python"  },
+   { include="template_python_plugin.py", from="./arcaflow_plugin_template_python"  },
 ]
 
 [tool.poetry.dependencies]

set-plugin-name.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+die () {
+    echo >&2 "$@"
+    exit 1
+}
+
+[ "$#" -eq 1 ] || die "1 argument required, $# provided"
+echo $1 | grep -E -q '^.*-.*' && die "Please use underscores (_) instead of hyphens (-)"
+
+for file in $(find . -type d -name '*template_python*'); do
+    git mv "$file" "${file/template_python/$1}"
+done
+
+for file in $(find . -type f -name '*template_python*'); do
+    git mv "$file" "${file/template_python/$1}"
+done
+
+for name in template_python Template; do
+    for file in $(grep -rl $name * .github); do
+        sed -i "s/$name/$1/g" $file
+    done
+done
+
+hyphenated_name=$(echo $1 | sed s/_/-/g)
+
+for file in $(grep -rl template-python *); do
+    sed -i "s/template-python/$hyphenated_name/g" $file
+done
+
+echo "Template renaming complete. Please remove this file and commit your changes."

tests/test_arcaflow_plugin_template_python.py

@@ -1,36 +1,34 @@
 #!/usr/bin/env python3
 import unittest
-import arcaflow_plugin_template_python
+import template_python_plugin
 from arcaflow_plugin_sdk import plugin
 
 
 class HelloWorldTest(unittest.TestCase):
     @staticmethod
     def test_serialization():
-        plugin.test_object_serialization(
-            arcaflow_plugin_template_python.InputParams("John Doe")
-        )
+        plugin.test_object_serialization(template_python_plugin.InputParams("John Doe"))
 
         plugin.test_object_serialization(
-            arcaflow_plugin_template_python.SuccessOutput("Hello, world!")
+            template_python_plugin.SuccessOutput("Hello, world!")
         )
 
         plugin.test_object_serialization(
-            arcaflow_plugin_template_python.ErrorOutput(error="This is an error")
+            template_python_plugin.ErrorOutput(error="This is an error")
         )
 
     def test_functional(self):
-        input = arcaflow_plugin_template_python.InputParams(name="Example Joe")
+        input = template_python_plugin.InputParams(name="Example Joe")
 
-        output_id, output_data = arcaflow_plugin_template_python.hello_world(
+        output_id, output_data = template_python_plugin.hello_world(
             params=input, run_id="plugin_ci"
         )
 
         # The example plugin always returns an error:
         self.assertEqual("success", output_id)
         self.assertEqual(
             output_data,
-            arcaflow_plugin_template_python.SuccessOutput("Hello, Example Joe!"),
+            template_python_plugin.SuccessOutput("Hello, Example Joe!"),
         )