oarepo-rdm 1.0.0.dev27__tar.gz

oarepo_rdm-1.0.0.dev27/.gitignore

@@ -0,0 +1,382 @@
+#
+# Python gitignore
+#
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+coverage.json
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.mypy.ini
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff.toml
+.ruff_cache/
+.mypy.ini
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# UV package management
+uv.lock
+
+#
+# Node.js gitignore
+#
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.*
+!.env.example
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Sveltekit cache directory
+.svelte-kit/
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Firebase cache directory
+.firebase/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Vite logs files
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+
+#
+# OARepo specific gitignore
+#
+.runner.sh
+.env-services
+.eslintrc.yaml
+.mypy.ini
+.ruff.toml
+
+#
+# Editors
+.vscode/
+.idea/
+*.swp
+*.swo
+*.swn
+*.sublime-workspace
+*.sublime-project
+*.kate-swp
+*.kate-swp.*
+*.komodoproject
+*.komodotools
+*.komodoide
+*.komodotools
+*.komodotools.*
+.DS_Store
+*.DS_Store?
+#

oarepo_rdm-1.0.0.dev27/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.4
+Name: oarepo-rdm
+Version: 1.0.0.dev27
+Project-URL: Homepage, https://github.com/oarepo/oarepo-rdm
+Author-email: Ronald Krist <krist@cesnet.cz>
+Requires-Python: <3.15,>=3.13
+Requires-Dist: graphlib
+Requires-Dist: oarepo-model<1.0.0,>=0.1.0dev17
+Requires-Dist: oarepo-runtime<3.0.0,>=2.0.0dev5
+Requires-Dist: oarepo-ui>=6.0.0dev1
+Requires-Dist: oarepo[rdm,tests]<15.0.0,>=14.0.0
+Provides-Extra: dev
+Requires-Dist: lxml-stubs; extra == 'dev'
+Requires-Dist: oarepo-invenio-typing-stubs<1.0.0,>=0.1.0dev0; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
+Provides-Extra: oarepo14
+Requires-Dist: oarepo[rdm,tests]<15.0.0,>=14.0.0; extra == 'oarepo14'
+Provides-Extra: tests
+Requires-Dist: pytest-invenio; extra == 'tests'
+Description-Content-Type: text/markdown
+
+# OARepo RDM
+
+Runtime extensions for integrating custom metadata models with [Invenio RDM](https://inveniosoftware.org/products/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
+
+```bash
+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/ext.py), [`oarepo_rdm/services/`](oarepo_rdm/services/)
+
+The package patches RDM service methods to enable unified operations across multiple metadata models:
+
+```python
+# 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/`](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:
+
+```python
+# 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/`](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/`](oarepo_rdm/model/presets/rdm/records/))
+- **Resources:** Custom resource configurations ([`resources/`](oarepo_rdm/model/presets/rdm/resources/))
+- **Services:** Custom service implementations ([`services/`](oarepo_rdm/model/presets/rdm/services/))
+
+### 4. RDM Metadata Presets
+
+**Source:** [`oarepo_rdm/model/presets/rdm_metadata/`](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/`](oarepo_rdm/oai/)
+
+Full OAI-PMH support with percolator-based set management:
+
+```python
+from oarepo_rdm.oai import OAIPMHPresets
+
+# Configure OAI-PMH for your model
+presets = OAIPMHPresets(
+    serializer=datacite_serializer,
+    config=oai_config
+)
+```
+
+**Components:**
+
+- Percolator-based OAI set filtering ([`percolator.py`](oarepo_rdm/oai/percolator.py))
+- DataCite and Dublin Core serializers ([`serializer.py`](oarepo_rdm/oai/serializer.py))
+- OpenSearch index templates for OAI ([`index_templates/`](oarepo_rdm/oai/index_templates/))
+- OAI percolator mappings ([`mappings/`](oarepo_rdm/oai/mappings/))
+
+### 6. PID System Fields
+
+**Source:** [`oarepo_rdm/records/systemfields/pid.py`](oarepo_rdm/records/systemfields/pid.py)
+
+Enhanced PID system fields that integrate with the multi-model architecture:
+
+```python
+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.
+
+```python
+# In your configuration
+RDM_PERMISSION_POLICY = MyUnifiedPermissionPolicy
+```
+
+### 8. Response Handlers
+
+**Source:** [`oarepo_rdm/resources/records/response_handlers.py`](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/`](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
+
+```bash
+# Clone repository
+git clone https://github.com/oarepo/oarepo-rdm.git
+cd oarepo-rdm
+
+./run.sh venv
+```
+
+### Running Tests
+
+```bash
+./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:
+
+```python
+[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](LICENSE) file for more details.
+
+## Links
+
+- Documentation: <https://github.com/oarepo/oarepo-rdm>
+- PyPI: <https://pypi.org/project/oarepo-rdm/>
+- Issues: <https://github.com/oarepo/oarepo-rdm/issues>
+- OARepo Project: <https://github.com/oarepo>
+
+## Acknowledgments
+
+This project builds upon [Invenio RDM](https://inveniosoftware.org/products/rdm/) and is developed as part of the OARepo ecosystem.