Install

Install it from the Python Package Index:

$ pip install ckan-client

Usage

ckanclient.Client

Arguments:

Example:

from ckanclient import Client


client = Client(
    '771a05ad-af90-4a70-beea-cbb050059e14',
    'http://localhost:5000',
    'datopian',
    'dailyprices',
    'http://localhost:9419',
)

These settings matches the standard of ckanext-blob-storage development environment, but you still need to create the user and organization there.

ckanclient.Client.action

Arguments:

This method is used internally by the following methods.

ckanclient.Client.create

Arguments:

Example:

dataset = client.create('dailyprices')

ckanclient.Client.push

Arguments:

Example:

dataset_metadata = {
    'id': '16d6e8d7-a848-48b1-91d0-fd393c1c6c01',
    'name': 'dailyprices',
    'owner_org': '57f97769-a982-4ccd-91f0-1d86dee822e3',
    'title': 'dailyprices',
    'type': 'dataset',
    'contributors': [],
    # …
}
dataset = client.push(dataset_metadata)

ckanclient.Client.retrieve

Arguments:

Example:

dataset = client.retrieve('dailyprices')

ckanclient.Client.push_blob

Arguments:

Development

All you need is Git, and Python 3.6+ with a PEP 527 compliant tool, such as Poetry.

First, clone this repository:

$ git clone https://github.com/datopian/ckan-client-py.git

Then, move to is directory:

$ cd ckan-client-py

And install the package and its dependencies, for example, with Poetry:

$ poetry install

To run tests:

$ poetry run pytest

License

This project is licensed under the MIT License - see the LICENSE file for details