Extension Csvtocsvw


Extension Basics

Title
Csvtocsvw
Name
ckanext-csvtocsvw
Type
Public extension
Description
Extention to automate meta data creation for csv files with the help of the csvtocsvw tool of mat-o-lab.
CKAN versions
Download-Url (zip)
Last commit
8 months ago (2025-05-14 14:00:54)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Tests

ckanext-csvtocsvw

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. should be used as replacement for datapusher

Requirements

Needs a running instance of the CSVToCSVW 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.

CKANINI__CKANEXT__CSVTOCSVW_URL=http://${CSVTOCSVW_HOST}:${CSVTOCSVW_APP_PORT}
CKANINI__CKANEXT__CSVTOCSVW__CKAN_TOKEN=${CKAN_API_TOKEN}

You can set the default formats to annotate by setting the env variable CSVTOCSVW_FORMATS for example

CKANINI__CKANEXT__CSVTOCSVW__FORMATS="csv txt asc"

else it will react to the following formats: “csv”, “txt”, “asc”, “tsv”

If you need to process files that are not hosted through https (CKAN is not ssl configured), you can disable ssl verification

CKANINI__CKANEXT__CSVTOCSVW__SSL_VERIFY=False

Purpose

Reacts to CSV files uploaded. DEFAULT_FORMATS are “csv; txt” It creates two to sites for each resource. - /annotate creates CSVW annotation file for a CSV in json-ld format named -metadata.json, uploades table-1 to ckan datastore o u can explorer it with recline views - /transform utilizes CSVW metadata to transform the whole content of the csv file to rdf, output is .ttl The plugins default behavior includes a trigger to csv file uploads, so it runs annotation automatically on upload. The transformation is a bonus feature and outputs standard tabular data as mentioned in the CSVW documentation of the W3C. It must be triggered manually.

Compatibility with core CKAN versio

Version
1.0.3
Version release date
2025-05-13
Contact name
(not set)
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-csvtocsvw
  1. Add csvtocsvw 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)
csvtocsvw
CKAN Settings (ckan.ini)
# CKANINI__CKANEXT__CSVTOCSVW_URL=http://${CSVTOCSVW_HOST}:${CSVTOCSVW_APP_PORT}
# CKANINI__CKANEXT__CSVTOCSVW__CKAN_TOKEN=${CKAN_API_TOKEN}
# CKANINI__CKANEXT__CSVTOCSVW__FORMATS="csv txt asc"
# CKANINI__CKANEXT__CSVTOCSVW__SSL_VERIFY=False
DB migration to be executed
(not set)
<< back to Extensions