nl-service-metadata-generator

CLI applicatie om service metadata records te genereren die voldoen aan het Nederlands profiel op ISO 19119 voor services versie 2.1.0.

CLI applicatie genereert metadata en voert schema validatie uit. Applicatie voert geen schematron validatie uit (validatie op Nederlands profiel op ISO 19119 voor services versie 2.1.0).

Indien schema validatie faalt op de gegenereerde metadata wordt het metadata bestand weggeschreven naar ${file-destination}.invalid (dus toevoeging van .invalid extensie) en zal de nl-service-metadata-generator de schema validatie foutmelding naar stdout printen en een returncode van 1 teruggeven.

Service Types

De nl-service-metadata-generator ondersteunt de volgende service types:

geen INSPIRE service
INSPIRE network service
INSPIRE other service
- Spatial Data Service (SDS) - invocable
- SDS - interoperable

N.B. SDS harmonized wordt dus niet ondersteund door de nl-service-metadata-generator

Installation

Installeer nl-service-metadata-generator als pip package (uitvoeren vanuit root van repository):

pip3 install .

Nu moet het cli command nl-service-metadata-generator beschikbaar zijn in PATH.

Usage

Usage: nl-service-metadata-generator generate [OPTIONS] {csw|wms|wmts|wfs|wcs|
                                              sos|atom|tms|oaf|oat}
                                              {network|other|none}
                                              CONSTANTS_CONFIG_FILE
                                              SERVICE_CONFIG_FILE OUTPUT_FILE

  Generate service metadata record based on **Nederlands profiel op ISO 19119
  voor services versie 2.1.0**.

  CONSTANTS_CONFIG_FILE: JSON file that contains values for constant fields
  SERVICE_CONFIG_FILE: JSON file that contains values for fields that are
  unique for each service

  See `show-schema` command for help on config files.

Options:
  --csw-endpoint TEXT             References to dataset metadata records will
                                  use this CSW endpoint (default val: https://
                                  nationaalgeoregister.nl/geonetwork/srv/dut/c
                                  sw)
  --sds-type [invocable|interoperable]
                                  only applies when inspire-type='other'
  --help                          Show this message and exit.

Bijvoorbeeld (uitvoeren in root directory van dit repository):

nl-service-metadata-generator generate atom network example_json/constants.json example_json/inspire.json atom.xml

JSON schema voor de CONSTANTS_CONFIG_FILE en METADATA_CONFIG_FILE kunnen worden opgevraagd middels het show-schema command, zie nl-service-metadata-generator show-schema --help voor help.

Template variabelen

In de velden

service_title
service_abstract

Kunnen de volgende template variabelen worden opgenomen:

$SERVICE_TYPE_UPPER - wordt vervangen door uppercase service type (korte variant)
$SERVICE_TYPE_LOWER - wordt vervangen door lowercase service type (korte variant)

Bijvoorbeeld:

{
  ...
  "serviceTitle": "Actueel Hoogtebestand Nederland $SERVICE_TYPE_UPPER"
  ...
}

Development

Voor het formatteren van code installeer black en draai vanuit de root van het repo:

black .

Verwijderen van ongebruikte imports met autoflake:

autoflake --remove-all-unused-imports -i -r .

Organiseren en orderen imports met isort:

isort  -m 3 .

Docker

Container starten met:

docker run --user root -v $(pwd)/example_json:/data pdok/nl-service-metadata-generator generate atom network /data/constants.json /data/inspire.json /data/atom.xml

n.b. -u root argument, is nodig voor priviliges Docker container om bestanden weg te schrijven in folder mount. Voor productie doeleindes niet aan te raden om docker containers onder de root user te draaien.