Added API key support

Author: STITCHplus

example.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 
 import os
 import sys
@@ -10,6 +9,7 @@
 
 oai_handler = oai
 oai_handler.current_set = "ANP"
+oai_handler.set_key("")
 
 response = sru.search("karel AND reve AND hooftprijs", "ANP")
 print ("Number of records: %i" % response.sru.nr_of_records)

kb/nl/api/oai.py

@@ -4,7 +4,6 @@
 from kb.nl.collections import SETS
 from kb.nl.helpers import etree
 
-OAI_BASEURL = 'http://services.kb.nl/mdo/oai'
 
 
 class oai:
@@ -34,7 +33,10 @@ class oai:
     current_set = False
     oai_sets = SETS
     resumptiontoken = False
+
     DEBUG = False
+    KEY = False
+    OAI_BASEURL = 'http://services.kb.nl/mdo/oai'
 
     def __init__(self, current_set=False):
         if current_set:
@@ -46,6 +48,21 @@ def list_sets(self):
         """
         return sorted(self.oai_sets.keys())
 
+    def set_key(self, key):
+        """
+           Sets the key for the OAI-session,
+           some parts of the collection are protected.
+           to request a key see this page:
+
+           https://www.kb.nl/en/resources-research-guides/data-services-apis
+
+           :param key: OAI key 
+        """ 
+        if not self.KEY:
+            self.KEY = key
+            self.OAI_BASEURL += "/" + key
+        return
+
     def list_records(self, setname, resumptiontoken=False):
         """
            Retrieves a list of records from the OAI server,
@@ -64,7 +81,7 @@ def list_records(self, setname, resumptiontoken=False):
             if not resumptiontoken:
                 self.resumptiontoken = False
 
-        url = OAI_BASEURL
+        url = self.OAI_BASEURL
         url += '?verb=ListRecords'
         url += '&metadataPrefix=' + self.oai_sets[setname]['metadataPrefix']
         url += '&set=' + self.oai_sets[setname]['setname']
@@ -110,7 +127,7 @@ def get(self, identifier):
             identifier = 'BYVANCK:' + identifier
             identifier = identifier.replace('BYVANCK', 'ByvanckB')
 
-        url = OAI_BASEURL
+        url = self.OAI_BASEURL
         url += '?verb=GetRecord'
         url += '&identifier=' + identifier
 

setup.py

@@ -2,11 +2,11 @@
 
 setup(
     author="WillemJan Faber",
-    author_email=["[email protected]", "[email protected]"],
+    author_email="[email protected]",
     name='kb',
     url="https://github.com/KBNLresearch/KB-python-API",
     description='Access to National Library of the Netherlands datasets',
-    version='0.1.7',
+    version='0.1.9',
     packages=['kb.nl.api', 'kb.nl.helpers', 'kb', 'kb.nl', 'kb.nl.collections'],
     license='GNU General Public License',
     install_requires=['lxml>=2.3', 'requests'],