Metadata-Version: 1.1
Name: metadown
Version: 0.2
Summary: A Python library for collecting Met/Ocean metadata from various services
Home-page: https://github.com/asascience-open/metadown
Author: Kyle Wilcox
Author-email: kwilcox@sasascience.com
License: GPLv3
Description: metadown
        ========
        
        A programatic collector/downloader for IOOS like 19115-2 metadata written in Python.
        
        Services supported:
        
        * [THREDDS](http://www.unidata.ucar.edu/projects/THREDDS/) (ISO service must be enabled)
        * [GeoNetwork](http://geonetwork-opensource.org/)
        
        ## Installation
        
        metadown is available on pypi and is easiest installed using `pip`.
        
        ```bash
        pip install metadown
        ```
        `lxml`, `requests`, and `thredds_crawler` will be installed automatically
        
        ## Usage
        
        ### THREDDS
        
        The ThreddsCollector can take two optional arguments. Both are strongly suggested so you don't crawl an
        entire THREDDS server (unless that is what you want to do).
        
        * `selects` (list) - Select datasets based on their THREDDS ID. Python regex is supported.
        * `skips` (list) - Skip datasets based on their name and catalogRefs based on their xlink:title. By default, the crawler uses four regular expressions to skip lists of thousands upon thousands of individual files that are part of aggregations or FMRCs (they are below.)  Setting the `skip` parameter to anything other than a superset of the defaults below runs the risk of having some angry system admins after you.
        
          *  `.\*files/`
          *  `.\*Individual Files.\*`
          *  `.\*File_Access.\*`
          *  `.\*Forecast Model Run.\*`
            
        ```python
        from metadown.collectors.thredds import ThreddsCollector
        
        selects = [".*SST-Agg"]
        tc = ThreddsCollector("http://tds.glos.us:8080/thredds/mtri/aoc.html", selects=selects)
        metadata_urls = tc.run()
        print metadata_urls
        [
         'http://tds.glos.us:8080/thredds/iso/SST/LakeErieSST-Agg',
         'http://tds.glos.us:8080/thredds/iso/SST/LakeHuronSST-Agg', 
         'http://tds.glos.us:8080/thredds/iso/SST/LakeMichiganSST-Agg', 
         'http://tds.glos.us:8080/thredds/iso/SST/LakeOntarioSST-Agg', 
         'http://tds.glos.us:8080/thredds/iso/SST/LakeSuperiorSST-Agg'
        ]
        ```
        
        ### GeoNetwork
        
        ```python
        from metadown.collectors.geonetwork import GeoNetworkCollector
        
        gnc = GeoNetworkCollector("http://data.glos.us/metadata")
        metadata_urls = gnc.run()
        print metadata_urls
        [
         ...
         'http://data.glos.us/metadata/srv/en/iso19139.xml?id=39848', 
         'http://data.glos.us/metadata/srv/en/iso19139.xml?id=39846', 
         'http://data.glos.us/metadata/srv/en/iso19139.xml?id=39845'
        ]
        ```
        
        
        ### Downloading resulting ISO files
        
        Once you have the metadata urls for the data you want, do whatever you want!
        If you would like to rename or modify the metadata files, there is a helper class called `XmlDownloader`
        
        XmlDownloader takes in three parameters:
        
        * `url_list` (required) - a list of URLs
        * `download_path` (required) - folder to download files to on your local machine
        * `namer` (optional) - a python function for renaming the metadata files before saving them to your local machine.  It should take in a single url and return a string filename for the url to be saved as.
            
            Example `namer` function that renames GeoNetwork URLs
            ```python
            from urlparse import urlsplit
            def geonetwork_renamer(url, **kwargs):
                uid = urlsplit(url).query
                uid = uid[uid.index("=")+1:]
                return "GeoNetwork-" + uid + ".xml"
            ``` 
        
        * `modifier` (optional) - a python function for full control over the metadata content.  It should take in a single url and return a `str` representation of ISO19115-2.
        
            Example `modifier` function that translates GeoNetwork's ISO19139 to ISO19115-2
            ```python
            from metadown.utils.etree import etree
            def geonetwork_modifier(url, **kwargs):
                gmi_ns = "http://www.isotc211.org/2005/gmi"
                etree.register_namespace("gmi",gmi_ns)
                new_root = etree.Element("{%s}MI_Metadata" % gmi_ns)
                old_root = etree.parse(url).getroot()
                # carry over an attributes we need
                [new_root.set(k,v) for k,v in old_root.attrib.items()]
                # carry over children
                [new_root.append(e) for e in old_root]
                return etree.tostring(new_root, encoding="UTF-8", pretty_print=True, xml_declaration=True)
            ```
        
        ```python
        from metadown.downloader import XmlDownloader
        XmlDownloader.run(metadata_urls, download_directory, namer=geonetwork_renamer, modifier=geonetwork_modifier)
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
