Extension CKAN Data Packager


Extension Basics

Title
CKAN Data Packager
Name
ckanext-datapackager
Type
Public extension
Description
CKAN extension for importing and exporting Data Packages via web interface and API, supporting Frictionless Data Package standard.
CKAN versions
Download-Url (zip)
Last commit
3 years ago (2022-10-20 12:52:29)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-datapackager

CKAN Data Packager — This extension adds importing and exporting of Data Packages (https://frictionlessdata.io/data-packages/) to CKAN datasets.

Requirements

  • CKAN >= 2.8

Installation

  1. If you’re using a virtual environment for CKAN, activate it:
source /usr/lib/ckan/default/bin/activate
  1. Install the extension:
git clone https://github.com/frictionlessdata/ckanext-datapackager.git
cd ckanext-datapackager
python setup.py develop
pip install -r requirements.txt
  1. Add datapackager to the ckan.plugins setting in your CKAN config file.
  2. Restart CKAN.

Using

Web Interface

Importing

  1. Visit the Dataset list page
  2. Click on Import Data Package button
  3. Upload or link to a Data Package JSON or ZIP file
  4. Review the created dataset

Exporting

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

API

The extension provides two API actions:

  • package_create_from_datapackage — Import a Data Package from URL or file upload
  • package_show_as_datapackage — Export a dataset as datapackage.json

Direct endpoint for datapackage.json:

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

Where is the old Open Knowledge’s Data Packager?

The Open Knowledge Data Packager (http://datapackager.okfn.org/) 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.

Contributors

9 contributors including Vitor Baptista, Joe Tsoi, André Avelino, Adrià Mercader, Alex Kreidler.

License

Code of Conduct provided. 36 stars, 15 forks.

Version
1.1.0
Version release date
2022-08-17
Contact name
Frictionless Data (Open Knowledge Foundation)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Adds import/export of Frictionless Data Packages. Web UI and API actions provided. Requires CKAN >= 2.8. Supports both Python 2 and 3 (separate requirements files). 36 stars, 15 forks, 9 contributors.

Plugins to configure (ckan.ini)
datapackager
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions