Skip to main content

OARepo RDM

Runtime extensions for integrating custom metadata models with Invenio RDM.

Overview

This package provides a set of runtime patches that enable the RDM service to work seamlessly with different metadata models. It extends the standard Invenio RDM functionality by:

  • Patching RDM service methods (search, search_drafts, scan, read) to search and operate across multiple models
  • Delegating PID-based method calls to specialized per-model services
  • Modifying the PID context of RDMRecord/RDMDraft to return specialized record instances on resolve
  • Enabling registration of custom services/resources in place of default RDM ones

This package depends on OARepo patches to invenio_rdm_records that provide the infrastructure for registering custom service/resource implementations.

Installation

pip install oarepo-rdm

Requirements

  • Python 3.13+
  • Invenio 14.x
  • oarepo-runtime >= 2.0.0dev5
  • oarepo-model >= 0.1.0dev17

Key Features

1. Multi-Model Service Integration

Source: oarepo_rdm/ext.py, oarepo_rdm/services/

The package patches RDM service methods to enable unified operations across multiple metadata models:

# The patched service can search across all registered models
results = rdm_service.search(identity=identity)

# PID-based operations are delegated to model-specific services
record = rdm_service.read(identity=identity, id_=record_id)

Patched methods:

  • search - Searches across all registered models
  • search_drafts - Searches draft records across models
  • scan - Scans records across models
  • read - Delegates to specialized service based on record PID

2. Specialized Record Resolution

Source: oarepo_rdm/records/

The PID context is patched so that resolving a PID returns an instance of the specialized record class rather than the generic RDM record:

# Resolving a PID returns the model-specific record class
record = pid.resolve()  # Returns MyCustomRecord instance

This ensures that model-specific behavior and fields are available when working with resolved records.

3. Custom Service and Resource Registration

Source: oarepo_rdm/model/presets/rdm/

The package provides infrastructure for registering custom services and resources for specific metadata models:

  • Records: Custom record and draft implementations (records/)
  • Resources: Custom resource configurations (resources/)
  • Services: Custom service implementations (services/)

4. RDM Metadata Presets

Source: oarepo_rdm/model/presets/rdm_metadata/

Pre-configured RDM metadata elements and schemas:

  • rdm_elements.yaml - Reusable RDM metadata field definitions
  • rdm.yaml - Complete RDM metadata schema preset

These presets provide a starting point for creating RDM-compatible custom models.

5. OAI-PMH Integration

Source: oarepo_rdm/oai/

Full OAI-PMH support with percolator-based set management:

from oarepo_rdm.oai import OAIPMHPresets

# Configure OAI-PMH for your model
presets = OAIPMHPresets(serializer=datacite_serializer, config=oai_config)

Components:

6. PID System Fields

Source: oarepo_rdm/records/systemfields/pid.py

Enhanced PID system fields that integrate with the multi-model architecture:

from oarepo_rdm.records.systemfields import OARepoPIDField


class MyRecord(RDMRecord):
    pid = OARepoPIDField()

7. Unified Permission Policy

Source: Configuration via RDM_PERMISSION_POLICY

For performance reasons, permissions for search and scan operations are evaluated at the RDM records level, not on the specialized-service layer. This means that the permissions defined for the RDM records service apply to all requests, regardless of which specialized service is handling the request.

Important: All models must use the same permission policy, configured via the RDM_PERMISSION_POLICY configuration variable.

# In your configuration
RDM_PERMISSION_POLICY = MyUnifiedPermissionPolicy

8. Response Handlers

Source: oarepo_rdm/resources/records/response_handlers.py

Custom response handlers for RDM resources that properly handle multi-model scenarios.

9. Internationalization Support

Source: oarepo_rdm/i18n/

Full i18n support with translations for Czech and English:

  • Message catalogs for UI elements
  • Webpack integration for frontend translations
  • Semantic UI translation bundles

Development

Setup

# Clone repository
git clone https://github.com/oarepo/oarepo-rdm.git
cd oarepo-rdm

./run.sh venv

Running Tests

./run.sh test

The test suite includes:

  • RDM CRUD operations (test_rdm_crud.py)
  • Search functionality (test_search.py, test_search_drafts.py)
  • PID resolution (test_pid.py)
  • OAI-PMH integration (test_oai.py)
  • Resource endpoints (test_resources.py)
  • Service tasks (test_service_tasks.py)
  • Secret links (test_secret_links.py)
  • Runtime model behavior (test_runtime_model.py)

Entry Points

The package registers several Invenio entry points:

[project.entry-points."invenio_config.module"]
oarepo_rdm = "oarepo_rdm.initial_config"

[project.entry-points."invenio_base.apps"]
invenio_rdm_records = "invenio_rdm_records.ext:InvenioRDMRecords"
oarepo_rdm = "oarepo_rdm.ext:OARepoRDM"

[project.entry-points."invenio_base.api_apps"]
invenio_rdm_records = "invenio_rdm_records.ext:InvenioRDMRecords"
oarepo_rdm = "oarepo_rdm.ext:OARepoRDM"

[project.entry-points."invenio_base.api_blueprints"]
invenio_rdm_records = "invenio_rdm_records.views:create_records_bp"
# ... and more RDM blueprints

[project.entry-points."invenio_base.finalize_app"]
invenio_rdm_records = "invenio_rdm_records.ext:finalize_app"
oarepo_rdm = "oarepo_rdm.ext:finalize_app"

[project.entry-points."invenio_search.index_templates"]
oarepo_rdm_oai = "oarepo_rdm.oai.index_templates"

[project.entry-points."invenio_search.mappings"]
oarepo_rdm_oai = "oarepo_rdm.oai.mappings"

[project.entry-points."oarepo.cli.search.init"]
install_percollators = "oarepo_rdm.oai.percolator:init_percolators"

License

Copyright (c) 2020-2025 CESNET z.s.p.o.

OARepo RDM is free software; you can redistribute it and/or modify it under the terms of the MIT License. See LICENSE file for more details.

Acknowledgments

This project builds upon Invenio RDM and is developed as part of the OARepo ecosystem.

Metadata

Release files for oarepo-rdm 9.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oarepo-rdm 9.1.3
File Size Uploaded Provenance Actions
oarepo_rdm-9.1.3.tar.gz 56.6 kB Without provenance Details for oarepo_rdm-9.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for oarepo-rdm 9.1.3
File Interpreter ABI Platform Actions
oarepo_rdm-9.1.3-py3-none-any.whl Python 3 none any Details for oarepo_rdm-9.1.3-py3-none-any.whl

Total release size: 174.0 kB

Release files / oarepo_rdm-9.1.3.tar.gz

Download URL oarepo_rdm-9.1.3.tar.gz
Size 56.6 kB
Tags Source
SHA-256 checksum
How to use checksums
06f7c1f166905923a906ff9b2187c5ad061c24a8b0b6801f664316d06441b982
BLAKE2b-256 checksum
How to use checksums
1f64aa6b1be4c61e8ab10b6dbfa947851ffc17e6b82b2ff0fe89e109caee0824
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / oarepo_rdm-9.1.3-py3-none-any.whl

Download URL oarepo_rdm-9.1.3-py3-none-any.whl
Size 117.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
87fef1247d650e70cd533d98b84b30b51e8c9ac7d12245e137f7738de3360c48
BLAKE2b-256 checksum
How to use checksums
f9f6a363fb251ad5135541f586889ec5d0813598409c8bd37a574fa0b0bf1fe7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for oarepo-rdm 9.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

9.1.3 This release

2 release files No provenance

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