The CKAN client Python package.

Overview

The CKAN client software may be used to make requests on the Comprehensive
Knowledge Archive Network (CKAN) REST API.

  1. Synopsis ##

The simplest way to make CKAN requests is:

import ckanclient
  1. Instantiate the CKAN client.
    ckan = ckanclient.CkanClient(api_key=my_key)
  1. Get the package list.
    ckan.package_register_get()
    package_list = ckan.last_message
    print package_list
  1. Get the tag list.
    ckan.tag_register_get()
    tag_list = ckan.last_message
    print tag_list
  1. Collect the package metadata.
    package_entity = {
    ‘name’: my_package_name,
    ‘url’: my_package_url,
    ‘download_url’: my_package_download_url,
    ‘tags’: my_package_keywords,
    ‘notes’: my_package_long_description,
    }
  1. Register the package.
    ckan.package_register_post(package_entity)
  1. Get the details of a package.
    ckan.package_entity_get(package_name)
    package_entity = ckan.last_message
    print package_entity
  1. Update the details of a package.
    ckan.package_entity_get(package_name)
    package_entity = ckan.last_message
    package_entity[‘url’] = new_package_url
    package_entity[‘notes’] = new_package_notes
    ckan.package_entity_post(package_entity)