Extension Datapackage


Extension Basics

Title
Datapackage
Name
ckanext-datapackage
Type
Public extension
Description
Data Package integreation for CKAN.
CKAN versions

~2.10

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


Background Infos

Description (long)
Show details

ckanext-datapackage

Build Codebase Release

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.

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.

Example

Consider there is a dataset as below:

http://ckan:5000/dataset/example

Dataset

The Data Package representation of this dataset can be accessed using the following endpoint (note that the link is also available on the dataset page in the “Additional Info” section):

http://ckan:5000/dataset/example/datapackage.json

“`json { “$schema”: “https://datapackage.org/profiles/2.0/datapackage.json”, “ckan:id”: “8bb0257b-37be-48ca-9129-59040264acd5”, “contributors”: [ { “email”: “eskarev@gmail.com”, “roles”: [“author”], “title”: “Evgeny Karev” }, { “email”

Version
0.2.4
Version release date
2024-06-04
Contact name
(not set)
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints
  1. Install the extension:
$ pip install ckanext-datapackage
  1. Enable the plugin in your ini file:
ckan.plugins = ... datapackage
Plugins to configure (ckan.ini)
datapackage
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions