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

>>> client = CkanHighlevelClient('http://127.0.0.1:5000', api_key='e70c15cc-2f07-4845-8c6e-3607df88e905')

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

>>> client.list_datasets()
[]

Let’s create a new dataset:

>>> new_dataset = client.create_dataset(CkanDataset({
...     '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)