Extension CSV to CSVW


Extension Basics

Title
CSV to CSVW
Name
ckanext-csvtocsvw
Type
Public extension
Description
Automatically generates CSVW metadata for uploaded CSV files and uploads data to the datastore as a DataPusher replacement.
CKAN versions

~2.10, ~2.11

Show details
Download-Url (zip)
Last commit
9 months ago (2025-05-14 16:00:54)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

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 an API Token for an account with the right privileges to make the background job work on private datasets and resources.

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:

CKANINI__CKANEXT__CSVTOCSVW__FORMATS="csv txt asc"

Default formats: csv, txt, asc, tsv

Purpose

Reacts to CSV files uploaded: - /annotate creates CSVW annotation file for a CSV in JSON-LD format - /transform utilizes CSVW metadata to transform CSV content to RDF

Compatibility

CKAN Version Compatible
2.9 and earlier not tested
2.10 yes
2.11 yes

Installation

  1. Activate your CKAN virtual environment
  2. pip install ckanext-csvtocsvw
  3. Add csvtocsvw to ckan.plugins
  4. Restart CKAN

License

AGPL-3.0

Version
1.0.3
Version release date
2025-05-13
Contact name
Mat-O-Lab
Contakt email
(not set)
Contact Url


Installation Guide

Configuration hints

Requires running CSVToCSVW application. Use as DataPusher replacement.

Plugins to configure (ckan.ini)
csvtocsvw
CKAN Settings (ckan.ini)
# CKANINI__CKANEXT__CSVTOCSVW_URL = http://csvtocsvw:5000
# CKANINI__CKANEXT__CSVTOCSVW__CKAN_TOKEN = 
# CKANINI__CKANEXT__CSVTOCSVW__FORMATS = csv txt asc tsv
# CKANINI__CKANEXT__CSVTOCSVW__SSL_VERIFY = True
DB migration to be executed
(not set)
<< back to Extensions