oarepo-runtime 1.10.3__tar.gz → 2.0.0.dev4__tar.gz

oarepo_runtime-2.0.0.dev4/.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_runtime-1.10.3/oarepo_runtime.egg-info → oarepo_runtime-2.0.0.dev4}/PKG-INFO

@@ -1,29 +1,18 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 1.10.3
+Version: 2.0.0.dev4
 Summary: A set of runtime extensions of Invenio repository
-Description-Content-Type: text/markdown
+Project-URL: Homepage, https://github.com/oarepo/oarepo-runtime
+License-Expression: MIT
 License-File: LICENSE
-Requires-Dist: marshmallow
-Requires-Dist: langcodes
-Requires-Dist: pyyaml
-Requires-Dist: openpyxl
-Requires-Dist: flask-babelex
-Requires-Dist: deepmerge
-Requires-Dist: tqdm
-Requires-Dist: deprecated
-Requires-Dist: idutils
+Requires-Python: <3.14,>=3.13
+Requires-Dist: langcodes>=3.5.0
+Requires-Dist: oarepo[rdm,tests]<14,>=13
 Provides-Extra: dev
-Requires-Dist: pytest>=7.1.2; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: autoflake; extra == "dev"
-Requires-Dist: oarepo-tools; extra == "dev"
+Requires-Dist: pytest>=7.1.2; extra == 'dev'
 Provides-Extra: tests
-Requires-Dist: pytest>=7.1.2; extra == "tests"
-Requires-Dist: pytest-oarepo; extra == "tests"
-Requires-Dist: psutil; extra == "tests"
-Dynamic: license-file
+Requires-Dist: pytest>=7.1.2; extra == 'tests'
+Description-Content-Type: text/markdown
 
 # OARepo runtime
 
@@ -172,4 +161,4 @@ Will print/write to file a json with the following format:
 ```
 ```json
 
-```
+```

oarepo_runtime-2.0.0.dev4/oarepo_runtime/__init__.py

@@ -0,0 +1,24 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+
+"""OARepo Runtime package.
+
+This package provides support for custom fields identification and iteration and `invenio oarepo cf init`
+initialization tool for customfields.
+"""
+
+from __future__ import annotations
+
+from .api import Model
+from .ext import OARepoRuntime
+from .proxies import current_runtime
+
+__version__ = "2.0.0dev4"
+
+__all__ = ("Model", "OARepoRuntime", "__version__", "current_runtime")

oarepo_runtime-2.0.0.dev4/oarepo_runtime/api.py

@@ -0,0 +1,210 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+
+"""Runtime API classes that are returned from the current_runtime instance."""
+
+from __future__ import annotations
+
+import dataclasses
+from functools import cached_property
+from typing import TYPE_CHECKING, cast
+
+from flask import current_app
+from invenio_base.utils import obj_or_import_string
+from invenio_records_resources.proxies import current_service_registry
+
+if TYPE_CHECKING:
+    from flask_babel.speaklater import LazyString
+    from flask_resources.responses import ResponseHandler
+    from flask_resources.serializers import BaseSerializer
+    from invenio_drafts_resources.records.api import Draft
+    from invenio_records_resources.records.api import RecordBase
+    from invenio_records_resources.resources.records.config import RecordResourceConfig
+    from invenio_records_resources.resources.records.resource import RecordResource
+    from invenio_records_resources.services import RecordService, RecordServiceConfig
+
+
+@dataclasses.dataclass
+class Export:
+    """Configuration of an export format.
+
+    Exports are shown on the record landing page and user can download them.
+    """
+
+    name: LazyString
+    """Name of the export format, human readable."""
+
+    mimetype: str
+    """MIME type of the export format."""
+
+    serializer: BaseSerializer
+    """Serializer used to serialize the record into the export format."""
+
+    display: bool = True
+    """Whether the export format is displayed in the UI."""
+
+    oai_metadata_prefix: str | None = None
+    """OAI metadata prefix, if applicable. If not set, the export can not be used in OAI-PMH responses."""
+
+    oai_schema: str | None = None
+    """OAI schema, if applicable. If not set, the export can not be used in OAI-PMH responses."""
+
+    oai_namespace: str | None = None
+    """OAI namespace, if applicable. If not set, the export can not be used in OAI-PMH responses."""
+
+
+class Model[
+    S: RecordService = RecordService,
+    C: RecordServiceConfig = RecordServiceConfig,
+    R: RecordBase = RecordBase,
+    D: Draft = Draft,
+    # not sure why this is flagged by pyright as an error
+    RR: RecordResource = RecordResource,  # pyright: ignore[reportGeneralTypeIssues]
+    RC: RecordResourceConfig = RecordResourceConfig,
+]:
+    """Model configuration.
+
+    Every model in oarepo repository must have this configuration which must be
+    registered in the `oarepo.runtime` extension via the OAREPO_MODELS config
+    variable.
+    """
+
+    name: str | LazyString
+    """Name of the model, human readable."""
+
+    version: str
+    """Version of the model, should be a valid semantic version."""
+
+    description: str | LazyString | None = None
+    """Description of the model, human readable."""
+
+    records_alias_enabled: bool = False
+    """Whether the records alias is enabled for this model. Such models will be searchable
+    via the `/api/records` endpoint."""
+
+    def __init__(  # noqa: PLR0913 more attributes as we are creating a config
+        self,
+        name: str | LazyString,
+        version: str,
+        service: str | S,
+        resource_config: RC | str,
+        # params with default values
+        service_config: C | None = None,
+        description: str | LazyString | None = None,
+        record: type[R] | None = None,
+        draft: type[D] | None = None,
+        resource: str | RR = "invenio_records_resources.resources.records.resource.RecordResource",
+        exports: list[Export] | None = None,
+        records_alias_enabled: bool = True,
+    ):
+        """Initialize the model configuration.
+
+        :param name: Name of the model, human readable.
+        :param version: Version of the model, should be a valid semantic version.
+        :param description: Description of the model, human readable.
+        :param service: Name of the service inside the `current_service_registry` or
+            a configured service instance.
+        :param service_config: Service configuration, if not provided,
+            if will be taken from the service.
+        :param record: Record class, if not provided, it will be taken from the service
+            configuration.
+        :param draft: Draft class, if not provided, it will be taken from the service
+            configuration.
+        :param resource: Resource class or string import path to the resource class.
+            If not provided, it will be taken from the service configuration.
+        :param resource_config: Resource configuration, if not provided, it will be
+            taken from the resource class.
+        :param exports: List of export formats that can be used to export the record.
+            If not provided, no exports are available.
+        :param records_alias_enabled: Whether the records alias is enabled for this model.
+            Such models will be searchable via the `/api/records` endpoint.
+        """
+        self.name = name
+        self.version = version
+        self.description = description
+        self.records_alias_enabled = records_alias_enabled
+
+        # lazy getters ...
+        self._record = record
+        self._draft = draft
+        self._service = service
+        self._service_config = service_config
+        self._resource = resource
+        self._resource_config = resource_config
+        self._exports = exports or []
+
+    @property
+    def service(self) -> S:
+        """Get the service."""
+        if isinstance(self._service, str):
+            return cast(
+                "S",
+                current_service_registry.get(self._service),  # type: ignore[attr-defined]
+            )
+        return self._service
+
+    @property
+    def service_config(self) -> C:
+        """Get the service configuration."""
+        if self._service_config is not None:
+            return self._service_config
+        return cast("C", self.service.config)
+
+    @property
+    def record_cls(self) -> type[R]:
+        """Get the record class."""
+        if self._record is None:
+            return cast("type[R]", self.service.config.record_cls)
+        return self._record
+
+    @property
+    def draft_cls(self) -> type[D] | None:
+        """Get the draft class."""
+        if self._draft is None:
+            if hasattr(self.service.config, "draft_cls"):
+                return cast("type[D]", self.service.config.draft_cls)
+            return None
+        return self._draft
+
+    @cached_property
+    def resource_config(self) -> RC:
+        """Get the resource configuration."""
+        if isinstance(self._resource_config, str):
+            resource_config_class: type[RC] = cast("type[RC]", obj_or_import_string(self._resource_config))
+            # need to import it here to avoid circular import issues
+            from .config import build_config
+
+            return build_config(resource_config_class, current_app)
+        return self._resource_config
+
+    @cached_property
+    def resource(self) -> RR:
+        """Get the resource."""
+        if isinstance(self._resource, str):
+            resource_class = obj_or_import_string(self._resource)
+            if resource_class is None:
+                raise ValueError(f"Resource class {self._resource} can not be None.")
+            return cast(
+                "RR",
+                resource_class(
+                    service=self.service,
+                    config=self.resource_config,
+                ),
+            )
+        return self._resource
+
+    @property
+    def exports(self) -> list[Export]:
+        """Get all exportable response handlers."""
+        return self._exports
+
+    @property
+    def response_handlers(self) -> dict[str, ResponseHandler]:
+        """Get all response handlers from the resource configuration."""
+        return cast("dict[str, ResponseHandler]", self.resource_config.response_handlers)

oarepo_runtime-2.0.0.dev4/oarepo_runtime/cli/__init__.py

@@ -0,0 +1,11 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+"""OAREPO Runtime CLI module."""
+
+from __future__ import annotations

oarepo_runtime-2.0.0.dev4/oarepo_runtime/cli/search.py

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+"""OARepo extensions to the index command."""
+
+from __future__ import annotations
+
+import click
+from flask.cli import with_appcontext
+from invenio_search.cli import index, search_version_check
+from invenio_search.cli import init as original_init
+
+from oarepo_runtime.services.records.mapping import update_all_records_mappings
+
+
+@index.command()
+@click.option("--force", is_flag=True, default=False)
+@with_appcontext
+@search_version_check
+@click.pass_context
+def init(ctx: click.Context, force: bool) -> None:
+    """Initialize registered aliases and mappings.
+
+    This command initializes the search indices by creating templates, component templates,
+    index templates, and the actual indices. It will also create all dynamic mappings
+    defined inside the models.
+    """
+    ctx.invoke(original_init, force=force)
+    update_all_records_mappings()