dhclients 0.1.0__tar.gz

dhclients-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: dhclients
+Version: 0.1.0
+Summary: DARIAH Python client library for repository.dariah.de access.
+Author: Stefan Hynek, Ubbo Veentjer
+Author-email: Stefan Hynek <hynek@sub.uni-goettingen.de>, Ubbo Veentjer <veentjer@sub.uni-goettingen.de>
+License-Expression: LGPL-3.0-or-later
+Requires-Dist: requests>=2.34.2
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: 2026 Georg-August-Universität Göttingen
+
+SPDX-License-Identifier: CC0-1.0
+-->
+
+# DHRep Python clients
+
+The DHRep Python clients provide access to the [DARIAH Repository](https://repository.de.dariah.eu/)
+services [API](https://doc.repository.de.dariah.eu/).
+
+## Installation and Usage
+
+```sh
+pip install dhclients
+```
+
+## Development
+
+### Pre-Commit
+
+install pre-commmit
+
+```sh
+uv tool install pre-commit --with pre-commit-uv
+uv run pre-commit install
+```
+
+
+### Running integration tests
+
+We run integration tests against the dev repo (trep)
+
+Get your auth token by log in on publikator: https://trep.de.dariah.eu/publikator/mainView
+click on "Show storage token", copy your token and add to env
+
+```sh
+DHREP_ENDPOINT=development DARIAH_STORAGE_TOKEN=my-secret-token-here uv run pytest --integration
+```

dhclients-0.1.0/README.md

@@ -0,0 +1,39 @@
+<!--
+SPDX-FileCopyrightText: 2026 Georg-August-Universität Göttingen
+
+SPDX-License-Identifier: CC0-1.0
+-->
+
+# DHRep Python clients
+
+The DHRep Python clients provide access to the [DARIAH Repository](https://repository.de.dariah.eu/)
+services [API](https://doc.repository.de.dariah.eu/).
+
+## Installation and Usage
+
+```sh
+pip install dhclients
+```
+
+## Development
+
+### Pre-Commit
+
+install pre-commmit
+
+```sh
+uv tool install pre-commit --with pre-commit-uv
+uv run pre-commit install
+```
+
+
+### Running integration tests
+
+We run integration tests against the dev repo (trep)
+
+Get your auth token by log in on publikator: https://trep.de.dariah.eu/publikator/mainView
+click on "Show storage token", copy your token and add to env
+
+```sh
+DHREP_ENDPOINT=development DARIAH_STORAGE_TOKEN=my-secret-token-here uv run pytest --integration
+```

dhclients-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+# SPDX-FileCopyrightText: 2026 Georg-August-Universität Göttingen
+#
+# SPDX-License-Identifier: CC0-1.0
+
+
+[project]
+name = "dhclients"
+version = "0.1.0"
+description = "DARIAH Python client library for repository.dariah.de access."
+readme = "README.md"
+license = "LGPL-3.0-or-later"
+authors = [
+    { name = "Stefan Hynek", email = "hynek@sub.uni-goettingen.de" },
+    { name = "Ubbo Veentjer", email = "veentjer@sub.uni-goettingen.de" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "requests>=2.34.2",
+]
+
+[dependency-groups]
+dev = [
+    "coverage>=7.14.3",
+    "pytest>=9.0.3",
+    "python-semantic-release>=10.5.3",
+    "requests-mock>=1.12.1",
+    "ruff>=0.15.14",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.13,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.semantic_release]
+build_command = """
+  uv lock --upgrade-package "$PACKAGE_NAME"
+  uv build
+"""
+version_toml = ["pyproject.toml:project.version"]
+version_variables = [
+  "src/dhclients/__init__.py:__version__",
+]
+
+allow_zero_version = true
+tag_format = "v{version}"
+
+[tool.semantic_release.remote]
+type = "gitlab"
+
+[tool.ruff]
+exclude = [
+    "build",
+    "venv",
+]
+
+line-length = 100
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.pydoclint]
+style = 'google'
+skip-checking-raises = true
+allow-init-docstring = true
+check-return-types = false # TODO: check auth.py zeep return types

dhclients-0.1.0/src/dhclients/__init__.py

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2026 Georg-August-Universität Göttingen
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+__version__ = '0.1.0'

dhclients-0.1.0/src/dhclients/config.py

@@ -0,0 +1,85 @@
+# SPDX-FileCopyrightText: 2026 Georg-August-Universität Göttingen
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import logging
+from typing import Optional
+
+logger = logging.getLogger(__name__)
+
+DEFAULT_TIMEOUT: float = 120.00
+
+ENDPOINTS: dict = {
+    'production': {
+        'storage': 'https://cdstar.de.dariah.eu/dariah',
+        'publish': 'https://repository.de.dariah.eu/1.0/dhpublish',
+    },
+    'development': {
+        'storage': 'https://cdstar.de.dariah.eu/test/dariah',
+        'publish': 'https://trep.de.dariah.eu/1.0/dhpublish',
+    },
+    'test': {
+        'storage': 'https://cdstar.de.dariah.eu/test/dariah',
+        'publish': 'https://dhrepworkshop.de.dariah.eu/1.0/dhpublish',
+    },
+}
+
+
+class DhrepConfig:
+    def __init__(
+        self,
+        endpoint: Optional[str] = 'production',
+        storage_override: Optional[str] = '',
+        publish_override: Optional[str] = '',
+    ) -> None:
+        """DHrep Service Endpoint Configuration.
+
+        Overwrite the endpoint string to connect to other servers, e.g.:
+        * Test-Server: 'test'
+        * Development-Server: 'development'
+
+        It is also possible to override the storage url and the publish url separately
+
+        Args:
+            endpoint (Optional[str]): DHrep server. Defaults to 'production'.
+            storage_override (Optional[str]): overide storage url from ENDPOINTS dict. defaults to ''
+            publish_override (Optional[str]): overide publish url from ENDPOINTS dict. defaults to ''
+        """
+
+        if endpoint not in ENDPOINTS:
+            raise ConfigException('Endpoint config invalid')
+
+        if not isinstance(storage_override, str) or storage_override == '':
+            self._storage = ENDPOINTS[endpoint]['storage']
+        else:
+            if storage_override.endswith('/'):
+                storage_override = storage_override[:-1]
+                logger.info('trailing slash in storage location detected and removed')
+            self._storage = storage_override
+
+        if not isinstance(publish_override, str) or publish_override == '':
+            self._publish = ENDPOINTS[endpoint]['publish']
+        else:
+            if publish_override.endswith('/'):
+                publish_override = publish_override[:-1]
+                logger.info('trailing slash in publish location detected and removed')
+            self._publish = publish_override
+
+        logger.info(
+            'storage endpoint set to: %s / publish endpoint set to: %s',
+            self._storage,
+            self._publish,
+        )
+        self._http_timeout = DEFAULT_TIMEOUT
+
+    @property
+    def storage(self) -> str:
+        return self._storage
+
+    @property
+    def publish(self) -> str:
+        return self._publish
+
+
+class ConfigException(Exception):
+    """Thrown in case of problems with the storage"""

dhclients-0.1.0/src/dhclients/storage.py

@@ -0,0 +1,149 @@
+# SPDX-FileCopyrightText: 2026 Georg-August-Universität Göttingen
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+"""Connection to DARIAH-DE storage
+
+Storage API docs: http://hdl.handle.net/11858/00-1734-0000-0009-FEA1-D
+"""
+
+from typing import IO
+
+import requests
+from requests.models import Response
+
+from dhclients.config import DhrepConfig
+
+
+class Storage:
+    """
+    Methods to create and update data objects in DARIAH-DE storage
+    """
+
+    def __init__(self, config: DhrepConfig = DhrepConfig()):
+        self._storage_url = config.storage
+        self._config = config
+        # reuse tcp connections: https://requests.readthedocs.io/en/latest/user/advanced/#session-objects
+        self._requests = requests.Session()
+
+    def create(self, token: str, content: IO[bytes] | str, content_type: str) -> str:
+        """Create a new object in dariahstorage.
+
+        Args:
+            token (str): authentication token
+            content (IO[bytes] | str): data to store
+            content_type (str): content type
+
+        Raises:
+            Exception: if response from storage had no 201 status code
+
+        Returns:
+            str: the storage id of created object
+        """
+
+        response = self._requests.post(
+            self._storage_url + '/',
+            headers={'Authorization': 'bearer ' + token, 'Content-type': content_type},
+            data=content,
+        )
+
+        if response.status_code != 201:
+            raise StorageException(
+                'Error creating new cdstar object: '
+                + response.text
+                + ' - '
+                + str(response.status_code)
+            )
+
+        storage_id = response.headers['location'].rsplit('/', 1)[-1]
+        return storage_id
+
+    def read(self, token: str, storage_id: str) -> Response:
+        """Get an object from dariahstorage.
+
+        Args:
+            token (str): authentication token
+            storage_id (str): the storage id
+
+        Raises:
+            Exception: if response from storage had no 200 status code
+
+        Returns:
+            Response: HTTP response from service
+        """
+        response = self._requests.get(
+            self._storage_url + '/' + storage_id,
+            headers={
+                'Authorization': 'bearer ' + token,
+            },
+        )
+
+        if response.status_code != 200:
+            raise StorageException(
+                'Error reading cdstar object: ' + response.text + ' - ' + str(response.status_code)
+            )
+        return response
+
+    def update(self, token: str, storage_id: str, content: IO[bytes] | str, content_type: str):
+        """Update an object in dariahstorage.
+
+        Arguments:
+            token (str): authentication token
+            storage_id (str): the storage id
+            content (IO[bytes] | str): the data to store
+            content_type (str): content type
+
+        Raises:
+            Exception: if response from storage had no 201 status code
+        """
+
+        response = self._requests.put(
+            self._storage_url + '/' + storage_id,
+            headers={'Authorization': 'bearer ' + token, 'Content-type': content_type},
+            data=content,
+        )
+
+        if response.status_code != 201:
+            raise StorageException(
+                'Error updating cdstar object '
+                + storage_id
+                + ': '
+                + response.text
+                + ' - '
+                + str(response.status_code)
+            )
+
+    def delete(self, token: str, storage_id: str):
+        """Delete an object from dariahstorage.
+
+        Args:
+            token (str): authentication token
+            storage_id (str): the storage id
+
+        Raises:
+            Exception: if response from storage had no 204 status code
+        """
+        response = self._requests.delete(
+            self._storage_url + '/' + storage_id,
+            headers={
+                'Authorization': 'bearer ' + token,
+            },
+        )
+
+        if response.status_code != 204:
+            raise StorageException(
+                'Error deleting cdstar object: ' + response.text + ' - ' + str(response.status_code)
+            )
+
+    def get_storage_url(self):
+        """Get the storage url
+
+        Returns:
+            str: the actual storage url set
+        """
+
+        return self._storage_url
+
+
+class StorageException(Exception):
+    """Thrown in case of problems with the storage"""