Metadata-Version: 1.0
Name: ckanclient
Version: 0.2
Summary: The CKAN client Python package.
Home-page: http://www.okfn.org/ckan/
Author: Appropriate Software Foundation, Open Knowledge Foundation
Author-email: info@okfn.org
License: MIT
Description: The CKAN client software may be used to make requests on the Comprehensive
        Knowledge Archive Network (CKAN) API including its REST interface to all
        primary objects (packages, groups, tags) and its search interface.
        
        Synopsis
        ========
        
        The simplest way to make CKAN requests is:
        
        import ckanclient
        
        # Instantiate the CKAN client.
        ckan = ckanclient.CkanClient(api_key=my_key)
        
        # Get the package list.
        package_list = ckan.package_register_get()
        print package_list
        
        # Get the tag list.
        tag_list = ckan.tag_register_get()
        print tag_list
        
        # 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,
        }
        
        # Register the package.
        ckan.package_register_post(package_entity)
        
        # Get the details of a package.
        ckan.package_entity_get(package_name)
        package_entity = ckan.last_message
        print package_entity
        
        # 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_put(package_entity)
        
        # List groups
        group_list = ckan.group_register_get()
        print group_list
        
        # Create a new group
        group_entity = {
        'name': my_group_name,
        'title': my_group_title,
        'description': my_group_description,
        'packages': group_package_names,
        }
        ckan.group_register_post(group_entity)
        
        # Get the details of a group.
        print ckan.group_entity_get(group_name)
        
        # Update the group details
        group_entity = ckan.last_message
        group_entity['title'] = new_group_title
        group_entity['packages'] = new_group_packages
        ckan.group_entity_put(group_entity)
        
        Changelog
        =========
        
        v0.2 2009-11-05
        ---------------
        
        * Search API support added
        * Improved package support to include additional fields such as 'extras'
        * Support tag and group entities in addition to package
        * Compatibility changes: CkanClient base_location (now should point to base
        api (e.g. http://ckan.net/api rather than http://ckan.net/api/rest)
        
        
        v0.1 2008-04
        ------------
        
        * Fully functional implementation for REST interface to packages
        
Keywords: data packaging component tool client
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
