Extension Data Package


Extension Basics

Title
Data Package
Name
ckanext-datapackage
Type
Public extension
Description
Lightweight CKAN plugin that adds a dataset/<id>/datapackage.json endpoint to every dataset, following the Data Package Standard.
CKAN versions

2.10

Show details

These CKAN Versions are exactely matched:

Download-Url (zip)
Last commit
a year ago (2024-09-24 13:46:40)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-datapackage

Data Package integration for CKAN.

Purpose

This lightweight CKAN plugin adds a dataset/<id>/datapackage.json endpoint to every dataset in the data catalog. Read more about the Data Package Standard at https://datapackage.org/.

Requirements

The extension requires Python 3.8+. It is being developed and tested with CKAN 2.10. Please fill an issue if it doesn’t work as expected with other versions.

Installation

  1. Install the extension:
$ pip install ckanext-datapackage
  1. Enable the plugin in your ini file:
ckan.plugins = ... datapackage

Endpoint

Data Package representations of a particular dataset can be accessed using the following endpoint:

https://{ckan-instance-host}/dataset/{dataset-id}/datapackage.json

Read more about Data Package Standard specifications and datapackage.json metadata format at https://datapackage.org/.

Benefits

Having a Data Package representation of a dataset allows for using a rich ecosystem of tools and libraries that support the Data Package Standard. For example, data portal users can use the frictionless-r or frictionless-py to access the data without losing metadata and information about data types.

Funding

This project is funded through NGI0 Entrust, a fund established by NLnet with financial support from the European Commission’s Next Generation Internet program.

License

MIT

Version
0.2.4
Version release date
2024-06-04
Contact name
Frictionless Data (Open Knowledge Foundation)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Adds datapackage.json endpoint per Data Package Standard. Python 3.8+ required. Available on PyPI. Funded by NGI0/NLnet. 4 releases.

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