README.md

Discovery Metadata Catalog Ingestor

Dependencies

For the main packages:

Package	PyPi	Ubuntu/Debian	Source
requests	pip install requests	python3-requests	https://github.com/psf/requests
pyyaml	pip install pyyaml	python3-yaml	https://github.com/yaml/pyyaml
flask	pip install flask	python3-flask	https://github.com/pallets/flask
lxml	pip install lxml	python3-lxml	https://github.com/lxml/lxml

In addition, the tool metvocab must be installed from github.com/metno/met-vocab-tools.

The requirements can also be installed with:

pip install -r requirements.txt

The xslt/mmd-to-geonorge.xsl and xsd/mmd_strict.xsd files are needed from github.com/metno/mmd, and should be set as the values of to the mmd_xsl_path and mmd_xsd_path config variables.

Environment Variables

The package reads the following environment variables.

• DMCI_CONFIG should point to the config file, in yaml format.
• DMCI_LOGFILE can be set to enable logging to file.
• DMCI_LOGLEVEL can be set to change log level. See the Debugging section below.

If the config variable is not set, the package will look for a file named config.yaml at the package root location. If neither the environment variable is set, or this file exists, the initialisation will fail and exit with exit code 1.

Installation

git clone https://github.com/metno/discovery-metadata-catalog-ingestor

cd discovery-metadata-catalog-ingestor

mkdir workdir

cd workdir

mkdir rejected

Create the file config.yaml based on example-config.yaml and fill it with the following:

dmci:
  distributors:
    - file
    - pycsw
    - solr
  distributor_cache: workdir
  rejected_jobs_path: workdir/rejected
  max_permitted_size: 100000
  mmd_xsl_path: path/to/mmd/xslt/mmd-to-geonorge.xsl
  mmd_xsd_path: path/to/mmd/xsd/mmd_strict.xsd
  path_to_parent_list: parent-uuid-list.xml

pycsw:
  csw_service_url: http://localhost

customization:
  catalog_url: https://catalog url
  env_string: null
  
file:
  file_archive_path: workdir

solr:
  solr_service_url: http://localhost
  solr_username: username
  solr_password: psw

Usage

To start the API run:

python dmci_start_api.py

Then you can post with curl to the api - endpoint:

# Validate, insert, create and update call signature
curl --data-binary "@<PATH_TO_MMD_FILE>" localhost:5000/v1/validate
# Delete works differently
curl -X POST localhost:5000/v1/delete/<UUID_OF_FILE_TO_DELETE>

Available commands are: validate, insert or create, update, and delete. Note that insert and create is the same - insert will be removed in the next major version (1.0).

The API uses HTTP return codes, and expected returns are:

200 for validated and queued requests.
404 for non-implemented commands.
413 for files being bigger than treshold (Default is 10MB, given as max_permitted_size)
500 for validation errors and other internal server problems
507 if file could not be saved to the work queue

Design

Tests

The tests use pytest. To run all tests for all modules, run:

python -m pytest -vv

To add coverage, and to optionally generate a coverage report in HTML, run:

python -m pytest -vv --cov=dmci --cov-report=term-missing --cov-report=html

Coverage requires the pytest-cov package.

Debugging

To increase logging level to include info and debug messages, set the environment variable DMCI_LOGLEVEL to the desired level. Valid levels are CRITICAL, ERROR, WARNING, INFO, and DEBUG.

License

Copyright 2021 MET Norway

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See Also: LICENSE