Extension EDS Metadata


Extension Basics

Title
EDS Metadata
Name
ckanext-edsmetadata
Type
Public extension
Description
CKAN extension by Keitaro enhancing metadata management with customizable resource fields, email validation, and markdown rendering support.
CKAN versions
Download-Url (zip)
Last commit
4 years ago (2021-04-09 09:09:22)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-edsmetadata

A CKAN extension developed by Keitaro Inc. that enhances dataset metadata management. It provides customizable resource field handling, email validation, and markdown rendering for specific attributes.

Installation

To install ckanext-edsmetadata:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-edsmetadata Python package into your virtual environment:

    pip install ckanext-edsmetadata
    
  3. Add edsmetadata to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. Restart CKAN.

Config Settings

Exclude specific fields from the resource additional info table:

# default: attributes filters format
ckanext.edsmetadata.resource_excluded_fields = some_default_value

E-mail regex used for e-mail validation when creating datasets:

# default: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
ckanext.edsmetadata.email_regex = ...

Resource attributes that should be rendered as markdown:

# default: comment attribute_description
ckanext.edsmetadata.markdown_fields = ...

Development Installation

To install ckanext-edsmetadata for development:

git clone https://github.com/keitaroinc/ckanext-edsmetadata.git
cd ckanext-edsmetadata
python setup.py develop
pip install -r dev-requirements.txt

License

AGPL-3.0 license

Version
0.0.1
Version release date
2021-04-09
Contact name
Keitaro Inc
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Add ‘edsmetadata’ to ckan.plugins. Configure excluded fields, email validation regex, and markdown fields using the provided settings.

Plugins to configure (ckan.ini)
edsmetadata
CKAN Settings (ckan.ini)
# ckanext.edsmetadata.resource_excluded_fields = attributes filters format
# ckanext.edsmetadata.email_regex = ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
# ckanext.edsmetadata.markdown_fields = comment attribute_description
DB migration to be executed
(not set)
<< back to Extensions