Add docs and json definitions

Author: chbrandt

docs/cli.md

@@ -0,0 +1,9 @@
+# Workflow in terms of the command order
+
+```
+$ validator --geopackage <path-to-geopackage> \
+    --layers <comma-separated-list-of-layers> \
+    --columns-all <comma-separated-list-of-columns-in-all-layers> \
+    --columns-layers <comma-separated-list-of-layers:columns-key:values> \
+    --assert-nonempty <list-of-columns-to-assert-nonempty-records>
+```

docs/json.md

@@ -0,0 +1,14 @@
+# Workflow in terms of the json
+
+{
+    "filename": <path-to-geopackage>,
+    "type": geopackage,
+    tasks: {
+        "check-layers": [list-of-layers],
+        "check-layer-columns": {
+            <layer-name> : [list-of-columns-in-layer-name]
+        },
+        "check-all-columns": [list-of-columns-in-all-layers],
+        "check-nonempty": [list-of-columns-to-assert-nonemty]
+    }
+}

docs/scratch.md

@@ -0,0 +1,67 @@
+# Scratch
+
+Define a package in terms of a json structure.
+```json
+{
+    "name": "PM_{BODY}_{TYPE}_{TOPONYM}_{SPEC}_{VERSION}",
+    "type": "planmap-package",
+    "content": {
+        "type": "files",
+        "meta.json": {
+            "type": "json",
+            "mandatory": "true",
+            "content": {
+                # json-schema
+            }
+        },
+        "document": {
+            "type": "directory",
+            "mandatory": "true",
+            "content": {
+                # filenames-regex
+            }
+        },
+        "vector": {
+            "type": "directory",
+            "mandatory": "false",
+            "content": {
+                "type": "files",
+                "*.gpkg": {
+                    "type": "geopackage",
+                    "mandatory": "true",
+                    "content": {
+                        "units": {
+                            "mandatory": "true",
+                            "type": "table",
+                            "content": [
+                                {
+                                    "name": "name",
+                                    "type": "string",
+                                    "mandatory": "true"
+                                },
+                                {
+                                    "name": "geometry",
+                                    "type": "Polygon",
+                                    "mandatory": "true"
+                                }
+                            ]
+                        },
+                        "contacts": {
+                            "mandatory": "true",
+                            "type": "table",
+                            "content": [
+                                {
+                                    "name": "geometry",
+                                    "type": "Linestring",
+                                    "mandatory": "true"
+                                }
+                            ]
+                        }
+                    }
+                }
+                # filenames-regex (e.g., *.gpkg)
+            }
+        }
+    }
+}
+```

validator/vector/__init__.py

@@ -0,0 +1,47 @@
+{
+    "definitions": {
+
+        "point_coordinates": {
+            "type": "array",
+            "items": [
+                {
+                    "type": "number"
+                }
+            ],
+            "minItems": 2,
+            "maxItems": 3
+        },
+
+        "line_coordinates": {
+            "type": "array",
+            "items": [
+                {
+                    "$ref": "#/definitions/point_coordinates"
+                }
+            ],
+            "minItems": 2
+        },
+
+        "polygon_coordinates": {
+            "type": "array",
+            "items": [
+                {
+                    "$ref": "#/definitions/line_coordinates"
+                },
+                { "minItems": 4 }
+            ]
+        },
+
+        "polygon_geometry": {
+            "type": "object",
+            "properties": {
+                "type": {
+                    "const": "Polygon"
+                },
+                "coordinates": {
+                    "$ref": "#/definitions/polygon_coordinates"
+                }
+            }
+        }
+    }
+}

validator/vector/definitions.json

@@ -0,0 +1,74 @@
+{
+"$schema": "http://json-schema.org/draft-07/schema#",
+
+"title": "Match Geopackage's 'Units' layer columns list",
+
+"$comment": "Works for, e.g., ['name','geometry','code','bla'], but not for ['bla','name','geometry','code']",
+"$example": ["name","geometry","code","another-column"],
+
+    "definitions": {
+
+        "point_coordinates": {
+            "type": "array",
+            "items": [
+                {
+                    "type": "number"
+                }
+            ],
+            "minItems": 2,
+            "maxItems": 3
+        },
+
+        "line_coordinates": {
+            "type": "array",
+            "items": [
+                {
+                    "$ref": "#/definitions/point_coordinates"
+                }
+            ],
+            "minItems": 2
+        },
+
+        "polygon_coordinates": {
+            "type": "array",
+            "items": [
+                {
+                    "$ref": "#/definitions/line_coordinates"
+                },
+                { "minItems": 4 }
+            ],
+            "minItems": 1,
+            "maxItems": 1
+        },
+
+        "polygon_geometry": {
+            "type": "object",
+            "properties": {
+                "type": {
+                    "const": "Polygon"
+                },
+                "coordinates": {
+                    "$ref": "#/definitions/polygon_coordinates"
+                }
+            }
+        }
+    },
+
+
+    "type": "object",
+    "properties": {
+
+        "Unit": {
+            "type": "string"
+        },
+
+        "RGB": {
+            "type": "string"
+        },
+
+        "geometry": {
+                "$ref": "#/definitions/polygon_geometry"
+        }
+
+    }
+}