Extension Csvwmapandtransform


Extension Basics

Title
Csvwmapandtransform
Name
ckanext-csvwmapandtransform
Type
Public extension
Description
CKAN extension facilitating MapToMethod and RDFConverter map CSVW data to knowledge graphs and run automatic transforms fro matching maps as a background job.
CKAN versions
Download-Url (zip)
Last commit
8 months ago (2025-05-14 08:37:11)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Tests

ckanext-csvwmapandtransform

Extension automatically generating csvw metadata for uploaded textual tabular data. It uploads the data of the first table documented into a datastore for the source csv file.

Requirements

Needs a running instance of the MapToMethod Application and RDFConverter Application Point at it through env variables. Also needed is a Api Token for an account with the right privaledges to make the background job work on private datasets and ressources.

CSVWMAPANDTRANSFORM_TOKEN=${CKAN_API_TOKEN}
MAPTOMETHOD_CONTAINER_NAME="ckan_maptomethod"
MAPTOMETHOD_APP_PORT=5002
# must be reachable from outside container net or iframe wil not work 
CKAN_MAPTOMETHOD_URL=http://<CKAN_HOST>:${MAPTOMETHOD_APP_PORT}
RDFCONVERTER_CONTAINER_NAME="ckan_rdfconverter"
RDFCONVERTER_APP_PORT=5003
CKAN_RDFCONVERTER_URL=http://${RDFCONVERTER_CONTAINER_NAME}:${RDFCONVERTER_APP_PORT}
CSVWMAPANDTRANSFORM_SQLALCHEMY_URL=postgresql://<ckandbuser>:<ckandbpassword>@<db>/ckandb
PARSER_PORT=3001
MAPPER_PORT=4000
CONVERTER_PORT=5000

You can set the default formats to run trusformation on by setting the env variable CSVWMAPANDTRANSFORM_FORMATS for example

CSVWMAPANDTRANSFORM_FORMATS="json-ld turtle n3 nt hext trig longturtle xml"

else it will react to the following formats: “json json-ld turtle n3 nt hext trig longturtle xml”

CSVWMAPANDTRANSFORM_FORMATS=”json json-ld turtle n3 nt hext trig longturtle xml”

Compatibility with core CKAN versions:

CKAN version Compatible?
2.9 and arlier not tested
2.10 yes
2.11 yes
  • “yes”
  • “not tested” - I can’t think of a reason why it wouldn’t
Version
1.0.2
Version release date
2025-05-14
Contact name
Materials Open Laboratory
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install the extension:

  1. Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
  1. Use pip to install package
pip install ckanext-csvwmapandtransform
  1. Add csvwmapandtransform to the ckan.plugins setting in your CKAN    config file (by default the config file is located at    /etc/ckan/default/ckan.ini).

  2. Restart CKAN. For example, if you’ve deployed CKAN with Apache on Ubuntu:

sudo service apache2 reload
Plugins to configure (ckan.ini)
csvwmapandtransform
CKAN Settings (ckan.ini)
# CKAN_MAPTOMETHOD_URL=http://<CKAN_HOST>:${MAPTOMETHOD_APP_PORT}
# CKAN_RDFCONVERTER_URL=http://${RDFCONVERTER_CONTAINER_NAME}:${RDFCONVERTER_APP_PORT}
DB migration to be executed
(not set)
<< back to Extensions