nl-service-metadata-generator


Namenl-service-metadata-generator JSON
Version 0.2.0 PyPI version JSON
download
home_page
SummaryCLI applicatie voor het genereren van service metadata die voldoet aan het Nederlands metadata profiel op ISO 19119 voor services versie 2.1.0 - https://docs.geostandaarden.nl/md/mdprofiel-iso19119/
upload_time2022-12-15 13:48:28
maintainer
docs_urlNone
author
requires_python>=3.8.10
licenseMIT
keywords ngr pdok iso19119 nl-metadata-profiel metadata cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # nl-service-metadata-generator

[![PyPI version](https://badge.fury.io/py/nl-service-metadata-generator.svg)](https://pypi.org/project/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](https://docs.geostandaarden.nl/md/mdprofiel-iso19119/).

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
pip3 install .
```

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

## Usage

```bash
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):

```bash
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.

## Development

Voor het formatteren van code installeer [`black`](https://pypi.org/project/black/) en draai vanuit de root van het repo:

```sh
black .
```

Verwijderen van ongebruikte imports met [`autoflake`](https://pypi.org/project/autoflake/):

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

Organiseren en orderen imports met [`isort`](https://pypi.org/project/isort/):

```sh
isort  -m 3 .
```

## Docker

Bouw docker image met:

```sh
docker build . -t nl-service-metadata-generator
```

Dan container starten met (n.b. `-u root` argument, is nodig voor priviliges Docker container om bestanden weg te schrijven in folder mount - niet op deze manier gebruiken voor productie doeleinden):

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

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "nl-service-metadata-generator",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8.10",
    "maintainer_email": "",
    "keywords": "ngr,pdok,iso19119,nl-metadata-profiel,metadata,cli",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/cb/ee/e8a91753c1ec8b56a8c56f515aae28becae4973f7f1c233d7d0d636be101/nl-service-metadata-generator-0.2.0.tar.gz",
    "platform": null,
    "description": "# nl-service-metadata-generator\n\n[![PyPI version](https://badge.fury.io/py/nl-service-metadata-generator.svg)](https://pypi.org/project/nl-service-metadata-generator/)\n\nCLI applicatie om service metadata records te genereren die voldoen aan het [Nederlands profiel op ISO 19119 voor services versie 2.1.0](https://docs.geostandaarden.nl/md/mdprofiel-iso19119/).\n\nCLI 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_).\n\nIndien 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.\n\n## Service Types\n\nDe nl-service-metadata-generator ondersteunt de volgende service types:\n\n- geen INSPIRE service\n- INSPIRE network service\n- INSPIRE other service\n  - Spatial Data Service (SDS) - invocable\n  - SDS - interoperable\n\n> N.B. SDS harmonized wordt dus niet ondersteund door de nl-service-metadata-generator\n\n## Installation\n\nInstalleer `nl-service-metadata-generator` als pip package (uitvoeren vanuit root van repository):\n\n```pip3\npip3 install .\n```\n\nNu moet het cli command `nl-service-metadata-generator` beschikbaar zijn in `PATH`.\n\n## Usage\n\n```bash\nUsage: nl-service-metadata-generator generate [OPTIONS] {csw|wms|wmts|wfs|wcs|\n                                              sos|atom|tms|oaf|oat}\n                                              {network|other|none}\n                                              CONSTANTS_CONFIG_FILE\n                                              SERVICE_CONFIG_FILE OUTPUT_FILE\n\n  Generate service metadata record based on **Nederlands profiel op ISO 19119\n  voor services versie 2.1.0**.\n\n  CONSTANTS_CONFIG_FILE: JSON file that contains values for constant fields\n  SERVICE_CONFIG_FILE: JSON file that contains values for fields that are\n  unique for each service\n\n  See `show-schema` command for help on config files.\n\nOptions:\n  --csw-endpoint TEXT             References to dataset metadata records will\n                                  use this CSW endpoint (default val: https://\n                                  nationaalgeoregister.nl/geonetwork/srv/dut/c\n                                  sw)\n  --sds-type [invocable|interoperable]\n                                  only applies when inspire-type='other'\n  --help                          Show this message and exit.\n```\n\nBijvoorbeeld (uitvoeren in root directory van dit repository):\n\n```bash\nnl-service-metadata-generator generate atom network example_json/constants.json example_json/inspire.json atom.xml\n```\n\nJSON 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.\n\n## Development\n\nVoor het formatteren van code installeer [`black`](https://pypi.org/project/black/) en draai vanuit de root van het repo:\n\n```sh\nblack .\n```\n\nVerwijderen van ongebruikte imports met [`autoflake`](https://pypi.org/project/autoflake/):\n\n```sh\nautoflake --remove-all-unused-imports -i -r .\n```\n\nOrganiseren en orderen imports met [`isort`](https://pypi.org/project/isort/):\n\n```sh\nisort  -m 3 .\n```\n\n## Docker\n\nBouw docker image met:\n\n```sh\ndocker build . -t nl-service-metadata-generator\n```\n\nDan container starten met (n.b. `-u root` argument, is nodig voor priviliges Docker container om bestanden weg te schrijven in folder mount - niet op deze manier gebruiken voor productie doeleinden):\n\n```sh\ndocker run --user root -v $(pwd)/example_json:/data nl-service-metadata-generator generate atom network /data/constants.json /data/inspire.json /data/atom.xml\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CLI applicatie voor het genereren van service metadata die voldoet aan het Nederlands metadata profiel op ISO 19119 voor services versie 2.1.0 - https://docs.geostandaarden.nl/md/mdprofiel-iso19119/",
    "version": "0.2.0",
    "split_keywords": [
        "ngr",
        "pdok",
        "iso19119",
        "nl-metadata-profiel",
        "metadata",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "fc52f1d0e1a0050f00c75211c7dcc173",
                "sha256": "bd6d4c0cf2e448769392e9ed1b9f9bac631e2940aced81e129ce7a481b150db7"
            },
            "downloads": -1,
            "filename": "nl_service_metadata_generator-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fc52f1d0e1a0050f00c75211c7dcc173",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.10",
            "size": 181728,
            "upload_time": "2022-12-15T13:48:26",
            "upload_time_iso_8601": "2022-12-15T13:48:26.014662Z",
            "url": "https://files.pythonhosted.org/packages/bf/cb/c12ef655d5d8946634d6f952a1258eaaec9d32e654b649b7631a651e1f5b/nl_service_metadata_generator-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f5917c950f58c64e129e84ba42c21cd6",
                "sha256": "2a13205746754716e6f2a09158cd2f0829ea388f9c1fdb23de49f17d7ca811ba"
            },
            "downloads": -1,
            "filename": "nl-service-metadata-generator-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f5917c950f58c64e129e84ba42c21cd6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.10",
            "size": 108972,
            "upload_time": "2022-12-15T13:48:28",
            "upload_time_iso_8601": "2022-12-15T13:48:28.239000Z",
            "url": "https://files.pythonhosted.org/packages/cb/ee/e8a91753c1ec8b56a8c56f515aae28becae4973f7f1c233d7d0d636be101/nl-service-metadata-generator-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-15 13:48:28",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "nl-service-metadata-generator"
}
Elapsed time: 0.02401s