Skip to main content

Client for the Ckan API

Project description

This package provides a client for the ckan API.

Specifically, it includes:

  • a low-level client, which is pretty much just a wrapper around HTTP calls, handling serialization and exception-raising.

  • a high-level client, attempting to make it easier / safer to perform certain operations on a ckan catalog.

  • a synchronization client, used to provide some automation for synchronization tasks of collections of datasets into a catalog (commonly referred to as “harvesting”).

Other than that, it attempts to get work around some common issues with that API, such as inconsistencies and bugs, trying to make sure problems are discovered earlier.

Documentation

Documentation is available on Read The Docs:

http://ckan-api-client.readthedocs.org

a mirror copy is currently available on GitHub pages:

https://opendatatrentino.github.io/ckan-api-client/

Example usage

>>> from ckan_api_client.high_level import CkanHighlevelClient
>>> from ckan_api_client.objects import CkanDataset

We don’t have datasets yet on our clean instance:

>>> client.list_datasets()
[]

Let’s create a new dataset:

>>> new_dataset = client.create_dataset({
...     'name': 'example-dataset',
...     'title': 'My example dataset'})

>>> new_dataset
CkanDataset({'maintainer': u'', 'name': u'example-dataset', 'author': u'', 'author_email': u'', 'title': 'My example dataset', 'notes': u'', 'owner_org': None, 'private': False, 'maintainer_email': u'', 'url': u'', 'state': u'active', 'extras': {}, 'groups': [], 'license_id': u'', 'type': u'dataset', 'id': u'dfe41b34-5114-47be-8d94-759f942938fc', 'resources': []})

>>> client.list_datasets()
[u'dfe41b34-5114-47be-8d94-759f942938fc']

Now, let’s change its title:

>>> new_dataset.title = 'NEW TITLE'

>>> client.update_dataset(new_dataset)
CkanDataset({'maintainer': u'', 'name': u'example-dataset', 'author': u'', 'author_email': u'', 'title': 'NEW TITLE', 'notes': u'', 'owner_org': None, 'private': False, 'maintainer_email': u'', 'url': u'', 'state': u'active', 'extras': {}, 'groups': [], 'license_id': u'', 'type': u'dataset', 'id': u'dfe41b34-5114-47be-8d94-759f942938fc', 'resources': []})

Get it back:

>>> client.get_dataset('dfe41b34-5114-47be-8d94-759f942938fc')
(same result as above)

Delete it:

>>> client.wipe_dataset(new_dataset.id)

Trying to get the dataset again will raise a “simulated” 404: Ckan will never delete datasets, it just marks them as “state: deleted”, for administrative users, and returns a 403 for anonymous ones. We want to provide more consistency so we raise an exception.

If you really want to get the deleted dataset, add allow_deleted=True.

>>> client.get_dataset('dfe41b34-5114-47be-8d94-759f942938fc')
HTTPError: HTTPError(404, '(logical) dataset state is deleted', original=None)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckan-api-client-0.1-beta3.tar.gz (53.3 kB view details)

Uploaded Source

File details

Details for the file ckan-api-client-0.1-beta3.tar.gz.

File metadata

File hashes

Hashes for ckan-api-client-0.1-beta3.tar.gz
Algorithm Hash digest
SHA256 f454e59b313a92a0d9643434f3fa599cd2cda50337d293c64b66c47b3dcc1abb
MD5 0abfe9667fd47fea2641538b41baf2f8
BLAKE2b-256 77992dc9a38b0e3b8bc3162c8f28083fef83da1acfd8910808cc33f8f67fad59

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page