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