Extension Data Package Creator


Extension Basics

Title
Data Package Creator
Name
ckanext-datapackage-creator
Type
Public extension
Description
CKAN extension using the Frictionless Data library for creating and managing Data Packages with configurable mandatory and read-only fields.
CKAN versions
Download-Url (zip)
Last commit
2 years ago (2023-04-25 22:43:20)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-datapackage-creator

CKAN extension to use the Frictionless library.

Installation

pip install ckanext-datapackage-creator

Configuration

Once installed, add the datapackage_creator plugin to the ckan.plugins configuration option in your INI file.

ckan.plugins = ... datapackage_creator

The plugin allows you to configure which fields of the resource and package are mandatory and/or ‘readonly’. For this you just need to add a configuration in your INI file:

datapackage_creator = /path/to/datapackage_creator.json

We suggest that the file path would be /etc/ckan/default/datapackage_creator.json or in the same folder as ckan.ini file.

Configuration example file:

{
    "package": {
        "required": [],
        "readonly": []
    },
    "resource": {
        "required": [],
        "readonly": []
    },
    "token": ""
}

Mandatory possible package fields

  • description, source, version, license, frequency, tags, author, author_email

Mandatory possible resource fields

  • title, description, format, type, encoding, field.name, field.title, field.description, field.format

Possible read-only resource fields

  • format, type, encoding

Token

It is necessary to configure an administrator token so that the plugin can query private data.

Entity Diagram

To generate the entity diagram it is necessary to install the library: graphviz. On Ubuntu: sudo apt-get install graphviz

License

MIT

Version
0.0.60
Version release date
2022-01-01
Contact name
Transparência MG (Minas Gerais, Brazil)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Requires external JSON config file for field customization. Admin token needed for private data access. Available on PyPI. 54 tags/releases. Requires graphviz for entity diagrams.

Plugins to configure (ckan.ini)
datapackage_creator
CKAN Settings (ckan.ini)
# datapackage_creator = /etc/ckan/default/datapackage_creator.json
DB migration to be executed
(not set)
<< back to Extensions