Metadata-Version: 2.1
Name: pywcmp
Version: 0.2.0
Summary: A Python implementation of the test suite for WMO Core Metadata Profile
Home-page: https://github.com/wmo-im/pywcmp
Author: Tom Kralidis
Author-email: tomkralidis@gmail.com
Maintainer: Tom Kralidis
Maintainer-email: tomkralidis@gmail.com
License: MIT
Description: [![Build Status](https://github.com/wmo-im/pywcmp/workflows/build%20%E2%9A%99%EF%B8%8F/badge.svg)](https://github.com/wmo-im/pywcmp/actions)
        
        # WMO Core Metadata Profile Test Suite
        
        This library implements validation against [WMO Core Metadata Profile 1.3](http://wis.wmo.int/2013/metadata/version_1-3-0/WMO_Core_Metadata_Profile_v1.3_Part_1.pdf), specifically [Part 2](http://wis.wmo.int/2013/metadata/version_1-3-0/WMO_Core_Metadata_Profile_v1.3_Part_2.pdf), Section 2.
        
        ## Installation
        
        ```bash
        python3 -m venv pywcmp
        cd pywcmp
        . bin/activate
        git clone https://github.com/wmo-im/pywcmp.git
        cd pywcmp
        pip3 install -r requirements.txt
        python3 setup.py build
        python3 setup.py install
        ```
        
        ## Running
        
        From command line:
        ```bash
        # fetch version
        pywcmp --version
        
        # abstract test suite
        
        # validate metadata against abstract test suite (file on disk)
        pywcmp ats validate --file /path/to/file.xml
        
        # validate metadata against abstract test suite (URL)
        pywcmp ats validate --url http://example.org/path/to/file.xml
        
        # adjust debugging messages (CRITICAL, ERROR, WARNING, INFO, DEBUG) to stdout
        pywcmp ats validate --url http://example.org/path/to/file.xml --verbosity DEBUG
        
        # write results to logfile
        pywcmp ats validate --url http://example.org/path/to/file.xml --verbosity DEBUG --logfile /tmp/foo.txt
        
        # key performance indicators # note: running KPIs automatically runs the ats
        pywcmp kpi validate --url http://example.org/path/to/file.xml --verbosity DEBUG
        ```
        
        ## Using the API
        ```pycon
        # test a file on disk
        >>> from lxml import etree
        >>> from pywcmp.ats import ats
        >>> exml = etree.parse('/path/to/file.xml')
        >>> ts = ats.WMOCoreMetadataProfileTestSuite13(exml)
        >>> ts.run_tests()  # raises ValueError error stack on exception
        # test a URL
        >>> from urllib2 import urlopen
        >>> from StringIO import StringIO
        >>> content = StringIO(urlopen('http://....').read())
        >>> exml = etree.parse(content)
        >>> ts = ats.WMOCoreMetadataProfileTestSuite13(exml)
        >>> ts.run_tests()  # raises ValueError error stack on exception
        # handle ats.TestSuiteError
        # ats.TestSuiteError.errors is a list of errors
        >>> try:
        ...    ts.run_tests()
        ... except ats.TestSuiteError as err:
        ...    print('\n'.join(err.errors))
        >>> ...
        >>> from pywcmp.kpi import WMOCoreMetadataProfileKeyPerformanceIndicators
        >>> kpis = WMOCoreMetadataProfileKeyPerformanceIndicators(exml)
        >>> kpis['totals']
        ```
        
        ## Development
        
        ```bash
        python3 -m venv pywcmp
        cd pywcmp
        source bin/activate
        git clone https://github.com/wmo-im/pywcmp.git
        pip3 install -r requirements.txt
        pip3 install -r requirements-dev.txt
        python3 setup.py install
        ```
        
        ### Running tests
        
        ```bash
        # via setuptools
        python3 setup.py test
        # manually
        python3 tests/run_tests.py
        ```
        
        ## Releasing
        
        ```bash
        python3 setup.py sdist bdist_wheel --universal
        twine upload dist/*
        ```
        
        ## Code Conventions
        
        [PEP8](https://www.python.org/dev/peps/pep-0008)
        
        ## Issues
        
        Issues are managed at https://github.com/wmo-im/pywcmp/issues
        
        ## Contact
        
        * [Tom Kralidis](https://github.com/tomkralidis)
Keywords: WMO Metadata WIS Test Suite
Platform: all
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: GIS
Description-Content-Type: text/markdown
