Skip to main content

A Scythe for harvesting OAI-PMH repositories.

Project description

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 pre-commit.ci status ci coverage codeql
Docs docs
Package pypi-version pypi-python-versions all-downloads monthly-downloads
Meta OpenSSF Scorecard hatch ruff mypy 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:

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

Installation

You can install oaipmh-scythe via pip from PyPI:

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.

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

oaipmh_scythe-0.13.0.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

oaipmh_scythe-0.13.0-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oaipmh_scythe-0.13.0.tar.gz
  • Upload date:
  • Size: 28.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for oaipmh_scythe-0.13.0.tar.gz
Algorithm Hash digest
SHA256 19ad43b0a223d87036af17c3919f1132db60bc561eb8d1713a2f85e736ad208f
MD5 c35928d9accba206b5602f0104030b4c
BLAKE2b-256 65b2c02f41ec7b876dc0abe214d47c37e5070e718f9ffe216de83117a303d6ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for oaipmh_scythe-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6630ce9ddbac774b8983cac57d1ce6403f6a9b6a4be0e5495160be23e44ecceb
MD5 3c05aa8ede96ec9f07f95d8c386430bc
BLAKE2b-256 6b1a2ffc6da5b5a7e3e67788911438b82eca8a46e07d3406fde97a7585a612f2

See more details on using hashes here.

Supported by

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