--- a/documents/datagov-export.py +++ b/documents/datagov-export.py @@ -2,14 +2,84 @@ import couchdb from ckanclient import CkanApiError import re +import html2text # aaronsw :( +import ckanapi # https://github.com/open-data/ckanapi + + class LoaderError(Exception): pass + +# Instantiate the CKAN client. +#ckan = ckanclient.CkanClient(base_location='http://localhost:5000/api', api_key='b47b24cd-591d-40c1-8677-d73101d56d1b') +api_key = 'b3ab75e4-afbb-465b-a09d-8171c8c69a7a' +ckan = ckanclient.CkanClient(base_location='http://data.disclosurelo.gs/api', + api_key=api_key) +ckandirect = ckanapi.RemoteCKAN('http://data.disclosurelo.gs', api_key=api_key) +couch = couchdb.Server('http://127.0.0.1:5984/') +#couch = couchdb.Server('http://192.168.1.113:5984/') + +# http://code.activestate.com/recipes/578019-bytes-to-human-human-to-bytes-converter/ +SYMBOLS = { + 'customary': ('B', 'KB', 'MB', 'GB', 'T', 'P', 'E', 'Z', 'Y'), + 'customary_ext': ('byte', 'kilo', 'mega', 'giga', 'tera', 'peta', 'exa', + 'zetta', 'iotta'), + 'iec': ('Bi', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi', 'Yi'), + 'iec_ext': ('byte', 'kibi', 'mebi', 'gibi', 'tebi', 'pebi', 'exbi', + 'zebi', 'yobi'), +} + + +def human2bytes(s): + """ + Attempts to guess the string format based on default symbols + set and return the corresponding bytes as an integer. + When unable to recognize the format ValueError is raised. + + >>> human2bytes('0 B') + 0 + >>> human2bytes('1 K') + 1024 + >>> human2bytes('1 M') + 1048576 + >>> human2bytes('1 Gi') + 1073741824 + >>> human2bytes('1 tera') + 1099511627776 + + >>> human2bytes('0.5kilo') + 512 + >>> human2bytes('0.1 byte') + 0 + >>> human2bytes('1 k') # k is an alias for K + 1024 + >>> human2bytes('12 foo') + Traceback (most recent call last): + ... + ValueError: can't interpret '12 foo' + """ + init = s + num = "" + while s and s[0:1].isdigit() or s[0:1] == '.': + num += s[0] + s = s[1:] + num = float(num) + letter = s.strip() + for name, sset in SYMBOLS.items(): + if letter in sset: + break + else: + if letter == 'k': + # treat 'k' as an alias for 'K' as per: http://goo.gl/kTQMs + sset = SYMBOLS['customary'] + letter = letter.upper() + else: + raise ValueError("can't interpret %r" % init) + prefix = {sset[0]: 1} + for i, s in enumerate(sset[1:]): + prefix[s] = 1 << (i + 1) * 10 + return int(num * prefix[letter]) + # https://github.com/okfn/ckanext-importlib -# Instantiate the CKAN client. -ckan = ckanclient.CkanClient(base_location='http://localhost:5000/api', - api_key='b47b24cd-591d-40c1-8677-d73101d56d1b') -# (use your own api_key from http://thedatahub.org/user/me ) - def munge(name): # convert spaces to underscores name = re.sub(' ', '_', name).lower() @@ -21,38 +91,172 @@ # remove double underscores name = re.sub('__', '_', name).lower() return name + + def name_munge(input_name): return munge(input_name.replace(' ', '').replace('.', '_').replace('&', 'and')) - #return input_name.replace(' ', '').replace('.', '_').replace('&', 'and') - -couch = couchdb.Server('http://127.0.0.1:5984/') + + +def get_licence_id(licencename): + map = { + "Creative Commons - Attribution-Share Alike 2.0 Australia (CC-SA)\nThe downloadable version of the database is licensed under CC-BY-SA Creative Commons Attribution Share Alike and contains only the database fields that are released under that license. These fields are object title, object number, object description as well as temporal, spatial and dimension details. It also contains a persistent URL for each record.": 'cc-by-sa', + "CreativeCommonsAttributionNonCommercial30AustraliaCCBYNC30": 'cc-nc', + 'Otherpleasespecify': 'notspecified', + '': 'notspecified', + "Publicly available data": 'notspecified', + "CreativeCommonsAttributionNoDerivativeWorks30AustraliaCCBYND30": "other-closed", + "CreativeCommonsAttributionNonCommercialNoDerivs30AustraliaCCBYNCND30": "other-closed", + 'CreativeCommonsAttribution30AustraliaCCBY30': 'cc-by', + "Creative Commons - Attribution 2.5 Australia (CC-BY)": 'cc-by', + 'CreativeCommonsAttributionCCBY25': 'cc-by', + "PublicDomain": 'other-pd', + } + if licencename not in map.keys(): + raise Exception(licencename + " not found"); + return map[licencename]; + + docsdb = couch['disclosr-documents'] if __name__ == "__main__": + orgs_list = [] + orgs_ids = {} for doc in docsdb.view('app/datasets'): + print " --- " print doc.id - if doc.value['url'] != "http://data.gov.au/data/": + + if doc.value['url'] != "http://data.gov.au/data/" and doc.value['agencyID'] != "qld": + + # Collect the package metadata. - pkg_name = name_munge(doc.value['metadata']['DCTERMS.Title'][:100]) - package_entity = { - 'name': pkg_name, - 'title': doc.value['metadata']['DCTERMS.Title'], - 'url': doc.value['metadata']['DCTERMS.Source.URI'], - 'tags': doc.value['metadata']["Keywords / Tags"], #todo must be alphanumeric characters or symbols - - 'author': doc.value['metadata']["DCTERMS.Creator"], - 'maintainer': doc.value['metadata']["DCTERMS.Creator"], - 'licence_id': doc.value['metadata']['DCTERMS.License'], - 'notes': doc.value['metadata']['Description'], + pkg_name = filter(lambda x: x in '0123456789abcdefghijklmnopqrstuvwxyz-_', + doc.value['url'].replace("http://data.gov.au/dataset/", '').replace('/', '')[:100]); + print pkg_name + #add to or create organization using direct API + org_name = name_munge(doc.value['metadata']["Agency"][:100]) + if org_name not in orgs_list: + orgs_list = ckandirect.action.organization_list()['result'] + #print orgs_list + if org_name not in orgs_list: + try: + print "org not found, creating " + org_name + ckandirect.action.organization_create(name=org_name, title=doc.value['metadata']["Agency"], + description=doc.value['metadata']["Agency"]) + orgs_list.append(org_name) + except ckanapi.ValidationError, e: + print e + raise LoaderError('Unexpected status') + else: + print "org found, adding dataset to " + org_name + + # cache org names -> id mapping + if org_name not in orgs_ids: + org = ckandirect.action.organization_show(id=org_name) + orgs_ids[org_name] = org["result"]["id"] + org_id = orgs_ids[org_name] + print "org id is "+org_id + tags = [] + if doc.value['agencyID'] == "AGIMO": + if len(doc.value['metadata']["Keywords / Tags"]) > 0: + if hasattr(doc.value['metadata']["Keywords / Tags"], '__iter__'): + tags = tags + doc.value['metadata']["Keywords / Tags"] + else: + tags = tags + [doc.value['metadata']["Keywords / Tags"]] + + tags = [re.sub('[^a-zA-Z0-9-_.]', '', tag.replace('&', 'and')).lower() for tag in tags if tag] + #print tags + package_entity = { + 'name': pkg_name, + 'title': doc.value['metadata']['DCTERMS.Title'], + 'url': doc.value['metadata']['DCTERMS.Source.URI'], + 'tags': tags, #tags are mandatory? + 'author': doc.value['metadata']["DCTERMS.Creator"], + 'maintainer': doc.value['metadata']["DCTERMS.Creator"], + 'licence_id': get_licence_id(doc.value['metadata']['DCTERMS.License']), + 'notes': html2text.html2text(doc.value['metadata']['Description']), + 'owner_org': org_id + #todo add missing key values like jurasdiction } + if doc.value['agencyID'] == "qld": + package_entity = doc.value['metadata'] + try: + #print package_entity ckan.package_register_post(package_entity) except CkanApiError, e: - if ckan.last_status == 409: - print "already exists" + if ckan.last_message == "{\"name\": [\"That URL is already in use.\"]}": + print "package already exists" else: - raise LoaderError('Unexpected status %s checking for package under \'%s\': %r' % (ckan.last_status, doc.id, e.args)) - - print package_entity - ckan.add_package_resource(pkg_name, 'http://example.org/', name='Foo', resource_type='data', format='csv') - + print ckan.last_message + raise LoaderError('Unexpected status %s checking for package under \'%s\': %r' % ( + ckan.last_status, pkg_name, e.args)) + pkg = ckan.package_entity_get(pkg_name) + + # add dataset to group(s) + groups = [] + if 'data.gov.au Category' in doc.value['metadata'].keys() and len( + doc.value['metadata']['data.gov.au Category']) > 0: + if hasattr(doc.value['metadata']['data.gov.au Category'], '__iter__'): + groups = groups + doc.value['metadata']['data.gov.au Category'] + else: + groups = groups + [doc.value['metadata']['data.gov.au Category']] + + for group_name in groups: + group_url = name_munge(group_name[:100]) + try: + # Update the group details + group_entity = ckan.group_entity_get(group_url) + print "group "+group_name+" exists" + if 'packages' in group_entity.keys(): + group_entity['packages'] = list(set(group_entity['packages'] + [pkg_name])) + else: + group_entity['packages'] = [pkg_name] + ckan.group_entity_put(group_entity) + except CkanApiError, e: + if ckan.last_status == 404: + print "group "+group_name+" does not exist, creating" + group_entity = { + 'name': group_url, + 'title': group_name, + 'description': group_name, + 'packages': [pkg_name] + } + #print group_entity + ckan.group_register_post(group_entity) + elif ckan.last_status == 409: + print "group already exists" + else: + raise LoaderError('Unexpected status %s adding to group under \'%s\': %r' % ( + ckan.last_status, pkg_name, e.args)) + + # add resources (downloadable data files) + if 'Download' in doc.value['metadata'].keys(): + try: + + resources = pkg.get('resources', []) + if len(resources) < len(doc.value['metadata']['Download']): + for resource in doc.value['metadata']['Download']: + + # http://docs.ckan.org/en/ckan-1.7/domain-model-resource.html + # (KML/KMZ) / (Shapefile) /(Other) + format = "plain" + if resource['format'] == '(XML)': + format = 'xml' + if resource['format'] == '(CSV/XLS)': + format = 'csv' + name = resource['href'] + if 'name' in resource.keys(): + name = resource['name'] + print resource + ckan.add_package_resource(pkg_name, resource['href'], name=name, resource_type='data', + format=format, + size=human2bytes(resource['size'].replace(',', ''))) + else: + print "resources already exist" + except CkanApiError, e: + if ckan.last_status == 404: + print "parent dataset does not exist" + else: + raise LoaderError('Unexpected status %s checking for package under \'%s\': %r' % ( + ckan.last_status, pkg_name, e.args)) +