Use Case Recipes

Here are some ideas for how your institution might use this software.

I am a content provider

I want to make available an OAI-PMH metadata provider via ResourceSync. My OAI-PMH provider's base URL is http://example.com/oai/provider. I will host the ResourceSync sitemap documents at http://test.com with the Apache 2 HTTP Server. The collection's setSpec is testcol and the records are MODS XML. I want ResourceSync documents for this collection be available at http://test.com/resourcesync/testcol/.

This is my first time generating RS documents for this collection.

sudo python3 oaipmh-rs-src.py http://test.com apache http://example.com/oai/provider mods resourcelist testcol

I made changes to one or more records in testcol (i.e., RS documents already exist for this collection).

sudo python3 oaipmh-rs-src.py http://test.com apache http://example.com/oai/provider mods new_changelist testcol

I am a content aggregator

I want to populate a Solr index with OAI-PMH resources from one or more content providers. I want to use ResourceSync to do this. I have a local TinyDB instance at /my/tiny/db.json with one row per resource set (according to the schema) and a Solr index at http://example.com/solr/resourcesync. I want to update Solr every Sunday at 2 AM.

# /etc/crontab
...
0 2 * * 0 root python3 oaipmh-rs-dest.py /my/tiny/db.json http://example.com/solr/resourcesync