CKAN extension for importing and exporting Data Packager
Python HTML Shell
Latest commit b9d6e54 Jun 6, 2016 @vitorbaptista vitorbaptista [#36] Add Python2.7 as requirement in README
Even though CKAN 2.4 and 2.5 support Python 2.6, we don't. It's mainly because
`datapackage-py` doesn't support it either, so it's too much work for an
ancient Python version.
Permalink
Failed to load latest commit information.
bin
ckanext
doc
.coveragerc
.gitignore
.travis.yml
MANIFEST.in
README.markdown
dev-requirements.txt
requirements.txt
setup.py
test.ini

README.markdown

Build Status Coverage Status

CKAN Data Packager

This extension adds importing and exporting of Data Packages to CKAN datasets.

Requirements

  • CKAN >= 2.4
  • Python 2.7

Installing

To install ckanext-datapackager into a CKAN instance, do:

  1. If you're using a virtual environment for CKAN, activate it doing, for example:

    source /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-datapackager extension using pip:

    pip install ckanext-datapackager
    

    Alternatively do a development install (with your virtualenv activated):

    git clone https://github.com/ckan/ckanext-datapackager.git
    cd ckanext-datapackager
    python setup.py develop
    pip install -r requirements.txt
    
  3. Add datapackager to the ckan.plugins setting in your CKAN config file;

  4. Restart CKAN.

Using

Web Interface

Importing

Importing Data Package

  1. Visit the Dataset list page (e.g. http://your-ckan-address.com/dataset)
  2. Click on Import Data Package button;
  3. Upload or link to a Data Package JSON or ZIP file;
    • Depending on your CKAN configuration, you might also need to define the dataset's organization and visibility here.
  4. Review the created dataset.

Exporting

Exporting CKAN Dataset as Data Package

  1. Go to the dataset's page;
  2. Click on Download Data Package button.

API

The extension provides two API actions for importing (package_create_from_datapackage) and exporting (package_show_as_datapackage) Data Packages on CKAN.

For more information on their parameters and return values, check the docstrings inside the files at ckanext/datapackager/logic/action.

Importing

If the Data Package (either the datapackage.json file or a zip file with the datapackage.json and the data files) is reachable through an URL, you can do a request to package_create_from_datapackage as such:

curl -X POST \
     -H 'Authorization: YOUR_CKAN_API_KEY' \
     -d '{"url": "https://link.to/datapackage.json"}' \
     http://CKAN_HOST/api/action/package_create_from_datapackage

You can also use ckanapi:

ckanapi action package_create_from_datapackage url=URL_TO_DATAPACKAGE owner_org=OWNER_ORGANIZATION_ID -r http://CKAN_HOST

For uploading the Data Package, check the documentation on uploading files using ckanapi or check this example using requests:

import requests

r = requests.post('http://CKAN_HOST/api/action/package_create_from_datapackage',
                   headers={'Authorization': YOUR_CKAN_API_KEY},
                   files=[('upload', file('/path/to/datapackage.json/or/file.zip'))])

Exporting

For exporting a dataset as a datapackage.json just call package_show_as_datapackage with the relevant dataset id:

curl 'http://CKAN_HOST/api/action/package_show_as_datapackage?id=940a5fe0-0c72-41c4-8a28-8c794f399036'

{"help": "http://CKAN_HOST/api/3/action/help_show?name=package_show_as_datapackage",
 "success": true,
 "result": {
    "name": "bond-yields-uk-2-7334836228",
    "title": "Test Data Package",
    "resources": [
        {"url": "http://some.file",
         "format": "CSV"}
    ]
  }
}

Or if using ckanapi:

ckanapi action package_show_as_datapackage id=PACKAGE_ID -r http://CKAN_URL

Note that this returns the standard CKAN API output where the datapackage.json file is returned under the result key. If you would rather like to get the datapackage.json file directly you can use this direct endpoint:

http://CKAN_HOST/dataset/DATASET_NAME_OR_ID/datapackage.json

For instance

curl http://CKAN_HOST/dataset/bond-yields-uk-10y/datapackage.json

Developing ckanext-datapackager

Running tests

You'll need to install the dev requirements to run the tests:

pip install -r dev-requirements.txt

To run the tests:

nosetests --nologcapture --ckan --with-pylons=test.ini

Note that ckanext-datapackager's test.ini file assumes that the relative path from it to CKAN's test-core.ini file is ../ckan/test-core.ini, i.e. that you have CKAN and ckanext-datapackager installed next to each other in the same directory. This would normally be the case if you've done development installs of CKAN and ckanext-datapackager.

Where is the old Open Knowledge's Data Packager?

The Open Knowledge Data Packager was written for an old CKAN version (2.2), and is now deprecated. This extension implements parts of its functionality and improves them, supporting the current CKAN version (2.4).

If you still need the old Data Packager, checkout this repository's commit 57cff1f.