pywcmp 0.14.0__py3-none-any.whl

pywcmp/__init__.py

@@ -0,0 +1,47 @@
+###############################################################################
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#          Ján Osuský <jan.osusky@iblsoft.com>
+#
+# Copyright (c) 2026 Tom Kralidis
+# Copyright (c) 2022 Government of Canada
+# Copyright (c) 2020 IBL Software Engineering spol. s r. o.
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+###############################################################################
+
+import click
+
+from pywcmp.ets import ets
+from pywcmp.bundle import bundle
+from pywcmp.kpi import kpi
+from pywcmp.util import get_package_version
+
+__version__ = get_package_version()
+
+
+@click.group()
+@click.version_option(version=__version__)
+def cli():
+    pass
+
+
+cli.add_command(ets)
+cli.add_command(bundle)
+cli.add_command(kpi)

pywcmp/bundle.py

@@ -0,0 +1,130 @@
+###############################################################################
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#
+# Copyright (c) 2025 Tom Kralidis
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+###############################################################################
+
+import io
+import logging
+import os
+from pathlib import Path
+import shutil
+import tempfile
+import zipfile
+
+import click
+
+from pywcmp.util import (get_cli_common_options, get_userdir, urlopen_,
+                         setup_logger)
+
+LOGGER = logging.getLogger(__name__)
+
+USERDIR = get_userdir()
+
+TEMPDIR = tempfile.TemporaryDirectory()
+TEMPDIR2 = Path(tempfile.TemporaryDirectory().name)
+
+WCMP2_FILES_TEMP = TEMPDIR2 / 'wcmp-2'
+WIS2_TOPIC_HIERARCHY_DIR_TEMP = TEMPDIR2 / 'wis2-topic-hierarchy'
+
+WCMP2_FILES = get_userdir() / 'wcmp-2'
+WIS2_TOPIC_HIERARCHY_DIR = get_userdir() / 'wis2-topic-hierarchy'
+
+
+@click.group()
+def bundle():
+    """Configuration bundle management"""
+    pass
+
+
+@click.command()
+@get_cli_common_options
+@click.pass_context
+def sync(ctx, logfile, verbosity):
+    """Sync configuration bundle"""
+
+    setup_logger(verbosity, logfile)
+    LOGGER.debug('Caching schemas, codelists and topic hierarchy')
+
+    LOGGER.debug('Caching WCMP2 artifacts')
+    LOGGER.debug(f'Downloading WCMP2 schema to {WCMP2_FILES_TEMP}')
+    WCMP2_FILES_TEMP.mkdir(parents=True, exist_ok=True)
+    WCMP2_SCHEMA = 'https://raw.githubusercontent.com/wmo-im/wcmp2/main/schemas/wcmp2-bundled.json'  # noqa
+
+    json_schema = WCMP2_FILES_TEMP / 'wcmp2-bundled.json'
+    with json_schema.open('wb') as fh:
+        fh.write(urlopen_(f'{WCMP2_SCHEMA}').read())
+
+    WCMP2_CODELISTS = WCMP2_FILES_TEMP / 'codelists'
+    LOGGER.debug(f'Downloading WCMP2 codelists to {WCMP2_CODELISTS}')
+    WCMP2_CODELISTS.mkdir(parents=True, exist_ok=True)
+    CODELISTS_URL = 'https://github.com/wmo-im/wcmp2-codelists/archive/refs/heads/main.zip'  # noqa
+    FH = io.BytesIO(urlopen_(CODELISTS_URL).read())
+    with zipfile.ZipFile(FH) as z:
+        LOGGER.debug(f'Processing zipfile "{z.filename}"')
+        for name in z.namelist():
+            LOGGER.debug(f'Processing entry "{name}"')
+            if '.csv' in name:
+                filename = os.path.basename(name)
+
+                if not filename:
+                    continue
+
+                dest_file = WCMP2_CODELISTS / filename
+                LOGGER.debug(f'Creating "{dest_file}"')
+                with z.open(name) as src, dest_file.open('wb') as dest:
+                    shutil.copyfileobj(src, dest)
+
+    LOGGER.debug('Downloading WIS2 topic hierarchy')
+    WIS2_TOPIC_HIERARCHY_DIR_TEMP.mkdir(parents=True, exist_ok=True)
+
+    ZIPFILE_URL = 'https://wmo-im.github.io/wis2-topic-hierarchy/wth-bundle.zip'  # noqa
+    FH = io.BytesIO(urlopen_(ZIPFILE_URL).read())
+    with zipfile.ZipFile(FH) as z:
+        LOGGER.debug(f'Processing zipfile "{z.filename}"')
+        for name in z.namelist():
+            LOGGER.debug(f'Processing entry "{name}"')
+            filename = os.path.basename(name)
+
+            dest_file = WIS2_TOPIC_HIERARCHY_DIR_TEMP / filename
+            LOGGER.debug(f'Creating "{dest_file}"')
+            with z.open(name) as src, dest_file.open('wb') as dest:
+                shutil.copyfileobj(src, dest)
+
+    LOGGER.debug('Downloading IANA link relations')
+    IANA_URL = 'https://www.iana.org/assignments/link-relations/link-relations-1.csv'  # noqa
+    iana_file = WCMP2_FILES_TEMP / 'link-relations-1.csv'
+    with iana_file.open('wb') as fh:
+        fh.write(urlopen_(f'{IANA_URL}').read())
+
+    LOGGER.debug(f'Removing {USERDIR}')
+    if USERDIR.exists():
+        shutil.rmtree(USERDIR)
+
+    LOGGER.debug(f'Moving files from {TEMPDIR2} to {USERDIR}')
+    shutil.move(TEMPDIR2, USERDIR)
+
+    LOGGER.debug(f'Cleaning up {TEMPDIR}')
+    TEMPDIR.cleanup()
+
+
+bundle.add_command(sync)

pywcmp/errors.py

@@ -0,0 +1,31 @@
+###############################################################################
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#
+# Copyright (c) 2022 Tom Kralidis
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+###############################################################################
+
+class TestSuiteError(Exception):
+    """custom exception handler"""
+    def __init__(self, message, errors):
+        """set error list/stack"""
+        super(TestSuiteError, self).__init__(message)
+        self.errors = errors

pywcmp/ets.py

@@ -0,0 +1,91 @@
+###############################################################################
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#          Ján Osuský <jan.osusky@iblsoft.com>
+#
+# Copyright (c) 2025 Tom Kralidis
+# Copyright (c) 2022 Government of Canada
+# Copyright (c) 2020 IBL Software Engineering spol. s r. o.
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+###############################################################################
+
+# executable test for WCMP2
+
+import json
+
+import click
+
+from pywcmp.wcmp2.ets import WMOCoreMetadataProfileTestSuite2
+from pywcmp.util import (get_cli_common_options, parse_wcmp, setup_logger,
+                         urlopen_)
+
+
+@click.group()
+def ets():
+    """executable test suite"""
+    pass
+
+
+@click.command()
+@click.pass_context
+@get_cli_common_options
+@click.argument('file_or_url')
+@click.option('--fail-on-schema-validation/--no-fail-on-schema-validation',
+              '-f', default=True,
+              help='Stop the ETS on failing schema validation')
+@click.option('--relax-centre-id-checks', '-r', is_flag=True,
+              default=False, help='Relax centre identifier based checks')
+def validate(ctx, file_or_url, logfile, verbosity,
+             fail_on_schema_validation=True,
+             relax_centre_id_checks=False):
+    """validate against the abstract test suite"""
+
+    setup_logger(verbosity, logfile)
+
+    click.echo(f'Opening {file_or_url}')
+
+    if file_or_url.startswith('http'):
+        content = urlopen_(file_or_url).read()
+    else:
+        with open(file_or_url) as fh:
+            content = fh.read()
+
+    click.echo(f'Validating {file_or_url}')
+
+    try:
+        data = parse_wcmp(content)
+    except Exception as err:
+        raise click.ClickException(err)
+        ctx.exit(1)
+
+    click.echo('Detected WCMP2 discovery metadata')
+    ts = WMOCoreMetadataProfileTestSuite2(data)
+    try:
+        results = ts.run_tests(fail_on_schema_validation,
+                               relax_centre_id_checks)
+    except Exception as err:
+        raise click.ClickException(err)
+        ctx.exit(1)
+
+    click.echo(json.dumps(results, indent=4))
+    ctx.exit(results['summary']['FAILED'])
+
+
+ets.add_command(validate)

pywcmp/kpi.py

@@ -0,0 +1,103 @@
+###############################################################################
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#          Ján Osuský <jan.osusky@iblsoft.com>
+#
+# Copyright (c) 2023 Tom Kralidis
+# Copyright (c) 2022 Government of Canada
+# Copyright (c) 2020 IBL Software Engineering spol. s r. o.
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+###############################################################################
+
+# WMO Core Metadata Profile Key Performance Indicators (KPIs)
+
+import json
+import logging
+
+import click
+
+from pywcmp.ets import WMOCoreMetadataProfileTestSuite2
+from pywcmp.wcmp2.kpi import (
+    WMOCoreMetadataProfileKeyPerformanceIndicators as wcmp_kpis2
+)
+from pywcmp.util import (get_cli_common_options, parse_wcmp, setup_logger,
+                         urlopen_)
+
+LOGGER = logging.getLogger(__name__)
+
+
+@click.group()
+def kpi():
+    """key performance indicators"""
+    pass
+
+
+@click.command()
+@click.pass_context
+@get_cli_common_options
+@click.argument('file_or_url')
+@click.option('--fail-on-ets/--no-fail-on-ets',
+              '-f', default=True, help='Stop the KPI on failing ETS')
+@click.option('--summary', '-s', is_flag=True, default=False,
+              help='Provide summary of KPI test results')
+@click.option('--kpi', '-k', help='KPI to run, default is all')
+def validate(ctx, file_or_url, summary, kpi, logfile, verbosity,
+             fail_on_ets=True):
+    """run key performance indicators"""
+
+    setup_logger(verbosity, logfile)
+
+    if file_or_url.startswith('http'):
+        content = urlopen_(file_or_url).read()
+    else:
+        with open(file_or_url) as fh:
+            content = fh.read()
+
+    click.echo(f'Validating {file_or_url}')
+
+    try:
+        data = parse_wcmp(content)
+    except Exception as err:
+        raise click.ClickException(err)
+        ctx.exit(1)
+
+    if fail_on_ets:
+        ts = WMOCoreMetadataProfileTestSuite2(data)
+        try:
+            _ = ts.run_tests(fail_on_schema_validation=True)
+        except Exception as err:
+            raise click.ClickException(err)
+            ctx.exit(1)
+
+    kpis = wcmp_kpis2(data)
+
+    try:
+        kpis_results = kpis.evaluate(kpi)
+    except ValueError as err:
+        raise click.UsageError(f'Invalid KPI {kpi}: {err}')
+        ctx.exit(1)
+
+    if not summary or kpi is not None:
+        click.echo(json.dumps(kpis_results, indent=4))
+    else:
+        click.echo(json.dumps(kpis_results['summary'], indent=4))
+
+
+kpi.add_command(validate)

pywcmp/pygeoapi_plugin.py

@@ -0,0 +1,290 @@
+###############################################################################
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#
+# Copyright (c) 2026 Tom Kralidis
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+###############################################################################
+
+#
+# pywcmp as a service
+# -------------------
+#
+# This file is intended to be used as a pygeoapi process plugin which will
+# provide pywcmp functionality via OGC API - Processes.
+#
+# To integrate this plugin in pygeoapi:
+#
+# 1. ensure pywcmp is installed into the pygeoapi deployment environment
+#
+# 2. add the processes to the pygeoapi configuration as follows:
+#
+# pywcmp-wis2-wcmp2-ets:
+#     type: process
+#     processor:
+#         name: pywcmp.pygeoapi_plugin.WCMP2ETSProcessor
+#
+# pywcmp-wis2-wcmp2-kpi:
+#     type: process
+#     processor:
+#         name: pywcmp.pygeoapi_plugin.WCMP2KPIProcessor
+#
+# 3. (re)start pygeoapi
+#
+# The resulting processes will be available at the following endpoints:
+#
+# /processes/pywcmp-wis2-wcmp2-ets
+#
+# /processes/pywcmp-wis2-wcmp2-kpi
+#
+# Note that pygeoapi's OpenAPI/Swagger interface (at /openapi) will also
+# provide a developer-friendly interface to test and run requests
+#
+
+
+import json
+import logging
+
+from pygeoapi.process.base import BaseProcessor, ProcessorExecuteError
+
+from pywcmp.wcmp2.ets import WMOCoreMetadataProfileTestSuite2
+from pywcmp.wcmp2.kpi import WMOCoreMetadataProfileKeyPerformanceIndicators
+from pywcmp.util import get_package_version, THISDIR, urlopen_
+
+LOGGER = logging.getLogger(__name__)
+
+with (THISDIR / 'resources' / 'ets-report.json').open() as fh:
+    ETS_REPORT_SCHEMA = json.load(fh)
+
+with (THISDIR / 'resources' / 'kpi-report.json').open() as fh:
+    KPI_REPORT_SCHEMA = json.load(fh)
+
+with (THISDIR / 'resources' / 'example-ca-eccc-msc.nwp-gdps.json').open() as fh:  # noqa
+    EXAMPLE_WCMP2 = json.load(fh)
+
+
+PROCESS_WCMP2_ETS = {
+    'version': get_package_version(),
+    'id': 'pywcmp-wis2-wcmp2-ets',
+    'title': {
+        'en': 'WCMP2 ETS validator'
+    },
+    'description': {
+        'en': 'Validate a WCMP2 document against the ETS'
+    },
+    'keywords': ['wis2', 'wcmp2', 'ets', 'test suite', 'metadata'],
+    'links': [{
+        'type': 'text/html',
+        'rel': 'about',
+        'title': 'information',
+        'href': 'https://wmo-im.github.io/wcmp2',
+        'hreflang': 'en-US'
+    }],
+    'jobControlOptions': ['sync-execute', 'async-execute'],
+    'inputs': {
+        'record': {
+            'title': 'WCMP2 record',
+            'description': 'WCMP2 record (can be inline or remote link)',
+            'schema': {
+                'type': ['object', 'string']
+            },
+            'minOccurs': 1,
+            'maxOccurs': 1,
+            'metadata': None,
+            'keywords': ['wcmp2']
+        },
+        'fail_on_schema_validation': {
+            'title': 'Fail on schema validation',
+            'description': 'Stop the ETS on failing schema validation',
+            'schema': {
+                'type': 'boolean',
+                'default': True
+            },
+            'minOccurs': 0,
+            'maxOccurs': 1,
+            'metadata': None,
+            'keywords': ['schema', 'validation']
+        },
+        'relax_centre_id_checks': {
+            'title': 'Skip centre identifier checks',
+            'description': 'Skip centre identifier checks from failing',
+            'schema': {
+                'type': 'boolean',
+                'default': False
+            },
+            'minOccurs': 0,
+            'maxOccurs': 1,
+            'metadata': None,
+            'keywords': ['centre identifier']
+        }
+    },
+    'outputs': {
+        'result': {
+            'title': 'Report of ETS results',
+            'description': 'Report of ETS results',
+            'schema': {
+                'contentMediaType': 'application/json',
+                **ETS_REPORT_SCHEMA
+            }
+        }
+    },
+    'example': {
+        'inputs': {
+            'record': EXAMPLE_WCMP2,
+            'fail_on_schema_validation': True,
+            'relax_centre_id_checks': False
+        }
+    }
+}
+
+
+PROCESS_WCMP2_KPI = {
+    'version': get_package_version(),
+    'id': 'pywcmp-wis2-wcmp2-kpi',
+    'title': {
+        'en': 'WCMP2 KPI evaluator'
+    },
+    'description': {
+        'en': 'Validate a WCMP2 document against the KPI suite'
+    },
+    'keywords': ['wis2', 'wcmp2', 'kpi', 'test suite', 'metadata'],
+    'links': [{
+        'type': 'text/html',
+        'rel': 'about',
+        'title': 'information',
+        'href': 'https://wmo-im.github.io/wcmp2',
+        'hreflang': 'en-US'
+    }],
+    'jobControlOptions': ['sync-execute', 'async-execute'],
+    'inputs': {
+        'record': {
+            'title': 'WCMP2 record',
+            'description': 'WCMP2 record (can be inline or remote link)',
+            'schema': {
+                'type': ['object', 'string']
+            },
+            'minOccurs': 1,
+            'maxOccurs': 1,
+            'metadata': None,
+            'keywords': ['wcmp2']
+        }
+    },
+    'outputs': {
+        'result': {
+            'title': 'Report of KPI results',
+            'description': 'Report of KPI results',
+            'schema': {
+                'contentMediaType': 'application/json',
+                **KPI_REPORT_SCHEMA
+            }
+        }
+    },
+    'example': {
+        'inputs': {
+            'record': EXAMPLE_WCMP2
+        }
+    }
+}
+
+
+class WCMP2ETSProcessor(BaseProcessor):
+    """WCMP2 ETS"""
+
+    def __init__(self, processor_def):
+        """
+        Initialize object
+
+        :param processor_def: provider definition
+
+        :returns: pywcmp.pygeoapi_plugin.WCMP2ETSProcessor
+        """
+
+        super().__init__(processor_def, PROCESS_WCMP2_ETS)
+
+    def execute(self, data, outputs=None):
+
+        response = None
+        mimetype = 'application/json'
+        record = data.get('record')
+        fail_on_schema_validation = data.get('fail_on_schema_validation', True)
+        relax_centre_id_checks = data.get('relax_centre_id_checks', False)
+
+        if record is None:
+            msg = 'Missing record'
+            LOGGER.error(msg)
+            raise ProcessorExecuteError(msg)
+
+        if isinstance(record, str) and record.startswith('http'):
+            LOGGER.debug('Record is a link')
+            record = json.loads(urlopen_(record).read())
+        else:
+            LOGGER.debug('Record is inline')
+
+        LOGGER.debug('Running ETS against record')
+        response = WMOCoreMetadataProfileTestSuite2(record).run_tests(
+            fail_on_schema_validation=fail_on_schema_validation,
+            relax_centre_id_checks=relax_centre_id_checks)
+
+        return mimetype, response
+
+    def __repr__(self):
+        return '<WCMP2ETSProcessor>'
+
+
+class WCMP2KPIProcessor(BaseProcessor):
+    """WCMP2 KPI"""
+
+    def __init__(self, processor_def):
+        """
+        Initialize object
+
+        :param processor_def: provider definition
+
+        :returns: pywcmp.pygeoapi_plugin.WCMP2KPIProcessor
+        """
+
+        super().__init__(processor_def, PROCESS_WCMP2_KPI)
+
+    def execute(self, data, outputs=None):
+
+        response = None
+        mimetype = 'application/json'
+
+        record = data.get('record')
+
+        if record is None:
+            msg = 'Missing record'
+            LOGGER.error(msg)
+            raise ProcessorExecuteError(msg)
+
+        if isinstance(record, str) and record.startswith('http'):
+            LOGGER.debug('Record is a link')
+            record = json.loads(urlopen_(record).read())
+        else:
+            LOGGER.debug('Record is inline')
+
+        LOGGER.debug('Running KPIs against record')
+        kpis = WMOCoreMetadataProfileKeyPerformanceIndicators(record)
+        response = kpis.evaluate()
+
+        return mimetype, response
+
+    def __repr__(self):
+        return '<WCMP2KPIProcessor>'

pywcmp/resources/dictionary.txt

@@ -0,0 +1,2 @@
+# add custom dictionary words below (one per line)
+# as part of spellchecker functionality