mex-common 0.62.0__tar.gz

mex_common-0.62.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Robert Koch-Institut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mex_common-0.62.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.1
+Name: mex-common
+Version: 0.62.0
+Summary: Common library for MEx python projects.
+Author-Email: MEx Team <mex@rki.de>
+License: MIT License
+         
+         Copyright (c) 2025 Robert Koch-Institut
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+         
+Project-URL: Repository, https://github.com/robert-koch-institut/mex-common
+Requires-Python: <3.12,>=3.11
+Requires-Dist: backoff<3,>=2
+Requires-Dist: click<9,>=8
+Requires-Dist: langdetect<2,>=1
+Requires-Dist: ldap3<3,>=2
+Requires-Dist: mex-model==4.1.0
+Requires-Dist: numpy<3,>=2
+Requires-Dist: pandas<3,>=2
+Requires-Dist: pyarrow<21,>=20
+Requires-Dist: pydantic-settings<2.8,>=2
+Requires-Dist: pydantic<2.10,>=2
+Requires-Dist: pytz<2024.2,>=2024
+Requires-Dist: requests<3,>=2
+Provides-Extra: dev
+Requires-Dist: ipdb>=0.13; extra == "dev"
+Requires-Dist: pandas-stubs>=2; extra == "dev"
+Requires-Dist: mypy>=1; extra == "dev"
+Requires-Dist: pytest-cov>=6; extra == "dev"
+Requires-Dist: pytest-random-order>=1; extra == "dev"
+Requires-Dist: pytest-xdist>=3; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.11; extra == "dev"
+Requires-Dist: sphinx>=8; extra == "dev"
+Requires-Dist: types-ldap3>=2; extra == "dev"
+Requires-Dist: types-pytz>=2025; extra == "dev"
+Requires-Dist: types-requests>=2; extra == "dev"
+Description-Content-Type: text/markdown
+
+# MEx common
+
+Common library for MEx python projects.
+
+[![cookiecutter](https://github.com/robert-koch-institut/mex-common/actions/workflows/cookiecutter.yml/badge.svg)](https://github.com/robert-koch-institut/mex-template)
+[![cve-scan](https://github.com/robert-koch-institut/mex-common/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/cve-scan.yml)
+[![documentation](https://github.com/robert-koch-institut/mex-common/actions/workflows/documentation.yml/badge.svg)](https://robert-koch-institut.github.io/mex-common)
+[![linting](https://github.com/robert-koch-institut/mex-common/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/linting.yml)
+[![open-code](https://github.com/robert-koch-institut/mex-common/actions/workflows/open-code.yml/badge.svg)](https://gitlab.opencode.de/robert-koch-institut/mex/mex-common)
+[![testing](https://github.com/robert-koch-institut/mex-common/actions/workflows/testing.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/testing.yml)
+
+## Project
+
+The Metadata Exchange (MEx) project is committed to improve the retrieval of RKI
+research data and projects. How? By focusing on metadata: instead of providing the
+actual research data directly, the MEx metadata catalog captures descriptive information
+about research data and activities. On this basis, we want to make the data FAIR[^1] so
+that it can be shared with others.
+
+Via MEx, metadata will be made findable, accessible and shareable, as well as available
+for further research. The goal is to get an overview of what research data is available,
+understand its context, and know what needs to be considered for subsequent use.
+
+RKI cooperated with D4L data4life gGmbH for a pilot phase where the vision of a
+FAIR metadata catalog was explored and concepts and prototypes were developed.
+The partnership has ended with the successful conclusion of the pilot phase.
+
+After an internal launch, the metadata will also be made publicly available and thus be
+available to external researchers as well as the interested (professional) public to
+find research data from the RKI.
+
+For further details, please consult our
+[project page](https://www.rki.de/DE/Aktuelles/Publikationen/Forschungsdaten/MEx/metadata-exchange-plattform-mex-node.html).
+
+[^1]: FAIR is referencing the so-called
+[FAIR data principles](https://www.go-fair.org/fair-principles/) – guidelines to make
+data Findable, Accessible, Interoperable and Reusable.
+
+**Contact** \
+For more information, please feel free to email us at [mex@rki.de](mailto:mex@rki.de).
+
+### Publisher
+
+**Robert Koch-Institut** \
+Nordufer 20 \
+13353 Berlin \
+Germany
+
+## Package
+
+The `mex-common` library is a software development toolkit that is used by multiple
+components within the MEx project. It contains utilities for building pipelines like a
+common commandline interface, logging and configuration setup. It also provides common
+auxiliary connectors that can be used to fetch data from external services and a
+re-usable implementation of the MEx metadata schema as pydantic models.
+
+## License
+
+This package is licensed under the [MIT license](/LICENSE). All other software
+components of the MEx project are open-sourced under the same license as well.
+
+## Development
+
+### Installation
+
+- on unix, consider using pyenv https://github.com/pyenv/pyenv
+  - get pyenv `curl https://pyenv.run | bash`
+  - install 3.11 `pyenv install 3.11`
+  - switch version `pyenv global 3.11`
+  - run `make install`
+- on windows, consider using pyenv-win https://pyenv-win.github.io/pyenv-win/
+  - follow https://pyenv-win.github.io/pyenv-win/#quick-start
+  - install 3.11 `pyenv install 3.11`
+  - switch version `pyenv global 3.11`
+  - run `.\mex.bat install`
+
+### Linting and testing
+
+- run all linters with `pdm lint`
+- run only unit tests with `pdm unit`
+- run unit and integration tests with `pdm test`
+
+### Updating dependencies
+
+- update boilerplate files with `cruft update`
+- update global requirements in `requirements.txt` manually
+- update git hooks with `pre-commit autoupdate`
+- update package dependencies using `pdm update-all`
+- update github actions in `.github/workflows/*.yml` manually
+
+### Creating release
+
+- run `pdm release RULE` to release a new version where RULE determines which part of
+  the version to update and is one of `major`, `minor`, `patch`.

mex_common-0.62.0/README.md

@@ -0,0 +1,94 @@
+# MEx common
+
+Common library for MEx python projects.
+
+[![cookiecutter](https://github.com/robert-koch-institut/mex-common/actions/workflows/cookiecutter.yml/badge.svg)](https://github.com/robert-koch-institut/mex-template)
+[![cve-scan](https://github.com/robert-koch-institut/mex-common/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/cve-scan.yml)
+[![documentation](https://github.com/robert-koch-institut/mex-common/actions/workflows/documentation.yml/badge.svg)](https://robert-koch-institut.github.io/mex-common)
+[![linting](https://github.com/robert-koch-institut/mex-common/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/linting.yml)
+[![open-code](https://github.com/robert-koch-institut/mex-common/actions/workflows/open-code.yml/badge.svg)](https://gitlab.opencode.de/robert-koch-institut/mex/mex-common)
+[![testing](https://github.com/robert-koch-institut/mex-common/actions/workflows/testing.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/testing.yml)
+
+## Project
+
+The Metadata Exchange (MEx) project is committed to improve the retrieval of RKI
+research data and projects. How? By focusing on metadata: instead of providing the
+actual research data directly, the MEx metadata catalog captures descriptive information
+about research data and activities. On this basis, we want to make the data FAIR[^1] so
+that it can be shared with others.
+
+Via MEx, metadata will be made findable, accessible and shareable, as well as available
+for further research. The goal is to get an overview of what research data is available,
+understand its context, and know what needs to be considered for subsequent use.
+
+RKI cooperated with D4L data4life gGmbH for a pilot phase where the vision of a
+FAIR metadata catalog was explored and concepts and prototypes were developed.
+The partnership has ended with the successful conclusion of the pilot phase.
+
+After an internal launch, the metadata will also be made publicly available and thus be
+available to external researchers as well as the interested (professional) public to
+find research data from the RKI.
+
+For further details, please consult our
+[project page](https://www.rki.de/DE/Aktuelles/Publikationen/Forschungsdaten/MEx/metadata-exchange-plattform-mex-node.html).
+
+[^1]: FAIR is referencing the so-called
+[FAIR data principles](https://www.go-fair.org/fair-principles/) – guidelines to make
+data Findable, Accessible, Interoperable and Reusable.
+
+**Contact** \
+For more information, please feel free to email us at [mex@rki.de](mailto:mex@rki.de).
+
+### Publisher
+
+**Robert Koch-Institut** \
+Nordufer 20 \
+13353 Berlin \
+Germany
+
+## Package
+
+The `mex-common` library is a software development toolkit that is used by multiple
+components within the MEx project. It contains utilities for building pipelines like a
+common commandline interface, logging and configuration setup. It also provides common
+auxiliary connectors that can be used to fetch data from external services and a
+re-usable implementation of the MEx metadata schema as pydantic models.
+
+## License
+
+This package is licensed under the [MIT license](/LICENSE). All other software
+components of the MEx project are open-sourced under the same license as well.
+
+## Development
+
+### Installation
+
+- on unix, consider using pyenv https://github.com/pyenv/pyenv
+  - get pyenv `curl https://pyenv.run | bash`
+  - install 3.11 `pyenv install 3.11`
+  - switch version `pyenv global 3.11`
+  - run `make install`
+- on windows, consider using pyenv-win https://pyenv-win.github.io/pyenv-win/
+  - follow https://pyenv-win.github.io/pyenv-win/#quick-start
+  - install 3.11 `pyenv install 3.11`
+  - switch version `pyenv global 3.11`
+  - run `.\mex.bat install`
+
+### Linting and testing
+
+- run all linters with `pdm lint`
+- run only unit tests with `pdm unit`
+- run unit and integration tests with `pdm test`
+
+### Updating dependencies
+
+- update boilerplate files with `cruft update`
+- update global requirements in `requirements.txt` manually
+- update git hooks with `pre-commit autoupdate`
+- update package dependencies using `pdm update-all`
+- update github actions in `.github/workflows/*.yml` manually
+
+### Creating release
+
+- run `pdm release RULE` to release a new version where RULE determines which part of
+  the version to update and is one of `major`, `minor`, `patch`.

mex_common-0.62.0/mex/__init__.py

@@ -0,0 +1,3 @@
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)

mex_common-0.62.0/mex/common/__init__.py

@@ -0,0 +1,8 @@
+from mex.common.identity.backend_api import BackendApiIdentityProvider
+from mex.common.identity.memory import MemoryIdentityProvider
+from mex.common.identity.registry import register_provider
+from mex.common.types import IdentityProvider
+
+# register the default providers shipped with mex-common
+register_provider(IdentityProvider.MEMORY, MemoryIdentityProvider)
+register_provider(IdentityProvider.BACKEND, BackendApiIdentityProvider)

mex_common-0.62.0/mex/common/backend_api/connector.py

@@ -0,0 +1,399 @@
+from typing import Any, TypeVar
+from urllib.parse import urljoin
+
+from requests.exceptions import HTTPError
+
+from mex.common.connector import HTTPConnector
+from mex.common.identity.models import Identity
+from mex.common.models import (
+    AnyExtractedModel,
+    AnyMergedModel,
+    AnyPreviewModel,
+    AnyRuleSetRequest,
+    AnyRuleSetResponse,
+    ExtractedOrganization,
+    ExtractedPerson,
+    ItemsContainer,
+    PaginatedItemsContainer,
+    PreviewModelTypeAdapter,
+    RuleSetResponseTypeAdapter,
+)
+from mex.common.settings import BaseSettings
+from mex.common.types import Identifier, MergedPrimarySourceIdentifier
+
+_IngestibleModelT = TypeVar(
+    "_IngestibleModelT", bound=AnyExtractedModel | AnyRuleSetResponse
+)
+
+
+class BackendApiConnector(HTTPConnector):
+    """Connector class to handle interaction with the Backend API."""
+
+    API_VERSION = "v0"
+
+    def _check_availability(self) -> None:
+        """Send a GET request to verify the API is available."""
+        self.request("GET", "_system/check")
+
+    def _set_authentication(self) -> None:
+        """Set the backend API key to all session headers."""
+        settings = BaseSettings.get()
+        self.session.headers["X-API-Key"] = settings.backend_api_key.get_secret_value()
+
+    def _set_url(self) -> None:
+        """Set the backend api url with the version path."""
+        settings = BaseSettings.get()
+        self.url = urljoin(str(settings.backend_api_url), self.API_VERSION)
+
+    def fetch_extracted_items(
+        self,
+        query_string: str | None,
+        stable_target_id: str | None,
+        entity_type: list[str] | None,
+        skip: int,
+        limit: int,
+    ) -> PaginatedItemsContainer[AnyExtractedModel]:
+        """Fetch extracted items that match the given set of filters.
+
+        Args:
+            query_string: Full-text search query
+            stable_target_id: The item's stableTargetId
+            entity_type: The item's entityType
+            skip: How many items to skip for pagination
+            limit: How many items to return in one page
+
+        Raises:
+            HTTPError: If search was not accepted, crashes or times out
+
+        Returns:
+            One page of extracted items and the total count that was matched
+        """
+        response = self.request(
+            method="GET",
+            endpoint="extracted-item",
+            params={
+                "q": query_string,
+                "stableTargetId": stable_target_id,
+                "entityType": entity_type,
+                "skip": str(skip),
+                "limit": str(limit),
+            },
+        )
+        return PaginatedItemsContainer[AnyExtractedModel].model_validate(response)
+
+    def fetch_merged_items(
+        self,
+        query_string: str | None,
+        entity_type: list[str] | None,
+        had_primary_source: list[str] | None,
+        skip: int,
+        limit: int,
+    ) -> PaginatedItemsContainer[AnyMergedModel]:
+        """Fetch merged items that match the given set of filters.
+
+        Args:
+            query_string: Full-text search query
+            entity_type: The items' entityType
+            had_primary_source: The items' hadPrimarySource
+            skip: How many items to skip for pagination
+            limit: How many items to return in one page
+
+        Raises:
+            HTTPError: If search was not accepted, crashes or times out
+
+        Returns:
+            One page of merged items and the total count that was matched
+        """
+        response = self.request(
+            method="GET",
+            endpoint="merged-item",
+            params={
+                "q": query_string,
+                "entityType": entity_type,
+                "hadPrimarySource": had_primary_source,
+                "skip": str(skip),
+                "limit": str(limit),
+            },
+        )
+        return PaginatedItemsContainer[AnyMergedModel].model_validate(response)
+
+    def get_merged_item(
+        self,
+        identifier: str,
+    ) -> AnyMergedModel:
+        """Return one merged item for the given `identifier`.
+
+        Args:
+            identifier: The merged item's identifier
+
+        Raises:
+            HTTPError: If no merged item was found
+
+        Returns:
+            A single merged item
+        """
+        # TODO(ND): stop-gap until backend has proper get merged item endpoint (MX-1669)
+        response = self.request(
+            method="GET",
+            endpoint="merged-item",
+            params={
+                "identifier": identifier,
+                "limit": "1",
+            },
+        )
+        response_model = PaginatedItemsContainer[AnyMergedModel].model_validate(
+            response
+        )
+        try:
+            return response_model.items[0]
+        except IndexError:
+            msg = "merged item was not found"
+            raise HTTPError(msg) from None
+
+    def preview_merged_item(
+        self,
+        stable_target_id: str,
+        rule_set: AnyRuleSetRequest,
+    ) -> AnyPreviewModel:
+        """Return a preview for merging the given rule-set with stored extracted items.
+
+        Args:
+            stable_target_id: The extracted items' `stableTargetId`
+            rule_set: A rule-set to use for previewing
+
+        Raises:
+            HTTPError: If preview produces errors, crashes or times out
+
+        Returns:
+            A single merged item
+        """
+        response = self.request(
+            method="POST",
+            endpoint=f"preview-item/{stable_target_id}",
+            payload=rule_set,
+        )
+        return PreviewModelTypeAdapter.validate_python(response)
+
+    def fetch_preview_items(
+        self,
+        query_string: str | None,
+        entity_type: list[str] | None,
+        had_primary_source: list[str] | None,
+        skip: int,
+        limit: int,
+    ) -> PaginatedItemsContainer[AnyPreviewModel]:
+        """Fetch merged item previews that match the given set of filters.
+
+        Args:
+            query_string: Full-text search query
+            entity_type: The items' entityType
+            had_primary_source: The items' hadPrimarySource
+            skip: How many items to skip for pagination
+            limit: How many items to return in one page
+
+        Raises:
+            HTTPError: If search was not accepted, crashes or times out
+
+        Returns:
+            One page of preview items and the total count that was matched
+        """
+        response = self.request(
+            method="GET",
+            endpoint="preview-item",
+            params={
+                "q": query_string,
+                "entityType": entity_type,
+                "hadPrimarySource": had_primary_source,
+                "skip": str(skip),
+                "limit": str(limit),
+            },
+        )
+        return PaginatedItemsContainer[AnyPreviewModel].model_validate(response)
+
+    def create_rule_set(
+        self,
+        rule_set: AnyRuleSetRequest,
+    ) -> AnyRuleSetResponse:
+        """Create a new rule set.
+
+        Args:
+            rule_set: New rule-set to create
+
+        Raises:
+            HTTPError: If the rule-set did not validate
+
+        Returns:
+            The newly created rule-set
+        """
+        response = self.request(method="POST", endpoint="rule-set", payload=rule_set)
+        return RuleSetResponseTypeAdapter.validate_python(response)
+
+    def get_rule_set(
+        self,
+        stable_target_id: str,
+    ) -> AnyRuleSetResponse:
+        """Return a triple of rules for the given `stableTargetId`.
+
+        Args:
+            stable_target_id: The merged item's identifier
+
+        Raises:
+            HTTPError: If no rule-set was found
+
+        Returns:
+            A set of three rules
+        """
+        response = self.request(
+            method="GET",
+            endpoint=f"rule-set/{stable_target_id}",
+        )
+        return RuleSetResponseTypeAdapter.validate_python(response)
+
+    def update_rule_set(
+        self, stable_target_id: str, rule_set: AnyRuleSetRequest
+    ) -> AnyRuleSetResponse:
+        """Update an existing rule set.
+
+        Args:
+            stable_target_id: The merged item's identifier
+            rule_set: The new rule-set contents
+
+        Raises:
+            HTTPError: If no rule-set was found
+
+        Returns:
+            A set of three rules
+        """
+        response = self.request(
+            method="PUT", endpoint=f"rule-set/{stable_target_id}", payload=rule_set
+        )
+        return RuleSetResponseTypeAdapter.validate_python(response)
+
+    def search_organization_in_wikidata(
+        self,
+        q: str,
+        offset: int = 0,
+        limit: int = 10,
+    ) -> PaginatedItemsContainer[ExtractedOrganization]:
+        """Search for organizations in wikidata.
+
+        Args:
+            q: Wikidata item ID or full URL
+            offset: The starting index for pagination
+            limit: The maximum number of results to return
+
+        Returns:
+            Paginated list of ExtractedOrganizations
+        """
+        response = self.request(
+            method="GET",
+            endpoint="wikidata",
+            params={"q": q, "offset": str(offset), "limit": str(limit)},
+        )
+        return PaginatedItemsContainer[ExtractedOrganization].model_validate(response)
+
+    def search_person_in_ldap(
+        self,
+        q: str,
+        offset: int = 0,
+        limit: int = 10,
+    ) -> PaginatedItemsContainer[ExtractedPerson]:
+        """Search for persons in LDAP.
+
+        Args:
+            q: The name of the person to be searched
+            offset: The starting index for pagination
+            limit: The maximum number of results to return
+
+        Returns:
+            Paginated list of ExtractedPersons
+        """
+        response = self.request(
+            method="GET",
+            endpoint="ldap",
+            params={"q": q, "offset": str(offset), "limit": str(limit)},
+        )
+        return PaginatedItemsContainer[ExtractedPerson].model_validate(response)
+
+    def search_person_in_orcid(
+        self,
+        q: str,
+        offset: int = 0,
+        limit: int = 10,
+    ) -> PaginatedItemsContainer[ExtractedPerson]:
+        """Search for persons in orcid.
+
+        Args:
+            q: The name of the person to be searched
+            offset: The starting index for pagination
+            limit: The maximum number of results to return
+
+        Returns:
+            Paginated list of ExtractedPersons
+        """
+        response = self.request(
+            method="GET",
+            endpoint="orcid",
+            params={"q": q, "offset": str(offset), "limit": str(limit)},
+        )
+        return PaginatedItemsContainer[ExtractedPerson].model_validate(response)
+
+    def assign_identity(
+        self,
+        had_primary_source: MergedPrimarySourceIdentifier,
+        identifier_in_primary_source: str,
+    ) -> Identity:
+        """Find an Identity in a database or assign a new one."""
+        response = self.request(
+            "POST",
+            "identity",
+            {
+                "hadPrimarySource": had_primary_source,
+                "identifierInPrimarySource": identifier_in_primary_source,
+            },
+        )
+        return Identity.model_validate(response)
+
+    def fetch_identities(
+        self,
+        had_primary_source: Identifier | None = None,
+        identifier_in_primary_source: str | None = None,
+        stable_target_id: Identifier | None = None,
+    ) -> ItemsContainer[Identity]:
+        """Find Identity instances matching the given filters.
+
+        Either provide `stableTargetId` or `hadPrimarySource`
+        and `identifierInPrimarySource` together to get a unique result.
+        """
+        connector = BackendApiConnector.get()
+        response = connector.request(
+            "GET",
+            "identity",
+            params={
+                "hadPrimarySource": had_primary_source,
+                "identifierInPrimarySource": identifier_in_primary_source,
+                "stableTargetId": stable_target_id,
+            },
+        )
+        return ItemsContainer[Identity].model_validate(response)
+
+    def ingest(
+        self,
+        ingestible_models: list[_IngestibleModelT],
+        **kwargs: Any,  # noqa: ANN401
+    ) -> None:
+        """Post extracted models or rule-sets to the backend in bulk.
+
+        Args:
+            ingestible_models: Extracted models or rule-sets to ingest
+            kwargs: Further keyword arguments passed to `requests`
+
+        Raises:
+            HTTPError: If post was not accepted, crashes or times out
+        """
+        self.request(
+            method="POST",
+            endpoint="ingest",
+            payload=ItemsContainer[_IngestibleModelT](items=ingestible_models),
+            **kwargs,
+        )