dsp-tools 0.9.13__py3-none-any.whl → 18.3.0.post13__py3-none-any.whl

dsp_tools/resources/schema/resources-only.json

@@ -0,0 +1,140 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://dasch.swiss/schema/resources-only.json",
+    "title": "JSON schema for resources used in DSP ontologies",
+    "description": "JSON schema for the resources section used in DSP ontologies",
+    "definitions": {
+        "langstring": {
+            "type": "object",
+            "patternProperties": {
+                "^(en|de|fr|it|rm)$": {
+                    "type": "string"
+                }
+            },
+            "minProperties": 1,
+            "additionalProperties": false
+        },
+        "ncname": {
+            "type": "string",
+            "pattern": "^[a-zA-Z_][\\w.-]*$",
+            "additionalProperties": false
+        },
+        "prefixedname": {
+            "type": "string",
+            "pattern": "^([a-zA-Z_][\\w.-]*)?:([\\w.-]+)$",
+            "additionalProperties": false
+        },
+        "baseresource": {
+            "type": "string",
+            "enum": [
+                "Resource",
+                "Region",
+                "Representation",
+                "StillImageRepresentation",
+                "TextRepresentation",
+                "AudioRepresentation",
+                "DDDRepresentation",
+                "DocumentRepresentation",
+                "MovingImageRepresentation",
+                "ArchiveRepresentation"
+            ]
+        },
+        "super_resource": {
+            "type": ["string"],
+            "oneOf": [
+                {
+                    "$ref": "#/definitions/baseresource"
+                },
+                {
+                    "$ref": "#/definitions/prefixedname"
+                },
+                {
+                    "pattern": "^https?://.*"
+                }
+            ]
+        },
+        "super_resource_as_string_or_array": {
+            "oneOf": [
+                {
+                    "$ref": "#/definitions/super_resource"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/super_resource"
+                    }
+                }
+            ]
+        },
+        "resource": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "$ref": "#/definitions/ncname"
+                },
+                "super": {
+                    "$ref": "#/definitions/super_resource_as_string_or_array"
+                },
+                "labels": {
+                    "$ref": "#/definitions/langstring"
+                },
+                "comments": {
+                    "$ref": "#/definitions/langstring"
+                },
+                "cardinalities": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/cardinality"
+                    },
+                    "minItems": 1
+                }
+            },
+            "required": [
+                "name",
+                "super",
+                "labels"
+            ],
+            "additionalProperties": false
+        },
+        "cardinality": {
+            "type": "object",
+            "properties": {
+                "propname": {
+                    "type": "string",
+                    "oneOf": [
+                        {
+                            "enum": [
+                                "isPartOf",
+                                "seqnum"
+                            ]
+                        },
+                        {
+                            "$ref": "#/definitions/prefixedname"
+                        }
+                    ]
+                },
+                "cardinality": {
+                    "type": "string",
+                    "enum": [
+                        "1",
+                        "0-1",
+                        "1-n",
+                        "0-n"
+                    ]
+                },
+                "gui_order": {
+                    "type": "integer"
+                }
+            },
+            "required": [
+                "propname",
+                "cardinality"
+            ],
+            "additionalProperties": false
+        }
+    },
+    "type": "array",
+    "items": {
+        "$ref": "#/definitions/resource"
+    }
+}

dsp_tools/resources/start-stack/docker-compose.override-host.j2

@@ -0,0 +1,11 @@
+services:
+  api:
+    environment:
+      - KNORA_WEBAPI_KNORA_API_EXTERNAL_HOST={{ CUSTOM_HOST }}
+  sipi:
+    environment:
+      - KNORA_WEBAPI_KNORA_API_EXTERNAL_HOST={{ CUSTOM_HOST }}
+  ingest:
+    environment:
+      - JWT_ISSUER={{ CUSTOM_HOST }}:3333
+

dsp_tools/resources/start-stack/docker-compose.override.yml

@@ -0,0 +1,11 @@
+---
+
+services:
+  api:
+    image: daschswiss/knora-api:latest
+  sipi:
+    image: daschswiss/knora-sipi:latest
+  db:
+    image: daschswiss/apache-jena-fuseki:latest
+  ingest:
+    image: daschswiss/dsp-ingest:latest

dsp_tools/resources/start-stack/docker-compose.yml

@@ -0,0 +1,88 @@
+---
+services:
+  api:
+    # on the verge of every deployment, update the "image" value from the "api" value of
+    # https://github.com/dasch-swiss/ops-deploy/blob/main/versions/RELEASE.json
+    image: daschswiss/knora-api:v33.1.1
+    depends_on:
+      - sipi
+      - db
+    ports:
+      - "3333:3333"
+    environment:
+      - TZ=Europe/Zurich
+      - KNORA_AKKA_LOGLEVEL=DEBUG
+      - KNORA_AKKA_STDOUT_LOGLEVEL=DEBUG
+      - KNORA_WEBAPI_DSP_INGEST_AUDIENCE=http://localhost:3340
+      - KNORA_WEBAPI_DSP_INGEST_BASE_URL=http://ingest:3340
+      - KNORA_WEBAPI_TRIPLESTORE_HOST=db
+      - KNORA_WEBAPI_TRIPLESTORE_FUSEKI_REPOSITORY_NAME=dsp-repo
+      - KNORA_WEBAPI_TRIPLESTORE_FUSEKI_USERNAME=admin
+      - KNORA_WEBAPI_TRIPLESTORE_FUSEKI_PASSWORD=test
+      - KNORA_WEBAPI_CACHE_SERVICE_ENABLED=true
+      - KNORA_WEBAPI_ALLOW_RELOAD_OVER_HTTP=true
+      - KNORA_WEBAPI_KNORA_API_EXTERNAL_HOST=0.0.0.0
+      - KNORA_WEBAPI_KNORA_API_EXTERNAL_PORT=3333
+      - ALLOW_ERASE_PROJECTS=true
+      - DSP_API_LOG_LEVEL=INFO
+
+  sipi:
+    # on the verge of every deployment, take the same tag as DSP-API
+    image: daschswiss/knora-sipi:v33.1.1
+    ports:
+      - "1024:1024"
+    volumes:
+      - ./tmp:/tmp
+      - ./sipi.docker-config.lua:/sipi/config/sipi.docker-config.lua
+      - ./sipi/images:/sipi/images
+    environment:
+      - TZ=Europe/Zurich
+      - KNORA_WEBAPI_KNORA_API_EXTERNAL_HOST=0.0.0.0
+      - KNORA_WEBAPI_KNORA_API_EXTERNAL_PORT=3333
+    command: --config=/sipi/config/sipi.docker-config.lua
+
+  ingest:
+    # on the verge of every deployment, take the same tag as DSP-API
+    image: daschswiss/dsp-ingest:v33.1.1
+    ports:
+      - "3340:3340"
+    volumes:
+      - ./sipi/images:/opt/images
+      - ./sipi/tmp-dsp-ingest:/opt/tmp
+      - ingest-db:/opt/db
+    environment:
+      - SERVICE_HOST=0.0.0.0
+      - SERVICE_PORT=3340
+      - SERVICE_LOG_FORMAT=text
+      - STORAGE_ASSET_DIR=/opt/images
+      - STORAGE_TEMP_DIR=/opt/tmp
+      - JWT_AUDIENCE=http://localhost:3340
+      - JWT_ISSUER=0.0.0.0:3333
+      - JWT_SECRET=UP 4888, nice 4-8-4 steam engine
+      - SIPI_USE_LOCAL_DEV=false
+      - ALLOW_ERASE_PROJECTS=true
+      - DB_JDBC_URL=jdbc:sqlite:/opt/db/ingest.sqlite
+      - DSP_API_URL=http://host.docker.internal:3333
+
+  app:
+    # on the verge of every deployment, update the "image" value from the "app" value of
+    # https://github.com/dasch-swiss/ops-deploy/blob/main/versions/RELEASE.json
+    image: daschswiss/dsp-app:v12.2.3
+    volumes:
+      - ./dsp-app-config.json:/public/config/config.prod.json
+    ports:
+      - "4200:4200"
+
+  db:
+    # on the verge of every deployment, update the "image" value from the "db" value of
+    # https://github.com/dasch-swiss/ops-deploy/blob/main/versions/RELEASE.json
+    image: daschswiss/apache-jena-fuseki:5.5.0-3
+    ports:
+      - "3030:3030"
+    environment:
+      - TZ=Europe/Zurich
+      - ADMIN_PASSWORD=test
+      - JVM_ARGS=-Xmx3G
+
+volumes:
+  ingest-db:

dsp_tools/resources/start-stack/dsp-app-config.json

@@ -0,0 +1,45 @@
+{
+    "dspRelease": "localhost",
+    "apiProtocol": "http",
+    "apiHost": "0.0.0.0",
+    "apiPort": 3333,
+    "apiPath": "",
+    "iiifProtocol": "http",
+    "iiifHost": "0.0.0.0",
+    "iiifPort": 1024,
+    "iiifPath": "",
+    "ingestUrl": "http://0.0.0.0:3340",
+    "geonameToken": "knora",
+    "jsonWebToken": "",
+    "logErrors": false,
+    "iriBase": "http://rdfh.ch",
+    "instrumentation": {
+      "environment": "production",
+      "rollbar": {
+        "enabled": false,
+        "accessToken": ""
+      },
+      "faro": {
+        "enabled": false,
+        "collectorUrl": "",
+        "appName": "dsp-app",
+        "sessionTracking": {
+          "enabled": false,
+          "persistent": false,
+          "samplingRate": 1.0
+        },
+        "console": {
+          "enabled": false,
+          "disabledLevels": []
+        },
+        "tracingCorsUrls": [],
+        "otlp": {
+          "logsUrl": "",
+          "tracesUrl": ""
+        }
+      }
+    },
+    "featureFlags": {
+      "allowEraseProjects": true
+    }
+  }

dsp_tools/resources/start-stack/dsp-app-config.override-host.j2

@@ -0,0 +1,26 @@
+{
+    "dspRelease": "test instance",
+    "apiProtocol": "http",
+    "apiHost": "{{ CUSTOM_HOST }}",
+    "apiPort": 3333,
+    "apiPath": "",
+    "iiifProtocol": "http",
+    "iiifHost": "{{ CUSTOM_HOST }}",
+    "iiifPort": 1024,
+    "iiifPath": "",
+    "ingestUrl": "http://{{ CUSTOM_HOST }}:3340",
+    "geonameToken": "knora",
+    "jsonWebToken": "",
+    "logErrors": false,
+    "iriBase": "http://rdfh.ch",
+    "instrumentation": {
+      "environment": "production",
+      "rollbar": {
+        "enabled": false,
+        "accessToken": ""
+      }
+    },
+    "featureFlags": {
+      "allowEraseProjects": true
+    }
+}

dsp_tools/resources/validate_data/api-shapes-resource-cardinalities.ttl

@@ -0,0 +1,191 @@
+@prefix sh:         <http://www.w3.org/ns/shacl#> .
+@prefix rdfs:       <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix xsd:        <http://www.w3.org/2001/XMLSchema#> .
+@prefix owl:        <http://www.w3.org/2002/07/owl#> .
+@prefix dash:       <http://datashapes.org/dash#> .
+@prefix knora-api:  <http://api.knora.org/ontology/knora-api/v2#> .
+
+@prefix api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#> .
+
+
+api-shapes:rdfsLabel_Cardinality
+  a           sh:PropertyShape ;
+  sh:path     rdfs:label ;
+  sh:minCount 1 ;
+  sh:maxCount 1 ;
+  sh:severity sh:Violation ;
+  sh:message  "A label is required" .
+
+
+### knora-api:hasPermissions
+api-shapes:hasPermissions_Cardinality
+  a           sh:PropertyShape ;
+  sh:path     knora-api:hasPermissions ;
+  sh:minCount 0 ;
+  sh:maxCount 1 ;
+  sh:severity sh:Violation ;
+  sh:message  "The resource may have at most one permission." .
+
+
+#########################################
+# DSP IN-BUILT RESOURCES
+#########################################
+
+
+###########################
+# LinkObj
+
+knora-api:LinkObj
+  a                  sh:NodeShape ;
+  dash:closedByTypes true ;
+  sh:property        api-shapes:rdfsLabel_Cardinality ,
+                     api-shapes:hasPermissions_Cardinality ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasComment
+                     ],
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasLinkTo ;
+                       sh:minCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 1-n"
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasStandoffLinkTo
+                     ] .
+
+###########################
+# Region
+
+knora-api:Region
+  a                  sh:NodeShape ;
+  dash:closedByTypes true ;
+  sh:property        api-shapes:rdfsLabel_Cardinality,
+                     api-shapes:hasPermissions_Cardinality ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasComment
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasColor ;
+                       sh:minCount 1 ;
+                       sh:maxCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 1"
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:isRegionOf ;
+                       sh:minCount 1 ;
+                       sh:maxCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 1"
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasGeometry ;
+                       sh:minCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 1-n"
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasStandoffLinkTo
+                     ] .
+
+
+###########################
+# AudioSegment
+
+knora-api:AudioSegment
+  a                  sh:NodeShape ;
+  dash:closedByTypes true ;
+  sh:property        api-shapes:rdfsLabel_Cardinality,
+                     api-shapes:hasPermissions_Cardinality ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasSegmentBounds ;
+                       sh:minCount 1 ;
+                       sh:maxCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 1"
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:isAudioSegmentOf ;
+                       sh:minCount 1 ;
+                       sh:maxCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 1"
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasTitle ;
+                       sh:maxCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 0-1"
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasKeyword
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasComment
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:relatesTo
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasDescription
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasStandoffLinkTo
+                     ] .
+
+
+###########################
+# VideoSegment
+
+knora-api:VideoSegment
+  a                  sh:NodeShape ;
+  dash:closedByTypes true ;
+  sh:property        api-shapes:rdfsLabel_Cardinality,
+                     api-shapes:hasPermissions_Cardinality ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasSegmentBounds ;
+                       sh:minCount 1 ;
+                       sh:maxCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 1"
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:isVideoSegmentOf ;
+                       sh:minCount 1 ;
+                       sh:maxCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 1"
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasTitle ;
+                       sh:maxCount 1 ;
+                       sh:severity sh:Violation ;
+                       sh:message "Cardinality 0-1"
+                     ] ,
+                     [ a sh:PropertyShape ;
+                       sh:path knora-api:hasKeyword
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasComment
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:relatesTo
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasDescription
+                     ] ,
+                     [
+                       a sh:PropertyShape ;
+                       sh:path knora-api:hasStandoffLinkTo
+                     ] .