Code reference

Utilities for interacting with CKAN instances via their Action API.

The ckanapi package (PyPI, GitHub), maintained by the CKAN organization, provides Pythonic access to the “CKAN Action API” ( documentation), which itself exposes nearly all of the functionality available through the CKAN web interface and the TDC front-end.

The Client class is a wrapper around the ckanapi.RemoteCKAN class that provides conveniences used by other code in transport_data.

Functions

get_class(name)

Return a ModelProxy subclass given name.

transport_data.util.ckan.get_class(name: str) type[ModelProxy] | None[source]

Return a ModelProxy subclass given name.

Classes

Client(address, id)

Wrapper around ckanapi.RemoteCKAN.

Group([data])

Proxy for ckan.model.Group.

License([data])

Proxy for ckan.model.License.

MemberRole([data])

Proxy for the CKAN 'MemberRole' model.

ModelProxy([data])

Simple proxy for a CKAN object/model.

Organization([data])

'Organization' is a synonym for 'Group'.

Package([data])

Proxy for ckan.model.Package.

Resource([data])

Proxy for ckan.model.Resource.

Tag([data])

Proxy for the CKAN 'Tag' model.

User([data])

Proxy for ckan.model.User.