dafab-client 2.2.0__tar.gz

dafab_client-2.2.0/MANIFEST.in

@@ -0,0 +1,28 @@
+include pyproject.toml
+include readme.md
+
+recursive-include dafab_client *.py
+recursive-include dafab_client/example_notebooks *.ipynb
+recursive-include dafab_client/helpers/resources/schemas *.json
+include dafab_client/_rucio/secrets/user_dafab/config
+include dafab_client/_rucio/secrets/user_dafab/rucio_ca_bundle.pem
+
+exclude dafab_client/helpers/System/create_dafab_rse.py
+exclude dafab_client/helpers/System/create_meluxina_s3_rse.py
+exclude dafab_client/helpers/System/filter.py
+exclude dafab_client/helpers/System/test.py
+exclude dafab_client/helpers/dataset_management/remove_dataset.py
+exclude dafab_client/helpers/download_s3_prefix.py
+exclude dafab_client/helpers/metadata_management/Preflight/validate_metadata_file.py
+exclude dafab_client/helpers/metadata_management/Retrieval/get_metadata.py
+exclude dafab_client/helpers/metadata_management/Workflows/initialize_item_metadata.py
+exclude dafab_client/helpers/db_bootstrap/accounts
+
+prune tests
+prune docs
+prune demo-data
+prune dev-material
+prune untracked
+
+global-exclude __pycache__
+global-exclude *.py[cod]

dafab_client-2.2.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: dafab_client
+Version: 2.2.0
+Summary: DaFab helper client built on top of Rucio client modules.
+Author: DaFab
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/rucio/rucio
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: folium<1,>=0.20.0
+Requires-Dist: jsonschema<5,>=4.26.0
+Requires-Dist: packaging<27,>=26.1
+Requires-Dist: requests<3,>=2.33.1
+Requires-Dist: typing_extensions<5,>=4.15
+Requires-Dist: urllib3<3,>=2.6.3
+
+# DaFab Client
+
+This is the official DaFab client (see https://www.dafab-ai.eu for the project details).
+
+## Install
+
+```bash
+pip install dafab-client
+```
+
+Notes:
+- Runtime requires Python `>=3.9`.
+- Should work on Windows, Linux and macOS.
+
+## Quick Start
+
+```python
+import dafab_client as dc
+
+print(dc.ping())
+print(dc.whoami())
+print(dc.list_storages())
+```
+
+All public helpers are available as `dc.<method>`.
+
+For examples, you can also copy the packaged simple-user notebook into the current directory:
+
+```bash
+python -c "import dafab_client as dc; print(dc.get_example('user'))"
+```
+
+This overwrites local files if they already exist.
+
+## Simple User API Reference
+
+The README focuses on the methods used in `dafab_simple_user_workflows.ipynb`.
+Each method below is also documented in-code via module docstrings.
+For simplicity, only mandatory parameters are listed here.
+
+### Session And Discovery
+- `ping()` : Health check of the connected Rucio/STAC service.
+- `whoami()` : Return authenticated identity/session details.
+- `list_stac_scopes()` : Print visible scopes for the active account.
+- `list_catalogs_and_collections()` : Print catalog/collection container ids in the active scope.
+- `get_catalogs_and_collections()` : Return structured catalog/collection rows.
+- `get_items()` : Return item DID rows.
+
+### Filter And Relationship Queries
+- `get_items_by_enhanced_filter(filter_payload)` : Execute an enhanced STAC filter query.
+- `get_item_ids_by_collection_field(collection_id)` : Resolve item ids by `collection` metadata value.
+- `get_item_ids_by_top_facet_catalog(top_facet_catalog_id)` : Resolve item ids indexed under a top facet catalog.
+- `get_item_ids_by_facet_value_catalog(facet_value_catalog_id)` : Resolve item ids linked from one facet value catalog.
+- `get_related_item_ids_from_original_item(original_item_id)` : Resolve derived item ids linked via `rel=related`.
+- `get_source_original_item_ids_from_derived_item(derived_item_id)` : Resolve original item ids linked via `rel=derived_from`.
+- `get_sibling_derived_item_ids(original_item_id)` : Resolve sibling derived items for one original item.
+
+### Spatial And Temporal Queries
+- `get_items_by_timerange(start_date, end_date)` : Filter items by temporal interval.
+- `get_items_by_bbox(min_long, min_lat, max_long, max_lat)` : Filter items by spatial bounding box.
+- `get_items_by_bbox_and_timerange(bbox, timerange)` : Filter items by combined bbox and time window.
+
+### Metadata Access
+- `extract_metadata_value(value_path)` : Read one metadata value path (requires metadata or `pname` via optional args).
+- `get_bulk_metadata(pname)` : Retrieve full or partial metadata document values.
+- `as_json(data)` : Pretty-print payloads for notebook/debug display.
+
+### Storage And Asset Operations
+- `list_storages()` : Print configured storage endpoints (RSEs).
+- `check_storage(rse_name)` : Fetch one storage endpoint metadata record.
+- `list_item_asset_entries(item_id)` : Inspect an item's `assets` entries.
+- `build_stable_asset_href(item_id, asset_key)` : Build canonical stable asset URL used by DaFab STAC metadata.
+- `download_asset_from_stable_href(stable_href)` : Download content by stable asset URL.
+- `download_item_asset(item_id, asset_key)` : Download one metadata asset by key (URL or attached file resolution).
+- `download_all_derived_item_assets(item_id)` : Download all assets for one derived item.
+
+### Visualization
+- `get_map(metadata_batch)` : Render bbox overlays from metadata to an interactive HTML map.
+
+
+## Local Files And Outputs
+
+### Demo-data directory
+ 
+For writable helper outputs, default base directory is:
+- `DAFAB_DEMO_DATA_DIR` (if set), else
+- `<current working directory>/demo-data`
+
+`get_map(...)` default output path:
+- `<demo-data-dir>/filters/bbox_map.html`
+
+### Bundled schemas
+
+Packaged schema files (used as fallback in validators):
+- `Schema_Copernicus_with_dafab.json`
+- `Schema_DaFab_Facet_Value_Catalog.json`
+- `dafab-smart_agriculture-item.schema.json`
+- `dafab-water_analysis-item.schema.json`
+
+## Logging Defaults
+
+Current defaults in `dafab_client._rucio.global_utils`:
+- `debug_mode = False`
+- `minimal_logging = True`
+
+So runtime output is intentionally minimal unless logging flags are changed.

dafab_client-2.2.0/dafab_client/__init__.py

@@ -0,0 +1,65 @@
+"""Public import namespace for the DaFab client package."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from shutil import copy2
+
+from . import helpers
+from ._rucio.global_utils import get_active_account, set_active_account
+
+_ACCOUNT_API = ("get_active_account", "set_active_account")
+_EXAMPLE_NOTEBOOKS_DIR = Path(__file__).resolve().parent / "example_notebooks"
+_EXAMPLE_PROFILE_TO_NOTEBOOK = {
+    "user": "dafab_simple_user_workflows.ipynb",
+    "admin": "dafab_operator_workflows.ipynb",
+    "skim": "dafab_skim_workflows.ipynb",
+    "dasi": "dafab_dasi_workflows.ipynb",
+}
+_EXAMPLE_PROFILE_ALIASES = {
+    "operator": "admin",
+}
+
+__all__ = ("helpers", *_ACCOUNT_API, "get_example", *helpers.__all__)
+
+
+def get_example(profile: str | None = None, destination: str | Path = ".") -> list[Path]:
+    """Copy packaged notebooks into ``destination`` and return copied local paths."""
+    if profile is None:
+        notebook_names = sorted(set(_EXAMPLE_PROFILE_TO_NOTEBOOK.values()))
+    else:
+        normalized = str(profile).strip().lower()
+        normalized = _EXAMPLE_PROFILE_ALIASES.get(normalized, normalized)
+        notebook_name = _EXAMPLE_PROFILE_TO_NOTEBOOK.get(normalized)
+        if notebook_name is None:
+            valid_profiles = ", ".join(sorted(_EXAMPLE_PROFILE_TO_NOTEBOOK))
+            raise ValueError(
+                f"Unknown profile '{profile}'. Supported values: {valid_profiles}."
+            )
+        notebook_names = [notebook_name]
+
+    target_dir = Path(destination).expanduser().resolve()
+    target_dir.mkdir(parents=True, exist_ok=True)
+
+    copied_paths: list[Path] = []
+    for notebook_name in notebook_names:
+        source_path = _EXAMPLE_NOTEBOOKS_DIR / notebook_name
+        if not source_path.is_file():
+            raise FileNotFoundError(f"Missing packaged notebook: {source_path}")
+        target_path = target_dir / notebook_name
+        copy2(source_path, target_path)
+        copied_paths.append(target_path)
+
+    return copied_paths
+
+
+def __getattr__(name: str):
+    if name in helpers.__all__:
+        return getattr(helpers, name)
+    if name in _ACCOUNT_API:
+        return globals()[name]
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__() -> list[str]:
+    return sorted(set(globals()) | set(__all__))

dafab_client-2.2.0/dafab_client/_rucio/__init__.py

@@ -0,0 +1 @@
+"""Internal vendored Rucio modules used by dafab_client."""

dafab_client-2.2.0/dafab_client/_rucio/client/__init__.py

@@ -0,0 +1,15 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .client import Client  # noqa: F401