libckan is a Python library for OKFN CKAN APIv3. It will support the Action API CKAN API, of CKAN v2.0.0.

It might eventually support the DataStore API DATASTORE API, and the FileStore API FILESTORE API, by re-using ckanclient codebase and become the de-facto CKAN standard client library. However, the plans actually are to make it a ckanclient CKANCLIENT companion.

It is libckan aim to reach 90%+ line coverage before releasing a version to the public.

Please manually insert your CKAN Api key for master.ckan.org in the file libckan/model/client.py :: API_KEY = 'insertithere'

This will obviously change in the future.

libckan uses nosetests. Run then in the root of the project.

Work in progress. Checkout the latest documentation build on Read The Docs

You will use libckan like this::

import libckan.logic.action.get
packages = libckan.logic.action.get.package_search(q='test')

Checkout the tests folder to learn something more. Otherwise, please look at the source for the moment.

The following is the set of Values being followed while developing libckan. They are listed in preferred order and priority.

1. Use Semantic Versioning
2. Adhere to CKAN API syntax and semantics as most as possible.
3. Document the Public API and the Models
4. No commit/merge in master unless a 90%+ test coverage is ensured for the file. Rare exceptions may exist (e.g., HTTP errors non reproducible)
5. Adhere to PEP8 before a version is released

BSD 3-Clause License (Revised). See COPYING.rst for the license.

Very, very early development. Stay tuned.