pywmdr 0.2.dev0__tar.gz

pywmdr-0.2.dev0/LICENSE.md

@@ -0,0 +1,24 @@
+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.

pywmdr-0.2.dev0/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: pywmdr
+Version: 0.2.dev0
+Summary: A Python implementation of the test suite for WIGOS Metadata Record
+Author-email: Tom Kralidis <tomkralidis@gmail.com>
+Maintainer-email: Tom Kralidis <tomkralidis@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: homepage, https://github.com/wmo-im/pywmdr
+Project-URL: source, https://github.com/wmo-im/pywmdr
+Project-URL: documentation, https://github.com/wmo-im/pywmdr
+Project-URL: issues, https://github.com/wmo-im/pywmdr/issues
+Keywords: wmo,wigos,station metadata,test suite
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: click
+Requires-Dist: jsonschema
+Requires-Dist: rfc3339-validator
+Requires-Dist: rfc3987
+Requires-Dist: shapely
+Provides-Extra: dev
+Requires-Dist: flake8; extra == "dev"
+Provides-Extra: release
+Requires-Dist: build; extra == "release"
+Requires-Dist: twine; extra == "release"
+Requires-Dist: wheel; extra == "release"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# pywmdr
+
+[![Build Status](https://github.com/wmo-im/pywmdr/workflows/build%20%E2%9A%99%EF%B8%8F/badge.svg)](https://github.com/wmo-im/pywmdr/actions)
+
+# WIGOS Metadata Record Test Suite
+
+pywmdr provides validation and quality assessment capabilities for the [WIGOS Metadata Record](https://wmo-im.github.io/wmdr2) (WMDR2) standard.
+
+- validation against [WMDR2](https://wmo-im.github.io/wmdr2/standard/wmdr2-DRAFT.html), specifically [Annex A: Conformance Class Abstract Test Suite](https://wmo-im.github.io/wmdr2/standard/wmdr2-DRAFT.html#_conformance_class_abstract_test_suite_normative)), implementing an executable test suite against the ATS
+
+## Installation
+
+### pip
+
+Install latest stable version from [PyPI](https://pypi.org/project/pywmdr).
+
+```bash
+pip3 install pywmdr
+```
+
+### From source
+
+Install latest development version.
+
+```bash
+python3 -m venv pywmdr
+cd pywmdr
+. bin/activate
+git clone https://github.com/wmo-im/pywmdr.git
+cd pywmdr
+pip3 install .
+```
+
+## Running
+
+From command line:
+```bash
+# fetch version
+pywmdr --version
+
+# sync supporting configuration bundle (schemas, topics, etc.)
+pywmdr bundle sync
+
+# abstract test suite
+
+# validate WMDR2 metadata against abstract test suite (file on disk)
+pywmdr ets validate /path/to/file.json
+
+# validate WMDR2 metadata against abstract test suite (URL)
+pywmdr ets validate https://example.org/path/to/file.json
+
+# validate WMDR2 metadata against abstract test suite (URL), but turn JSON Schema validation off
+pywmdr ets validate https://example.org/path/to/file.json --no-fail-on-schema-validation
+
+# adjust debugging messages (CRITICAL, ERROR, WARNING, INFO, DEBUG) to stdout
+pywmdr ets validate https://example.org/path/to/file.json --verbosity DEBUG
+
+# write results to logfile
+pywmdr ets validate https://example.org/path/to/file.json --verbosity DEBUG --logfile /tmp/foo.txt
+```
+
+## Using the API
+```pycon
+>>> # test a file on disk
+>>> import json
+>>> from pywmdr.wmdr2.ets import WIGOSMetadataRepresentationTestSuite2
+>>> from pywmdr.errors import TestSuiteError
+>>> with open('/path/to/file.json') as fh:
+...     data = json.load(fh)
+>>> # test ETS
+>>> ts = WMOCoreMetadataProfileTestSuite2(datal)
+>>> ts.run_tests()
+>>> ts.raise_for_status()  # raises pywmdr.errors.TestSuiteError on exception with list of errors captured in .errors property
+>>> # test a URL
+>>> from urllib2 import urlopen
+>>> from StringIO import StringIO
+>>> content = StringIO(urlopen('https://....').read())
+>>> data = json.loads(content)
+>>> ts = WMOCoreMetadataProfileTestSuite2(data)
+>>> ts.run_tests()
+>>> ts.raise_for_status()  # raises pywmdr.errors.TestSuiteError on exception with list of errors captured in .errors property
+```
+
+## Development
+
+```bash
+python3 -m venv pywmdr
+cd pywmdr
+source bin/activate
+git clone https://github.com/World-Meteorological-Organization/pywmdr.git
+pip3 install .
+pip3 install ".[dev]"
+```
+
+### Running tests
+
+```bash
+pytest tests
+```
+
+## Releasing
+
+```bash
+# create release (x.y.z is the release version)
+vi pyproject.toml  # update [project]/version
+git commit -am 'update release version x.y.z'
+git push origin master
+git tag -a x.y.z -m 'tagging release version x.y.z'
+git push --tags
+
+# upload to PyPI
+rm -fr build dist *.egg-info
+python3 -m build
+twine upload dist/*
+
+# publish release on GitHub (https://github.com/wmo-im/pywmdr/releases/new)
+
+# bump version back to dev
+vi pyproject.toml  # update [project]/version
+git commit -am 'back to dev'
+git push origin master
+```
+
+## Code Conventions
+
+[PEP8](https://www.python.org/dev/peps/pep-0008)
+
+## Issues
+
+Issues are managed at https://github.com/wmo-im/pywmdr/issues
+
+## Contact
+
+* [Tom Kralidis](https://github.com/tomkralidis)

pywmdr-0.2.dev0/README.md

@@ -0,0 +1,134 @@
+# pywmdr
+
+[![Build Status](https://github.com/wmo-im/pywmdr/workflows/build%20%E2%9A%99%EF%B8%8F/badge.svg)](https://github.com/wmo-im/pywmdr/actions)
+
+# WIGOS Metadata Record Test Suite
+
+pywmdr provides validation and quality assessment capabilities for the [WIGOS Metadata Record](https://wmo-im.github.io/wmdr2) (WMDR2) standard.
+
+- validation against [WMDR2](https://wmo-im.github.io/wmdr2/standard/wmdr2-DRAFT.html), specifically [Annex A: Conformance Class Abstract Test Suite](https://wmo-im.github.io/wmdr2/standard/wmdr2-DRAFT.html#_conformance_class_abstract_test_suite_normative)), implementing an executable test suite against the ATS
+
+## Installation
+
+### pip
+
+Install latest stable version from [PyPI](https://pypi.org/project/pywmdr).
+
+```bash
+pip3 install pywmdr
+```
+
+### From source
+
+Install latest development version.
+
+```bash
+python3 -m venv pywmdr
+cd pywmdr
+. bin/activate
+git clone https://github.com/wmo-im/pywmdr.git
+cd pywmdr
+pip3 install .
+```
+
+## Running
+
+From command line:
+```bash
+# fetch version
+pywmdr --version
+
+# sync supporting configuration bundle (schemas, topics, etc.)
+pywmdr bundle sync
+
+# abstract test suite
+
+# validate WMDR2 metadata against abstract test suite (file on disk)
+pywmdr ets validate /path/to/file.json
+
+# validate WMDR2 metadata against abstract test suite (URL)
+pywmdr ets validate https://example.org/path/to/file.json
+
+# validate WMDR2 metadata against abstract test suite (URL), but turn JSON Schema validation off
+pywmdr ets validate https://example.org/path/to/file.json --no-fail-on-schema-validation
+
+# adjust debugging messages (CRITICAL, ERROR, WARNING, INFO, DEBUG) to stdout
+pywmdr ets validate https://example.org/path/to/file.json --verbosity DEBUG
+
+# write results to logfile
+pywmdr ets validate https://example.org/path/to/file.json --verbosity DEBUG --logfile /tmp/foo.txt
+```
+
+## Using the API
+```pycon
+>>> # test a file on disk
+>>> import json
+>>> from pywmdr.wmdr2.ets import WIGOSMetadataRepresentationTestSuite2
+>>> from pywmdr.errors import TestSuiteError
+>>> with open('/path/to/file.json') as fh:
+...     data = json.load(fh)
+>>> # test ETS
+>>> ts = WMOCoreMetadataProfileTestSuite2(datal)
+>>> ts.run_tests()
+>>> ts.raise_for_status()  # raises pywmdr.errors.TestSuiteError on exception with list of errors captured in .errors property
+>>> # test a URL
+>>> from urllib2 import urlopen
+>>> from StringIO import StringIO
+>>> content = StringIO(urlopen('https://....').read())
+>>> data = json.loads(content)
+>>> ts = WMOCoreMetadataProfileTestSuite2(data)
+>>> ts.run_tests()
+>>> ts.raise_for_status()  # raises pywmdr.errors.TestSuiteError on exception with list of errors captured in .errors property
+```
+
+## Development
+
+```bash
+python3 -m venv pywmdr
+cd pywmdr
+source bin/activate
+git clone https://github.com/World-Meteorological-Organization/pywmdr.git
+pip3 install .
+pip3 install ".[dev]"
+```
+
+### Running tests
+
+```bash
+pytest tests
+```
+
+## Releasing
+
+```bash
+# create release (x.y.z is the release version)
+vi pyproject.toml  # update [project]/version
+git commit -am 'update release version x.y.z'
+git push origin master
+git tag -a x.y.z -m 'tagging release version x.y.z'
+git push --tags
+
+# upload to PyPI
+rm -fr build dist *.egg-info
+python3 -m build
+twine upload dist/*
+
+# publish release on GitHub (https://github.com/wmo-im/pywmdr/releases/new)
+
+# bump version back to dev
+vi pyproject.toml  # update [project]/version
+git commit -am 'back to dev'
+git push origin master
+```
+
+## Code Conventions
+
+[PEP8](https://www.python.org/dev/peps/pep-0008)
+
+## Issues
+
+Issues are managed at https://github.com/wmo-im/pywmdr/issues
+
+## Contact
+
+* [Tom Kralidis](https://github.com/tomkralidis)

pywmdr-0.2.dev0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pywmdr"
+version = "0.2.dev0"
+description = "A Python implementation of the test suite for WIGOS Metadata Record"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE.md"]
+keywords = ["wmo", "wigos", "station metadata", "test suite"]
+authors = [
+    {name = "Tom Kralidis", email = "tomkralidis@gmail.com"}
+]
+maintainers = [
+    {name = "Tom Kralidis", email = "tomkralidis@gmail.com"}
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Topic :: Scientific/Engineering :: Atmospheric Science",
+    "Topic :: Scientific/Engineering :: GIS"
+]
+dependencies = [
+    "click",
+    "jsonschema",
+    "rfc3339-validator",
+    "rfc3987",
+    "shapely"
+]
+
+[project.optional-dependencies]
+dev = ["flake8"]
+release = ["build", "twine", "wheel"]
+test = ["pytest"]
+
+[project.scripts]
+pywmdr = "pywmdr:cli"
+
+[project.urls]
+homepage = "https://github.com/wmo-im/pywmdr"
+source = "https://github.com/wmo-im/pywmdr"
+documentation = "https://github.com/wmo-im/pywmdr"
+issues = "https://github.com/wmo-im/pywmdr/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+exclude = ["tests*"]
+
+[tool.setuptools.package-data]
+"pywmdr" = ["*.json", "**/*.json"]

pywmdr-0.2.dev0/pywmdr/__init__.py

@@ -0,0 +1,42 @@
+###############################################################################
+#
+# 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.
+#
+###############################################################################
+
+import click
+
+from pywmdr.record import record
+from pywmdr.bundle import bundle
+from pywmdr.util import get_package_version
+
+__version__ = get_package_version()
+
+
+@click.group()
+@click.version_option(version=__version__)
+def cli():
+    pass
+
+
+cli.add_command(bundle)
+cli.add_command(record)

pywmdr-0.2.dev0/pywmdr/bundle.py

@@ -0,0 +1,75 @@
+##############################################################################
+#
+# 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 logging
+from pathlib import Path
+import shutil
+import tempfile
+
+import click
+
+from pywmdr import cli_options
+from pywmdr.util import get_userdir, urlopen_
+
+LOGGER = logging.getLogger(__name__)
+
+USERDIR = get_userdir()
+
+TEMPDIR = tempfile.TemporaryDirectory()
+TEMPDIR2 = Path(tempfile.TemporaryDirectory().name)
+
+WMDR2_FILES = get_userdir() / 'wmdr2'
+WMDR2_FILES_TEMP = TEMPDIR2 / 'wmdr2'
+
+
+@click.group()
+def bundle():
+    """Configuration bundle management"""
+    pass
+
+
+@click.command()
+@click.pass_context
+@cli_options.OPTION_VERBOSITY
+def sync(ctx, verbosity):
+    """Sync configuration bundle"""
+
+    LOGGER.debug('Caching schema')
+    LOGGER.debug(f'Downloading WMDR2 schema to {WMDR2_FILES_TEMP}')
+    WMDR2_FILES_TEMP.mkdir(parents=True, exist_ok=True)
+    WMDR2_SCHEMA = 'https://raw.githubusercontent.com/wmo-im/wmdr2/refs/heads/main/schemas/wmdr2-bundled.json'  # noqa
+
+    json_schema = WMDR2_FILES_TEMP / 'wmdr2-bundled.json'
+    with json_schema.open('wb') as fh:
+        fh.write(urlopen_(f'{WMDR2_SCHEMA}').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)

pywmdr-0.2.dev0/pywmdr/cli_options.py

@@ -0,0 +1,45 @@
+##############################################################################
+#
+# 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 logging
+import sys
+
+import click
+
+
+def OPTION_VERBOSITY(f):
+    logging_options = ['ERROR', 'WARNING', 'INFO', 'DEBUG']
+
+    def callback(ctx, param, value):
+        value2 = value or 'INFO'
+        logging.basicConfig(stream=sys.stdout,
+                            level=getattr(logging, value2))
+        return True
+
+    return click.option('--verbosity', '-v',
+                        type=click.Choice(logging_options),
+                        help='Verbosity',
+                        callback=callback)(f)
+
+
+def cli_callbacks(f):
+    f = OPTION_VERBOSITY(f)
+    return f

pywmdr-0.2.dev0/pywmdr/errors.py

@@ -0,0 +1,27 @@
+##############################################################################
+#
+# 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