Extension Thesauri


Extension Basics

Title
Thesauri
Name
ckanext-thesauri
Type
Public extension
Description
The **Thesauri** extension for CKAN allows for the harvesting and integration of standardized tags
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-03-25 13:49:57)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

dai_thesauri_harvester

The dai_thesauri_harvester plugin for CKAN enables the harvesting of tags from [idai.thesauri.de](http://thesauri.dainst.org) and their addition to a CKAN instance database table. It facilitates the enrichment of dataset metadata by allowing the use of standardized tags from the Digital Archaeological Institute (DAI) Thesaurus. Furthermore, the plugin publishes an API endpoint that is utilized in the package form, enhancing data entry and search capabilities.

Features

  • Harvest tags from [idai.thesauri.de](http://thesauri.dainst.org).
  • Populate a CKAN database table with harvested tags.
  • Provide an API endpoint for use in dataset forms.
  • CLI commands for managing the thesaurus data.

Usage

Harvesting and Populating the Thesaurus

To populate the thesaurus table with data from idai.thesauri.de visit

ckan -c /etc/ckan/default/production.ini dai_thesauri_harvester

API Endpoint

This plugin adds an API endpoint that can be used on the package form for suggesting tags from the DAI Thesaurus. Documentation for the API endpoint usage can be found at http:///api/3/action/help_show?name=dai_thesauri_harvester_show.

Installation

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-thesauri_harvester:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com//ckanext-thesauri_harvester.git cd ckanext-thesauri_harvester pip install -e . pip install -r requirements.txt

  3. Add thesauri_harvester to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

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

Version
Version release date
(not set)
Contact name
cuprit-gbr
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-thesauri_harvester:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com//ckanext-thesauri_harvester.git cd ckanext-thesauri_harvester pip install -e . pip install -r requiremen

Plugins to configure (ckan.ini)
publishes thesauri
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions