mantis-catalog 0.1.2__tar.gz

mantis_catalog-0.1.2/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: mantis-catalog
+Version: 0.1.2
+Summary: M&NTIS library to manipulate catalog of resources
+License: MIT
+Author: AMOSSYS
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: fsspec[s3]
+Requires-Dist: omegaconf
+Requires-Dist: universal-pathlib (>=0.2.6,<0.3.0)
+Description-Content-Type: text/markdown
+
+

mantis_catalog-0.1.2/mantis_catalog/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa
+from mantis_catalog.path import *

mantis_catalog-0.1.2/mantis_catalog/config.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2016-2025 AMOSSYS. All rights reserved.
+#
+# This file is part of Cyber Range AMOSSYS.
+#
+# Cyber Range AMOSSYS can not be copied and/or distributed without the express
+# permission of AMOSSYS.
+#
+#
+import enum
+from dataclasses import dataclass
+from dataclasses import field
+from pathlib import Path
+from typing import Dict
+from typing import Optional
+
+from omegaconf import OmegaConf
+from omegaconf import SI
+
+
+class StorageType(enum.Enum):
+    local = 1
+    s3 = 2
+
+
+@dataclass
+class BaseStorageConfig:
+    """Generic storage config dataclass"""
+
+
+@dataclass
+class LocalStorageConfig(BaseStorageConfig):
+    path: Path = SI("${oc.env:CATALOG_STORAGE_LOCAL_PATH}")
+
+
+@dataclass
+class S3StorageConfig(BaseStorageConfig):
+    access_key: Optional[str] = SI("${oc.env:CATALOG_STORAGE_S3_ACCESS_KEY,null}")
+    secret_key: Optional[str] = SI("${oc.env:CATALOG_STORAGE_S3_SECRET_KEY,null}")
+    endpoint_url: Optional[str] = SI("${oc.env:CATALOG_STORAGE_S3_ENDPOINT_URL,null}")
+    bucket_name: str = "${oc.env:CATALOG_STORAGE_S3_BUCKET_NAME}"
+    region: Optional[str] = SI("${oc.env:CATALOG_STORAGE_S3_REGION,null}")
+
+
+@dataclass
+class StorageConfig:
+    """Generic storage config dataclass"""
+
+    _backends: Dict[StorageType, BaseStorageConfig] = field(
+        default_factory=lambda: {
+            StorageType.local: LocalStorageConfig(),
+            StorageType.s3: S3StorageConfig(),
+        }
+    )
+    _type_name: str = "${.type}"
+    backend: BaseStorageConfig = SI("${._backends[${._type_name}]}")
+    type: StorageType = SI("${oc.env:CATALOG_STORAGE_TYPE,local}")
+    path_prefix: str = "${oc.env:CATALOG_STORAGE_PATH_PREFIX,''}"
+
+
+@dataclass
+class CatalogConfig:
+    storage: StorageConfig = field(default_factory=StorageConfig)
+
+
+catalog_config = OmegaConf.structured(CatalogConfig)

mantis_catalog-0.1.2/mantis_catalog/path.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+import os
+from pathlib import Path
+
+from mantis_catalog.config import catalog_config
+from mantis_catalog.config import StorageType
+from upath import UPath
+from upath.registry import register_implementation
+
+
+class ResourcePath(UPath):
+    def __init__(self, *args, **kwargs):
+        storage_backend = catalog_config.storage.backend
+        match catalog_config.storage.type:
+            case StorageType.local:
+                path = UPath(storage_backend.path, protocol="local")
+            case StorageType.s3:
+                path = UPath(
+                    "s3://",
+                    endpoint_url=storage_backend.endpoint_url,
+                    key=storage_backend.access_key,
+                    secret=storage_backend.secret_key,
+                    bucket=storage_backend.bucket_name,
+                )
+            case _:
+                raise ValueError("Invalid storage backend type")
+        self.__path = path
+        super().__init__(*args, **kwargs)
+        self._fs_cached = path.fs
+
+    @property
+    def abstract_path(self):
+        return super().path
+
+    @property
+    def path(self):
+        # concatenate internal and external paths
+        path = os.path.relpath(super().path, self.root)
+        path = os.path.join(self.__path.path, path)
+        return os.path.normpath(path)
+
+    def __str__(self):
+        # get the abstract path
+        path = super().path
+        if self._protocol:
+            return f"{self._protocol}://{path}"
+        else:
+            return path
+
+
+def copytree_path(source: Path, dest: Path):
+    """Copy a file tree with Path compatibility. If 'dest' does not
+    exist, it is created.
+
+    :param source: dir to copy from (objet Path).
+    :param dest: dir to copy to (objet Path).
+
+    """
+
+    dest.mkdir(parents=True, exist_ok=True)
+
+    for item in source.iterdir():
+        if item.is_dir():
+            copytree_path(item, dest / item.name)
+        else:
+            with item.open('rb') as src_file:
+                with (dest / item.name).open('wb') as dst_file:
+                    dst_file.write(src_file.read())
+
+
+register_implementation("resource", ResourcePath)
+
+__all__ = [
+    "ResourcePath",
+    "UPath",
+]

mantis_catalog-0.1.2/pyproject.toml

@@ -0,0 +1,25 @@
+[tool.poetry]
+name = "mantis-catalog"
+version = "0.1.2"
+description = "M&NTIS library to manipulate catalog of resources"
+readme = "README.md"
+authors = ["AMOSSYS"]
+license = "MIT"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+universal-pathlib = "^0.2.6"
+fsspec = {extras = ["s3"], version = "*"}
+omegaconf = "*"
+
+
+[tool.poetry.group.dev.dependencies]
+mypy = "*"
+flake8 = "*"
+coverage = "*"
+pytest = "*"
+black = "*"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"