High-level

class ckan_api_client.high_level.CkanHighlevelClient(base_url, api_key=None, fail_on_inconsistency=False)

High-level client, handling CRUD of objects.

This class only returns / handles CkanObjects, to make sure we are handling consistent data (they have validators in place)

Parameters:

• base_url – Base URL for the Ckan instance.
• api_key – API key to be used when accessing Ckan. This is required for writing.
• fail_on_inconsistency – Whether to fail on “inconsistencies” (mismatching updated objects). This is especially useful during development, in order to catch many problems with the client itself (or new bugs in Ckan..).

list_datasets()

Returns:a list of dataset ids

iter_datasets()

Generator, iterating over all the datasets in ckan

get_dataset(id, allow_deleted=False)

Get a specific dataset, by id

Note

Since the Ckan API use both ids and names as keys, both get_dataset() and get_dataset_by_name() will perform the exact same request in the background.

The difference is only in the high-level handling: the function will check whether the expected id has the correct value, and raise an HTTPError(404, ..) otherwise..

Parameters:

• id (str) – the dataset id
• allow_deleted – Whether to return even logically deleted objects. If set to False (the default) will raise a HTTPError(404, ..) if state != 'active'

Return type:

CkanDataset

get_dataset_by_name(name, allow_deleted=False)

Get a specific dataset, by name

Note

See note on get_dataset()

Parameters:

• name (str) – the dataset name
• allow_deleted – Whether to return even logically deleted objects. If set to False (the default) will raise a HTTPError(404, ..) if state != 'active'

Return type:

CkanDataset

save_dataset(dataset)

If the dataset already has an id, call update_dataset(), otherwise, call create_dataset().

Returns:as returned by the called function. Return type:CkanDataset

create_dataset(dataset)

Create a dataset

Return type:CkanDataset

update_dataset(dataset)

Update a dataset

Return type:CkanDataset

delete_dataset(id)

Delete a dataset, by id

wipe_dataset(id)

Actually delete a dataset, by renaming it first

list_organizations()

list_organization_names()

iter_organizations()

get_organization(id, allow_deleted=False)

Get organization, by id.

Note

See note on get_dataset()

Parameters:

• id (str) – the organization id
• allow_deleted – Whether to return even logically deleted objects. If set to False (the default) will raise a HTTPError(404, ..) if state != 'active'

Return type:

CkanOrganization

get_organization_by_name(name, allow_deleted=False)

Get organization by name.

Note

See note on get_dataset()

Parameters:

• name (str) – the organization name
• allow_deleted – Whether to return even logically deleted objects. If set to False (the default) will raise a HTTPError(404, ..) if state != 'active'

Return type:

CkanOrganization

save_organization(organization)

create_organization(organization)

Create an organization

Return type:CkanOrganization

update_organization(organization)

Return type:CkanOrganization

delete_organization(id)

list_groups()

list_group_names()

iter_groups()

get_group(id, allow_deleted=False)

Get group, by id.

Note

See note on get_dataset()

Parameters:

• id (str) – the group id
• allow_deleted – Whether to return even logically deleted objects. If set to False (the default) will raise a HTTPError(404, ..) if state != 'active'

Return type:

CkanGroup

get_group_by_name(name, allow_deleted=False)

Get group by name.

Note

See note on get_dataset()

Parameters:

• name (str) – the group name
• allow_deleted – Whether to return even logically deleted objects. If set to False (the default) will raise a HTTPError(404, ..) if state != 'active'

Return type:

CkanGroup

save_group(group)

create_group(group)

Return type:CkanGroup

update_group(group)

Return type:CkanGroup

delete_group(id)