feat: Initial structure

Author: Alan Christie

.gitignore

@@ -0,0 +1,2 @@
+dist/
+**/__pycache__/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Informatics Matters Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,14 @@
+# Informatics Matters Data Manager Workflow Decoder
+A package that simplifies the validation and decoding of Data Manager
+Workflow definitions.
+
+## Installation (Python)
+The Job decoder is published on PyPI and can be installed from there:
+
+    pip install im-data-manager-workflow-decoder
+
+Once installed you can validate the definition (expected to be a dictionary
+formed from the definition YAML file) with:
+
+>>> from workflow import decoder
+>>> error: Optional[str] = decoder.validate_schema(workflow)

poetry.lock

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "im-data-manager-workflow-decoder"
+version = "0.1.0"
+description = ""
+authors = ["Alan Christie <[email protected]>"]
+readme = "README.md"
+packages = [
+    { include = "workflow", from = "." }
+]
+
+[tool.poetry.dependencies]
+python = "^3.12"
+jsonschema = "^4.21.1"
+pyyaml = ">= 5.3.1, < 7.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -0,0 +1,37 @@
+"""A module to validate and decode workflow definitions.
+
+This is typically used by the Data Manager's Workflow Engine.
+"""
+import os
+from typing import Any, Dict, Optional
+
+import jsonschema
+import yaml
+
+# The (built-in) schemas...
+# from the same directory as us.
+_WORKFLOW_SCHEMA_FILE: str = os.path.join(
+    os.path.dirname(__file__), "workflow-schema.yaml"
+)
+
+# Load the Workflow schema YAML file now.
+# This must work as the file is installed along with this module.
+assert os.path.isfile(_WORKFLOW_SCHEMA_FILE)
+with open(_WORKFLOW_SCHEMA_FILE, "r", encoding="utf8") as schema_file:
+    _WORKFLOW_SCHEMA: Dict[str, Any] = yaml.load(schema_file, Loader=yaml.FullLoader)
+assert _WORKFLOW_SCHEMA
+
+
+def validate_schema(workflow: Dict[str, Any]) -> Optional[str]:
+    """Checks the Workflow Definition against the built-in schema.
+    If there's an error the error text is returned, otherwise None.
+    """
+    assert isinstance(workflow, dict)
+
+    try:
+        jsonschema.validate(workflow, schema=_WORKFLOW_SCHEMA)
+    except jsonschema.ValidationError as ex:
+        return str(ex.message)
+
+    # OK if we get here
+    return None

tests/__init__.py

@@ -0,0 +1,28 @@
+---
+# The JSONSchema for 'Workflow' YAML files.
+#
+# See https://json-schema.org/understanding-json-schema/index.html
+
+$schema: http://json-schema.org/draft-07/schema#
+
+title: Data Manager Workflow Schema
+description: >-
+  The Schema for Data Manager Workflows
+
+type: object
+properties:
+  kind:
+    const: DataManagerWorkflow
+  kind-version:
+    enum:
+    - '2024.1'
+  name:
+    type: string
+    description: The name of the workflow
+  description:
+    type: string
+    description: A description of the workflow
+required:
+- kind
+- kind-version
+- name