diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..678873f --- /dev/null +++ b/404.html @@ -0,0 +1,408 @@ + + + +
+ + + + + + + + + + + + + + + + +Client for harvesting OAI interfaces.
+Use it like this::
+>>> scythe = Scythe('http://elis.da.ulcc.ac.uk/cgi/oai2')
+>>> records = scythe.ListRecords(metadataPrefix='oai_dc')
+>>> records.next()
+<Record oai:eprints.rclis.org:3780>
+
:param endpoint: The endpoint of the OAI interface.
+:type endpoint: str
+:param http_method: Method used for requests (GET or POST, default: GET).
+:type http_method: str
+:param protocol_version: The OAI protocol version.
+:type protocol_version: str
+:param iterator: The type of the returned iterator
+ (default: :class:oaipmh_scythe.iterator.OAIItemIterator
)
+:param max_retries: Number of retry attempts if an HTTP request fails (default: 0 = request only once). Scythe will
+ use the value from the retry-after header (if present) and will wait the specified number of
+ seconds between retries.
+:type max_retries: int
+:param retry_status_codes: HTTP status codes to retry (default will only retry on 503)
+:type retry_status_codes: iterable
+:param default_retry_after: default number of seconds to wait between retries in case no retry-after header is found
+ on the response (defaults to 60 seconds)
+:type default_retry_after: int
+:type protocol_version: str
+:param class_mapping: A dictionary that maps OAI verbs to classes representing
+ OAI items. If not provided,
+ :data:oaipmh_scythe.app.DEFAULT_CLASS_MAPPING
will be used.
+:type class_mapping: dict
+:param encoding: Can be used to override the encoding used when decoding
+ the server response. If not specified, requests
will
+ use the encoding returned by the server in the
+ content-type
header. However, if the charset
+ information is missing, requests
will fallback to
+ 'ISO-8859-1'
.
+:type encoding: str
+:param request_args: Arguments to be passed to requests when issuing HTTP
+ requests. Useful examples are auth=('username', 'password')
+ for basic auth-protected endpoints or timeout=<int>
.
+ See the documentation of requests <http://docs.python-requests.org/en/master/api/#main-interface>
_
+ for all available parameters.
src/oaipmh_scythe/app.py
36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 |
|
GetRecord(**kwargs)
+
+Identify()
+
+Issue an Identify request.
+:rtype: :class:oaipmh_scythe.models.Identify
ListIdentifiers(ignore_deleted=False, **kwargs)
+
+Issue a ListIdentifiers request.
+:param ignore_deleted: If set to :obj:True
, the resulting
+ iterator will skip records flagged as deleted.
+:rtype: :class:oaipmh_scythe.iterator.BaseOAIIterator
src/oaipmh_scythe/app.py
ListMetadataFormats(**kwargs)
+
+Issue a ListMetadataFormats request.
+:rtype: :class:oaipmh_scythe.iterator.BaseOAIIterator
src/oaipmh_scythe/app.py
ListRecords(ignore_deleted=False, **kwargs)
+
+Issue a ListRecords request.
+:param ignore_deleted: If set to :obj:True
, the resulting
+ iterator will skip records flagged as deleted.
+:rtype: :class:oaipmh_scythe.iterator.BaseOAIIterator
src/oaipmh_scythe/app.py
ListSets(**kwargs)
+
+Issue a ListSets request.
+:rtype: :class:oaipmh_scythe.iterator.BaseOAIIterator
src/oaipmh_scythe/app.py
harvest(**kwargs)
+
+Make HTTP requests to the OAI server.
+:param kwargs: OAI HTTP parameters.
+:rtype: :class:oaipmh_scythe.OAIResponse
src/oaipmh_scythe/app.py
+ Bases: BaseOAIIterator
Iterator over OAI records/identifiers/sets transparently aggregated via +OAI-PMH.
+Can be used to conveniently iterate through the records of a repository.
+:param oaipmh_scythe: The Scythe object that issued the first request.
+:type oaipmh_scythe: :class:oaipmh_scythe.app.Scythe
+:param params: The OAI arguments.
+:type params: dict
+:param ignore_deleted: Flag for whether to ignore deleted records.
+:type ignore_deleted: bool
src/oaipmh_scythe/iterator.py
next()
+
+Return the next record/header/set.
+ +src/oaipmh_scythe/iterator.py
+ Bases: BaseOAIIterator
Iterator over OAI responses.
+ +src/oaipmh_scythe/iterator.py
next()
+
+Return the next response.
+ +src/oaipmh_scythe/iterator.py
Record objects represent single OAI records.
+ + +
+ Bases: OAIItem
Represents an OAI record.
+:param record_element: The XML element 'record'.
+:type record_element: :class:lxml.etree._Element
+:param strip_ns: Flag for whether to remove the namespaces from the
+ element names.
src/oaipmh_scythe/models.py
{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var Ha=/["'&<>]/;Un.exports=$a;function $a(e){var t=""+e,r=Ha.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i