Skip to main content

A lightweight OAI client library for Python

Project description

Sickle: OAI-PMH for Humans

Sickle is a lightweight OAI-PMH client library written in Python. It has been designed for conveniently retrieving data from OAI interfaces the Pythonic way:

>>> from sickle import Sickle
>>> sickle = Sickle('http://elis.da.ulcc.ac.uk/cgi/oai2')
>>> records = sickle.ListRecords(metadataPrefix='oai_dc')
>>> records.next()
<Record oai:eprints.rclis.org:4088>

Features

  • Easy harvesting of OAI-compliant interfaces

  • Support for all six OAI verbs

  • Convenient object representations of OAI items (records, headers, sets, …)

  • Automatic de-serialization of Dublin Core-encoded metadata payloads to Python dictionaries

  • Option for ignoring deleted items

Installation

pip install sickle

Dependencies:

Documentation

Documentation is available at Read the Docs

Development

Changelog

Version 0.5

Novemver 12, 2015

  • support for Python 3

  • consider resumption tokens with empty tag bodies

Version 0.4

May 31, 2015

  • bug fix: resumptionToken parameter is exclusive

  • added support for harvesting complete OAI-XML responses

Version 0.3

April 17, 2013

  • added support for protected OAI interfaces (basic authentication)

  • made class mapping for OAI elements configurable

  • added options for HTTP timeout and max retries

  • added handling of HTTP 503 responses

Version 0.2

February 26, 2013

  • OAI items are now represented as their own classes instead of XML elements

  • library raises OAI-specific exceptions

  • made lxml a required dependency

Version 0.1

February 20, 2013

First public release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Sickle-0.5.tar.gz (43.5 kB view details)

Uploaded Source

File details

Details for the file Sickle-0.5.tar.gz.

File metadata

  • Download URL: Sickle-0.5.tar.gz
  • Upload date:
  • Size: 43.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Sickle-0.5.tar.gz
Algorithm Hash digest
SHA256 85f4b187cd4cc43b8d1df0a19693cb128092b23acc1a9a2f618184fafc41af37
MD5 9c93e7f3e0db98ab1a18107dfa096082
BLAKE2b-256 b3d20eb042c0e1760b4426cd8a4a4c5d8e73f614d6f5f4c0be41bd60305811ac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page