Extension Openbis


Extension Basics

Title
Openbis
Name
ckanext-openbis
Type
Public extension
Description
OpenBis harvester based on ckanext-oaipmh
CKAN versions
Download-Url (zip)
Last commit
10 years ago (2015-04-02 22:48:55)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

CKAN Harvester for openBis (OAI-PMH)

Build Status

This harvester uses the OAI-PMH interface of openBis to harvest metadata.

Instructions

Installation

Use pip to install this plugin. This example installs it in /vagrant

source /home/www-data/pyenv/bin/activate
pip install -e git+https://github.com/openresearchdata/ckanext-openbis.git#egg=ckanext-openbis --src /vagrant
cd /vagrant/ckanext-openbis
pip install -r requirements.txt
python setup.py develop

Make sure the ckanext-oaipmh and ckanext-harvest extension are installed as well.

Setup the Harvester

  • add openbis_harvester to ckan.plugins in development.ini (or production.ini)
  • restart your webserver
  • with the web browser go to <your ckan url>/harvest/new
  • as URL fill in the base URL of an OAI-PMH conforming openBis instance
  • select Source type openBis
  • if your OAI-PMH needs credentials, add the following to the “Configuration” section: {"username": "foo", "password": "bar" }
  • if you only want to harvest a specific set, add the following to the “Configuration” section: {"set": "baz"}
  • Save
  • on the harvest admin click Reharvest

Run the Harvester

On the command line do this:

  • activate the python environment
  • cd to the ckan directory, e.g. /usr/lib/ckan/default/src/ckan
  • start the consumers (NOTE: only run 1 gather and 1 fetch consumer per server):
paster --plugin=ckanext-openbis harvester gather_consumer &
paster --plugin=ckanext-openbis harvester fetch_consumer &
  • run the job:

    paster --plugin=ckanext-openbis harvester run

The harvester should now start and import the OAI-PMH metadata.

Developing without running jobs manually

To make it easier to develop, tests are setup that allow to do that:

Version
Version release date
(not set)
Contact name
Open Research Data
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Use pip to install this plugin. This example installs it in /vagrant

source /home/www-data/pyenv/bin/activate
pip install -e git+https://github.com/openresearchdata/ckanext-openbis.git#egg=ckanext-openbis --src /vagrant
cd /vagrant/ckanext-openbis
pip install -r requirements.txt
python setup.py develop

Make sure the ckanext-oaipmh and ckanext-harvest extension are installed as well.

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