Skip to main content

oaipmh-scythe: A Scythe for harvesting OAI-PMH repositories

Welcome to oaipmh-scythe, an updated and modernized version of the original sickle, now with additional features and ongoing maintenance.

CI ci coverage codeql
Package pypi-version pypi-python-versions all-downloads monthly-downloads
Meta doi OpenSSF Scorecard uv ruff ty prek License

oaipmh-scythe 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 oaipmh_scythe import Scythe

with Scythe("https://zenodo.org/oai2d") as scythe:
    records = scythe.list_records()
    next(records)
# <Record oai:zenodo.org:4574771>

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

Requirements

Python >= 3.10

oaipmh-scythe is built with:

  • httpx2 for issuing HTTP requests
  • lxml for parsing XML responses

Installation

You can install oaipmh-scythe from PyPI using uv:

uv add oaipmh-scythe

or with pip:

python -m pip install oaipmh-scythe

Documentation

The documentation is made with Material for MkDocs and is hosted by GitHub Pages.

Similar Projects

There are a couple of similar projects available on PyPI and GitHub, e.g. via the topics oai-pmh and oai-pmh-client. Among them are these implementations in Python:

Project Description Last commit
sickle oaipmh-scythe is a fork of sickle last-commit
pyoai sickle was inspired by pyoai last-commit
pyoaiharvester oai-pmh harvester CLI last-commit
ddblabs-ometha oai-pmh harvester with CLI and TUI last-commit
oai-harvest uses pyoai internally last-commit
oai-pmh-harvester uses sickle internally last-commit

There are also similar projects available in Java and PHP.

Acknowledgments

This is a fork of sickle which was originally written by Mathias Loesch.

License

oaipmh-scythe is distributed under the terms of the BSD license.

Download files

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

Source Distribution

oaipmh_scythe-0.15.0.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oaipmh_scythe-0.15.0-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file oaipmh_scythe-0.15.0.tar.gz.

File metadata

  • Download URL: oaipmh_scythe-0.15.0.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for oaipmh_scythe-0.15.0.tar.gz
Algorithm Hash digest
SHA256 f260410d95fc106794f389002651ca94b2fa9b1a7c8d8c14536859b240ba09ca
MD5 9d48e5154bc7856ee4fd6db862c39444
BLAKE2b-256 db6df3e0704e5111b168e9606b14c34b7a081239da3f62f39c1a4c6e0dbc18e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for oaipmh_scythe-0.15.0.tar.gz:

Publisher: publish.yml on afuetterer/oaipmh-scythe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file oaipmh_scythe-0.15.0-py3-none-any.whl.

File metadata

  • Download URL: oaipmh_scythe-0.15.0-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for oaipmh_scythe-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ed264c081db553640089dd47acf167935dd5e7fcf6cbfcf797af677321d876f
MD5 dd15d27bc5a4a6f9963cf94970965195
BLAKE2b-256 57a3c3e6ff08af24a995959ada015b23b483ee4b9d39fde877ce07d47561cb33

See more details on using hashes here.

Provenance

The following attestation bundles were made for oaipmh_scythe-0.15.0-py3-none-any.whl:

Publisher: publish.yml on afuetterer/oaipmh-scythe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.16.0

2 files

0.15.2

2 files

0.15.1

2 files

This release

0.15.0 This release

2 files

0.14.4

2 files

0.14.3

2 files

0.14.2

2 files

0.14.1

2 files

0.14.0

2 files

0.13.0

2 files

0.12.1

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page