Extension DataOntoSearch


Extension Basics

Title
DataOntoSearch
Name
ckanext-dataontosearch
Type
Public extension
Description
CKAN extension for integrating with DataOntoSearch, enabling ontology-based dataset tagging and semantic search using domain-specific ontologies.
CKAN versions
Download-Url (zip)
Last commit
6 years ago (2019-05-07 13:55:24)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-dataontosearch

Extension for integrating CKAN with DataOntoSearch.

DataOntoSearch is a project which aims to make it easier to find datasets, by using a domain-specific ontology to find similar datasets. The software is run as a separate server, which other projects like CKAN can connect to.

There are two separate plugins provided with this extension:

  • dataontosearch_tagging provides a way of associating datasets with concepts in the ontology. Each such association is internally called a “tag”, which should not be confused with traditional CKAN tags.
  • dataontosearch_searching provides an integrated way of searching using DataOntoSearch.

The extension adds a link you can follow when editing datasets. From there, you can change what concepts are connected to what datasets.

The extension also adds a link to the alternative search method. Following it lets you search using DataOntoSearch.

Important: This extension does not work by itself. It must be paired with a separately deployed version of DataOntoSearch.

Attention! Both this and DataOntoSearch should be considered experimental.

Requirements

This plugin was developed for CKAN version 2.8. We have not checked what other versions it works with, but it does use features introduced in version 2.7.

Requires ckanext-dcat to be installed.

Installation

  1. Ensure that the ckanext-dcat extension is installed.
  2. Ensure that CKAN can accept multiple requests in parallel (e.g. gunicorn with -w 4). The debug setting must be set to false.
  3. Activate your CKAN virtual environment.
  4. Install the package: pip install ckanext-dataontosearch
  5. Add dataontosearch_tagging and dataontosearch_searching to ckan.plugins. They need to be listed after the dcat plugins.
  6. Add required settings (see Config Settings below).
  7. Restart CKAN.

Config Settings

# Base URL where dataset_tagger is running
ckan.dataontosearch.tagger_url = https://example.com/tagger

# Base URL where the search for DataOntoSearch is running
ckan.dataontosearch.search_url = https://example.com/search

# The DataOntoSearch Configuration to use
ckan.dataontosearch.configuration = 5c7ea259c556bb42803fa17e

# Username and password for HTTP Basic Authentication (optional)
ckanext.dataontosearch.username = aladdin
ckanext.dataontosearch.password = opensesame

# Whether to use the autotagged graph instead of manual one (optional, default: no)
ckan.dataontosearch.use_autotag = yes

Status

No Maintenance Intended. Available on PyPI.

License

AGPL-3.0

Version
0.0.6
Version release date
2019-04-30
Contact name
tobinus
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Requires ckanext-dcat. Requires separately deployed DataOntoSearch server. CKAN must run in parallel mode (not debug). Experimental, no maintenance intended. Available on PyPI.

Plugins to configure (ckan.ini)
dataontosearch_tagging dataontosearch_searching
CKAN Settings (ckan.ini)
# ckan.dataontosearch.tagger_url = https://example.com/tagger
# ckan.dataontosearch.search_url = https://example.com/search
# ckan.dataontosearch.configuration = 5c7ea259c556bb42803fa17e
# ckanext.dataontosearch.username = aladdin
# ckanext.dataontosearch.password = opensesame
# ckan.dataontosearch.use_autotag = yes
DB migration to be executed
(not set)
<< back to Extensions