gams-pylican 0.0.1__tar.gz

gams_pylican-0.0.1/.gitignore

@@ -0,0 +1,43 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv
+
+# exclude rye local dependency files
+.python-version
+requirements.lock
+requirements-dev.lock
+
+
+Thumbs.db
+.DS_Store
+.gradle
+build/
+target/
+out/
+.idea
+*.iml
+*.ipr
+*.iws
+.project
+.settings
+.classpath
+.factorypath
+
+# custom
+venv/
+.venv/
+bock.egg*
+dist
+.pypirc
+__pycache__
+logs
+project/bags
+models
+.vscode/

gams_pylican-0.0.1/.gitlab-ci.yml

@@ -0,0 +1,48 @@
+stages:
+  - test
+  - lint
+  - build
+  - publish
+
+# A hidden job template that can be used by different Python versions
+.test-template:
+  stage: test
+  script:
+    - echo "uv environment version"
+    - uv --version
+    - echo "Pinning ${PYTHON_VERSION}"
+    - uv python pin ${PYTHON_VERSION}
+    - uv sync
+    - echo "Using python version:"
+    - python --version
+    - echo "Running tests with uv"
+    - uv run pytest tests
+
+# Specific jobs for Python versions
+test-py_3.12:
+  extends: .test-template
+  variables:
+    PYTHON_VERSION: "3.12"
+
+lint:
+  stage: lint
+  script:
+    - echo "uv environment version"
+    - uv --version
+    - echo "Using python version:"
+    - python --version
+    - echo "Running uv check with ruff"
+    - uv run ruff check src
+
+build:
+  stage: build
+  script:
+    uv build
+
+publish-pypi:
+  stage: publish
+  script:
+    - uv build
+    - uv publish --token $PYPI_TOKEN
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/

gams_pylican-0.0.1/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.0.1]
+
+### Added
+
+- initial release
+- core features as python facade for 

gams_pylican-0.0.1/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sebastian David Schiller-Stoff
+
+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.

gams_pylican-0.0.1/Make

@@ -0,0 +1,19 @@
+# make test, coverage, documentation, etc
+SHELL := /bin/bash
+
+.PHONY: all test clean build
+
+all: init test lint build
+
+init:
+    @uv sync
+
+test:
+	@uv run pytest tests
+
+lint:
+	@uv run ruff check src
+
+build:
+	@uv build
+

gams_pylican-0.0.1/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: gams-pylican
+Version: 0.0.1
+Summary: Python based gams5 client / api facade - installabe via pip, uv etc. Pelicans use their massive pouches to scoop up and transport large catches. Similarily gams-pylican transports gams5 data for your personal usage.
+Author-email: Sebastian David Schiller-Stoff <sebastian.stoff@uni-graz.at>
+License-File: LICENSE.md
+Requires-Python: >=3.12
+Requires-Dist: requests>=2.32.4
+Description-Content-Type: text/markdown
+
+# gams-pylican
+
+Lightweight python based gams5 client / api facade - installable via pip, uv etc. Pelicans use their massive pouches to scoop up and transport large catches. Similarly, gams-pylican transports gams5 data for your personal usage.
+
+
+# Installation
+
+```sh
+# e.g.
+pip install gams-pylican
+
+
+```
+
+# Quickstart
+
+```py
+import gams_pylican
+
+# instantiate client
+gams_client = gams_pylican.bootstrap_client("https://gams.uni-graz.at")
+
+# use api facade operations (public get)
+objects = gams_client.curation.list_objects("memor")
+
+
+```
+
+
+# State changing operations
+
+- e.g. CRUD on digital objects, datastreams, projects or ingest operations.
+
+```py
+import gams_pylican
+
+# instantiate client
+gams_client = gams_pylican.bootstrap_client("https://gams.uni-graz.at")
+
+# either supply username and password
+gams_client.login(username="foo", password="bar")
+# or overwrite values from env variables (PYLICAN_USER, PYLICAN_PASSWORD)
+gams_client.login() # in this case method can be empty
+
+# perform state changing operations
+gams_client.curation.update_project("foo", "bar")
+gams_client.curation.ingest("foo")
+# ...
+
+# logout as last step
+gams_client.logout()
+
+
+```
+
+
+## Development
+
+### Release
+
+1. Increment version in pyproject.toml in feature branch (merging into develop):
+    - make sure version follow vd.d.d pattern 
+2. Merge changes to develop -> main
+3. Create release on the gitlab webclient (from main branch) with new git tag that must be the same as in the pyproject.toml!
+    - e.g. v0.1.1
+    - create the release from the main branch!
+    - gitlab will autodeploy the new version to pypi

gams_pylican-0.0.1/README.md

@@ -0,0 +1,67 @@
+# gams-pylican
+
+Lightweight python based gams5 client / api facade - installable via pip, uv etc. Pelicans use their massive pouches to scoop up and transport large catches. Similarly, gams-pylican transports gams5 data for your personal usage.
+
+
+# Installation
+
+```sh
+# e.g.
+pip install gams-pylican
+
+
+```
+
+# Quickstart
+
+```py
+import gams_pylican
+
+# instantiate client
+gams_client = gams_pylican.bootstrap_client("https://gams.uni-graz.at")
+
+# use api facade operations (public get)
+objects = gams_client.curation.list_objects("memor")
+
+
+```
+
+
+# State changing operations
+
+- e.g. CRUD on digital objects, datastreams, projects or ingest operations.
+
+```py
+import gams_pylican
+
+# instantiate client
+gams_client = gams_pylican.bootstrap_client("https://gams.uni-graz.at")
+
+# either supply username and password
+gams_client.login(username="foo", password="bar")
+# or overwrite values from env variables (PYLICAN_USER, PYLICAN_PASSWORD)
+gams_client.login() # in this case method can be empty
+
+# perform state changing operations
+gams_client.curation.update_project("foo", "bar")
+gams_client.curation.ingest("foo")
+# ...
+
+# logout as last step
+gams_client.logout()
+
+
+```
+
+
+## Development
+
+### Release
+
+1. Increment version in pyproject.toml in feature branch (merging into develop):
+    - make sure version follow vd.d.d pattern 
+2. Merge changes to develop -> main
+3. Create release on the gitlab webclient (from main branch) with new git tag that must be the same as in the pyproject.toml!
+    - e.g. v0.1.1
+    - create the release from the main branch!
+    - gitlab will autodeploy the new version to pypi

gams_pylican-0.0.1/demo.py

@@ -0,0 +1,31 @@
+import gams_pylican
+
+# demo calls for pylican
+
+gams_client = gams_pylican.bootstrap_client("https://it030021.uni-graz.at")
+# gams_client = gams_pylican.bootstrap_client("https://it030021.uni-graz.at", str(Path.cwd() / "bags"))
+
+objects = gams_client.curation.list_objects("memor")
+
+gams_client.login(username="foo", password="bar")
+gams_client.login()
+
+# gams_client.curation.update_project("memo", "MEMOR | Digitales Memorbuch der Stadt Graz")
+
+gams_client.logout()
+
+# gams_client.curation.update_project("memo", "MEMOR | Digitales Memorbuch der Stadt Graz")
+
+# gams_client.curation.update_project("memo", "MEMOR | Digitales Memorbuch der Stadt Graz")
+
+#gams_client.curation.update_project()
+
+print(objects)
+
+
+# this should fail with 403
+# gams_client.delete_object("htx.durham.1", "htx")
+
+
+
+

gams_pylican-0.0.1/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "gams-pylican"
+version = "v0.0.1"
+description = "Python based gams5 client / api facade - installabe via pip, uv etc. Pelicans use their massive pouches to scoop up and transport large catches. Similarily gams-pylican transports gams5 data for your personal usage."
+authors = [
+    { name = "Sebastian David Schiller-Stoff", email = "sebastian.stoff@uni-graz.at" }
+]
+dependencies = [
+    "requests>=2.32.4"
+]
+readme = "README.md"
+requires-python = ">= 3.12"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/gams_pylican"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.5",
+    "requests-mock>=1.12.1",
+    "ruff>=0.14.14",
+]
+
+[project.scripts]
+pylican = "gams_pylican.cli:cli"

gams_pylican-0.0.1/src/gams_pylican/CurationApiFacade.py

@@ -0,0 +1,142 @@
+import logging
+import os
+from typing import Optional, List
+
+from gams_pylican.api.DigitalObject.DigitalObjectService import DigitalObjectService
+from gams_pylican.api.Project.ProjectService import ProjectService
+from gams_pylican.api.auth.AuthorizationService import AuthorizationService
+from gams_pylican.app.IngestService import IngestService
+
+
+class CurationApiFacade:
+    """
+    Facade class for the curation part of the gams-api under /api/curation/v1 etc.
+    """
+
+    # Services
+    _digital_object_service: DigitalObjectService
+    _ingest_service: IngestService
+    _authorization_service: AuthorizationService
+    _project_service: ProjectService
+
+    _local_bagit_files_path: Optional[str]
+
+    def __init__(self,
+                 local_bagit_files_path: Optional[str],
+                 authorization_service: AuthorizationService,
+                 ingest_service: IngestService,
+                 project_service: ProjectService,
+                 digital_object_service: DigitalObjectService
+                 ) -> None:
+
+        self._local_bagit_files_path = local_bagit_files_path
+
+        self._authorization_service = authorization_service
+        self._digital_object_service = digital_object_service
+        self._ingest_service = ingest_service
+        self._project_service = project_service
+
+    def list_objects(self, project_abbr: str) -> List[str]:
+        """
+        Lists all objects of defined project
+        """
+
+        return self._digital_object_service.list_objects(project_abbr)
+
+    def save_object(self, object_id: str, project_abbr: str):
+        """
+        Creates a digital object
+        """
+        return self._digital_object_service.save_object(object_id, project_abbr)
+
+    def assign_child_objects(self, parent_id: str, children_ids: List[str], project_abbr: str):
+        """
+        Assigns a child object to a parent object
+        """
+        return self._digital_object_service.assign_child_objects(parent_id, children_ids, project_abbr)
+
+    def delete_object(self, object_id: str, project_abbr: str):
+        """
+        Deletes a digital object
+        """
+
+        return self._digital_object_service.delete_object(object_id, project_abbr)
+
+    def delete_objects(self, project_abbr: str):
+        """
+        Deletes all digital objects of a project
+        """
+        project_objects = self.list_objects(project_abbr)
+        logging.info(f"Deleting now {len(project_objects)} objects for project {project_abbr}")
+        for obj in project_objects:
+            self.delete_object(obj, project_abbr)
+
+    def create_project(self, project_abbr: str, description: str):
+        """
+        Creates a new project with given abbreviation and description.
+        """
+        self._project_service.save_project(project_abbr, description)
+
+    def update_project(self, project_abbr: str, description: str):
+        """
+        Updates a project.
+        """
+        self._project_service.update_project(project_abbr, description)
+
+    def delete_project(self, project_abbr: str):
+        """
+        Deletes a project.
+        """
+        self._project_service.delete_project(project_abbr)
+
+    def ingest_bag(self, project_abbr: str, sip_folder_name: str):
+        """
+        Ingests defined folder from the local SIP structure.
+        """
+        if self._digital_object_service.object_exists(sip_folder_name, project_abbr):
+            self.delete_object(sip_folder_name, project_abbr)
+            logging.info(f"Successfully deleted existing object: {sip_folder_name} for ingest")
+
+
+        self._ingest_service.ingest_bag(project_abbr, sip_folder_name)
+
+    def ingest_bags(self, project_abbr: str):
+        """
+        Ingests all bags from the local bag structure.
+        """
+
+        if not self._local_bagit_files_path:
+            raise ValueError("Local bag path is not configured.")
+
+        failures = []
+
+        for folder_name in os.listdir(self._local_bagit_files_path):
+            # Basic filter (you might want to improve this)
+            if not folder_name.startswith(project_abbr):
+                continue
+
+            try:
+                logging.info(f"Starting ingest for: {folder_name}")
+                self.ingest_bag(project_abbr, folder_name)
+                logging.info(f"Successfully ingested: {folder_name}")
+            except Exception as e:
+                logging.error(f"FAILED to ingest {folder_name}: {e}")
+                failures.append(folder_name)
+
+        # Critical: If there were failures, we should probably let the caller know
+        if failures:
+            raise RuntimeError(f"Batch ingest completed with {len(failures)} errors: {failures}")
+
+    def ingest(self, project_abbr: str):
+        """
+        Performs a complete ingest operation based on the defined SIP folders.
+        """
+
+        # optionally delete all objects first
+        # self.curation.delete_objects(project_abbr)
+
+        # delete all indices from dependent services
+        # self.disintegrate_project_objects(project_abbr)
+
+        # ingesting all bags from the local bag structure admin
+        self.ingest_bags(project_abbr)

gams_pylican-0.0.1/src/gams_pylican/IntegrationApiFacade.py

@@ -0,0 +1,66 @@
+from gams_pylican.app.IntegrationService import IntegrationService
+
+
+class IntegrationApiFacade:
+    """
+    Facade class for the integration part of the gams-api under /api/integration/v1 etc.
+    """
+
+    # Services
+    _integration_service: IntegrationService
+
+
+    def __init__(self, integration_service: IntegrationService):
+        """
+
+        """
+        self._integration_service = integration_service
+
+    def integrate_project_objects(self, project_abbr: str):
+        """
+        Integrates all objects of a project
+        """
+        return self._integration_service.integrate_all(project_abbr)
+
+    def disintegrate_project_objects(self, project_abbr: str):
+        """
+        Disintegrates all objects of a project
+        """
+        return self._integration_service.disintegrate_all(project_abbr)
+
+    def integrate_project_object(self, project_abbr: str, object_id: str):
+        """
+        Integrates a single object of a project in gams-integration services.
+        """
+        return self._integration_service.integrate(project_abbr, object_id)
+
+    def disintegrate_project_object(self, project_abbr: str, object_id: str):
+        """
+        Disintegrates a single object of a project in gams-integration services.
+        """
+        return self._integration_service.disintegrate(project_abbr, object_id)
+
+    def integrate_project_objects_custom_search(self, project_abbr: str):
+        """
+        Integrates all objects of a project to custom search service.
+        """
+        return self._integration_service.integrate_all_custom_search(project_abbr)
+
+    def disintegrate_project_objects_custom_search(self, project_abbr: str):
+        """
+        Disintegrates all objects of a project from custom search service.
+        """
+        return self._integration_service.disintegrate_all_custom_search(project_abbr)
+
+    def integrate_project_objects_plexus_search(self, project_abbr: str):
+        """
+        Integrates all objects of a project to plexus search service.
+        """
+        return self._integration_service.integrate_all_plexus_search(project_abbr)
+
+    def disintegrate_project_objects_plexus_search(self, project_abbr: str):
+        """
+        Disintegrates all objects of a project from plexus search service.
+        """
+        return self._integration_service.disintegrate_all_plexus_search(project_abbr)
+

gams_pylican-0.0.1/src/gams_pylican/Pylican.py

@@ -0,0 +1,87 @@
+import os
+from typing import Optional
+
+from gams_pylican.CurationApiFacade import CurationApiFacade
+from gams_pylican.IntegrationApiFacade import IntegrationApiFacade
+from gams_pylican.PylicanStatics import PylicanStatics
+from gams_pylican.api.DigitalObject.DigitalObjectService import DigitalObjectService
+from gams_pylican.api.GamsApiClient import GamsApiClient
+from gams_pylican.api.Project.ProjectService import ProjectService
+from gams_pylican.api.auth.AuthorizationService import AuthorizationService
+from gams_pylican.app.IngestService import IngestService
+from gams_pylican.app.IntegrationService import IntegrationService
+
+
+class Pylican:
+    """
+    Provides abstractions for the usage of GAMS5 REST-API, like:
+    - ingesting bags as digital objects and datastreams
+    - creation of projects etc.
+    """
+
+    # Core components
+    _client: GamsApiClient
+    _host: str
+    _local_bagit_files_path: Optional[str]
+
+    # Services
+    _digital_object_service: DigitalObjectService
+    _ingest_service: IngestService
+    _integration_service: IntegrationService
+    _authorization_service: AuthorizationService
+    _project_service: ProjectService
+
+    curation: CurationApiFacade
+    integration: IntegrationApiFacade
+
+    def __init__(self,
+                 local_bagit_files_path: str,
+                 authorization_service: AuthorizationService,
+                 digital_object_service: DigitalObjectService,
+                 ingest_service: IngestService,
+                 integration_service: IntegrationService,
+                 project_service: ProjectService
+                 ) -> None:
+
+        self._local_bagit_files_path = local_bagit_files_path
+
+        self._authorization_service = authorization_service
+        self._digital_object_service = digital_object_service
+        self._ingest_service = ingest_service
+        self._integration_service = integration_service
+        self._project_service = project_service
+
+        self.curation = CurationApiFacade(
+            local_bagit_files_path=local_bagit_files_path,
+            authorization_service=self._authorization_service,
+            digital_object_service=self._digital_object_service,
+            ingest_service=self._ingest_service,
+            project_service=self._project_service
+        )
+
+        self.integration = IntegrationApiFacade(
+            integration_service=self._integration_service,
+        )
+
+    def login(self, username: str = None, password: str = None):
+        """
+        Logs in to the GAMS5 instance.
+        """
+
+        env_username = os.environ.get(PylicanStatics.PYLICAN_USERNAME_ENV_VARIABLE)
+        env_password = os.environ.get(PylicanStatics.PYLICAN_PASSWORD_ENV_VARIABLE)
+
+        # overwrite any given username and password with environment variables if defined.
+        if env_username:
+            username = env_username
+        if env_password:
+            password = env_password
+
+        self._authorization_service.login(username, password)
+
+    def logout(self):
+        """
+        Logs out from the GAMS5 instance.
+        """
+        self._authorization_service.logout()
+

gams_pylican-0.0.1/src/gams_pylican/PylicanStatics.py

@@ -0,0 +1,20 @@
+class PylicanStatics:
+    """
+    This class contains all statics for the GAMS5 API, like the API root path, the demo project abbreviation, the demo user name, etc.
+    all paths are relative to the current working directory.
+    """
+
+    API_ROOT = "/api"
+    AUTH_ENDPOINT = API_ROOT + "/auth"
+
+    CURATION_API_RELATIVE = "/curation/v1"
+    INTEGRATION_API_RELATIVE = "/integration/v1"
+
+    CURATION_API_ROOT = API_ROOT + CURATION_API_RELATIVE
+    INTEGRATION_API_ROOT = API_ROOT + INTEGRATION_API_RELATIVE
+
+    PYLICAN_USERNAME_ENV_VARIABLE = "PYLICAN_USER"
+    PYLICAN_PASSWORD_ENV_VARIABLE = "PYLICAN_PASSWORD"
+
+    def __init__(self) -> None:
+        pass

gams_pylican-0.0.1/src/gams_pylican/__init__.py

@@ -0,0 +1,4 @@
+from gams_pylican.main import bootstrap_client
+
+__all__ = ["bootstrap_client"]
+