Merge pull request #22 from octue/0.0.7

v0.0.7

MANIFEST.in

@@ -1,4 +1,7 @@
 include LICENSE
 include README.md
+include twined/schema/children_schema.json
+include twined/schema/manifest_schema.json
+include twined/schema/twine_schema.json
 recursive-include twined *
 recursive-include docs *

setup.py

@@ -15,7 +15,7 @@
 
 setup(
     name='twined',
-    version='0.0.6',
+    version='0.0.7',
     py_modules=[],
     install_requires=['jsonschema ~= 3.2.0'],
     url='https://www.github.com/octue/twined',

twined/schema/children_schema.json

@@ -0,0 +1,22 @@
+{
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "key": {
+                "description": "A textual key identifying a group of child twins",
+                "type": "string"
+            },
+            "id": {
+                "description": "The universally unique ID of the running child twin",
+                "type": "string"
+            },
+            "uri_env_name": {
+                "description": "Name of the environment variable containing the URI of the twin (which may contain credentials)",
+                "type": "string",
+                "pattern": "^[A-Z]+(?:_[A-Z]+)*$"
+            }
+        },
+        "required": ["key", "id", "uri_env_name"]
+    }
+}

twined/schema/manifest_schema.json

@@ -0,0 +1,80 @@
+{
+  "type": "object",
+  "properties": {
+    "kind": {
+      "description": "The kind of the manifest, eg 'multidataset'",
+      "type": "string"
+    },
+    "id": {
+      "description": "ID of the manifest, typically a uuid",
+      "type": "string"
+    },
+    "datasets": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "description": "ID of the dataset, typically a uuid",
+            "type": "string"
+          },
+          "name": {
+            "description": "Name of the dataset",
+            "type": "string"
+          },
+          "tags": {
+            "description": "Textual tags associated with the dataset",
+            "type": "string"
+          },
+          "files": {
+            "description": "Textual tags associated with the manifest",
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "description": "A file id",
+                  "type": "string"
+                },
+                "path": {
+                  "description": "Path at which the file can be found",
+                  "type": "string"
+                },
+                "extension": {
+                  "description": "The file extension (not including a '.')",
+                  "type": "string"
+                },
+                "sequence": {
+                  "description": "The ordering on the file, if any, within its group/cluster",
+                  "type": "integer"
+                },
+                "cluster": {
+                  "description": "The group, or cluster, to which the file belongs",
+                  "type": "integer"
+                },
+                "posix_timestamp": {
+                  "description": "A posix based timestamp associated with the file. This may, but need not be, the created or modified time. ",
+                  "type": "number"
+                },
+                "tags": {
+                  "description": "Textual tags associated with the file"
+                }
+              },
+              "required": [
+                "id",
+                "path",
+                "tags"
+              ]
+            }
+          }
+        },
+        "required": [
+          "id",
+          "tags",
+          "files"
+        ]
+      }
+    }
+  },
+  "required": ["id", "kind", "datasets"]
+}