Skip to content

ilrt/ckanext-oaipmh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OAI-PMH Plugin for CKAN

This plugin provides two things: a harvester which can be configured to harvest datasets from a OAI-PMH data source and a fully compatible interface for OAI-PMH which can list all datasets and resources in CKAN for OAI-PMH.

Harvester

The steps to install harvester, add the extension name 'oaipmh_harvester' to the configuration option 'ckan.plugins' of the CKAN ini file in use.

After this restart CKAN. Then navigate to '/harvest', add a harvesting source. For this source do:

  • Fill in URL to a OAI-PMH repository.
  • Select 'Source Type' to be 'OAI-PMH'.
  • In configuration, you must add your selected sets that should be imported.
The format is JSON and only accepts a string named 'query'
eg. '{"query":"Faculty of Science and Forestry"}'
  • Click save

You may need to configure your fetch and gather consumer to be run as daemons or via a the paster commands.

This is clearly documented in ckanext-harvest extension, see it here:

https://github.com/okfn/ckanext-harvest/blob/master/README.rst

Interface

The interface is simple to install, add the extension name 'oaipmh' to the configuration option 'ckan.plugins' of the CKAN ini file in use.

To acccess the interface, go to 'http://your.ckan.net/oai'. Use the interface as described in OAI-PMH documentation.

Tests

This extension offers a suite of tests, to run them, issue the following command:

python setup.py nosetests

If you get an error about test.ini not being found, please modify the test-core.ini file to have:

use = config:../pyenv/src/ckan/test.ini

pointing to a CKAN source tree

Releases

No releases published

Packages

No packages published