oceanprotocol-job-details 0.0.1__py3-none-any.whl → 0.0.5__py3-none-any.whl

oceanprotocol_job_details/job_details.py

@@ -0,0 +1,28 @@
+from typing import Literal, Optional
+from oceanprotocol_job_details.dataclasses.job_details import JobDetails
+from oceanprotocol_job_details.loaders.loader import Loader
+from oceanprotocol_job_details.loaders.impl.environment import EnvironmentLoader
+
+_Implementations = Literal["env"]
+
+
+class OceanProtocolJobDetails(Loader[JobDetails]):
+    """Decorator that loads the JobDetails from the given implementation"""
+
+    def __init__(
+        self,
+        implementation: Optional[_Implementations] = "env",
+        *args,
+        **kwargs,
+    ):
+        if implementation == "env":
+            # As there are not more implementations, we can use the EnvironmentLoader directly
+            self._loader = lambda: EnvironmentLoader(*args, **kwargs)
+        else:
+            raise NotImplementedError(f"Implementation {implementation} not supported")
+
+    def load(self) -> JobDetails:
+        return self._loader().load()
+
+
+del _Implementations

{src/oceanprotocol_job_details → oceanprotocol_job_details}/loaders/impl/environment.py

@@ -7,13 +7,13 @@ from json import load, loads
 from pathlib import Path
 from typing import Optional, final
 
-from src.oceanprotocol_job_details.dataclasses.constants import (
+from oceanprotocol_job_details.dataclasses.constants import (
     DidKeys,
     Paths,
     ServiceType,
 )
-from src.oceanprotocol_job_details.dataclasses.job_details import Algorithm, JobDetails
-from src.oceanprotocol_job_details.loaders.loader import Loader
+from oceanprotocol_job_details.dataclasses.job_details import Algorithm, JobDetails
+from oceanprotocol_job_details.loaders.loader import Loader
 
 
 @dataclass(frozen=True)
@@ -51,7 +51,12 @@ class EnvironmentLoader(Loader[JobDetails]):
         )
 
     def _root(self) -> Path:
-        return Path(self.mapper.get(Keys.ROOT, ""))
+        root = Path(self.mapper.get(Keys.ROOT, Path.home()))
+
+        if not root.exists():
+            raise FileNotFoundError(f"Root folder {root} does not exist")
+
+        return root
 
     def _dids(self) -> Sequence[str]:
         return loads(self.mapper.get(Keys.DIDS)) if Keys.DIDS in self.mapper else []
@@ -64,8 +69,11 @@ class EnvironmentLoader(Loader[JobDetails]):
         files: Mapping[str, Sequence[Path]] = {}
         for did in dids:
             # Retrieve DDO from disk
-            file = root / Paths.DDOS / did
-            with open(file, "r") as f:
+            file_path = root / Paths.DDOS / did
+            if not file_path.exists():
+                raise FileNotFoundError(f"DDO file {file_path} does not exist")
+
+            with open(file_path, "r") as f:
                 ddo = load(f)
                 for service in ddo[DidKeys.SERVICE]:
                     if service[DidKeys.SERVICE_TYPE] == ServiceType.METADATA:
@@ -87,11 +95,17 @@ class EnvironmentLoader(Loader[JobDetails]):
 
     def _algorithm(self, root: Path) -> Algorithm:
         did = self.mapper.get(Keys.ALGORITHM, None)
+
         if not did:
             return None
+
+        ddo = root / Paths.DDOS / did
+        if not ddo.exists():
+            raise FileNotFoundError(f"DDO file {ddo} does not exist")
+
         return Algorithm(
             did=did,
-            ddo=root / Paths.DDOS / did,
+            ddo=ddo,
         )
 
     def _secret(self) -> str:

{oceanprotocol_job_details-0.0.1.dist-info → oceanprotocol_job_details-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: oceanprotocol-job-details
-Version: 0.0.1
+Version: 0.0.5
 Summary: A Python package to get details from OceanProtocol jobs
 License: Copyright 2025 Agrospai
          
@@ -29,3 +29,34 @@ A Python package to get details from OceanProtocol jobs
 ```
 pip install oceanprotocol-job-details
 ```
+
+## Usage 
+
+As a simple library, we only need to import the main object and use it once:
+
+```Python
+from oceanprotocol_job_details.job_details import OceanProtocolJobDetails
+
+# Using default parameters
+job_details = OceanProtocolJobDetails().load()
+```
+
+### Advanced Usage (not recommended)
+
+If instead of the environment variables, we want to use another kind of mapping, can pass it as a parameter and it will work as long as it has the same key values (Can be implemented in a more generic way, but there is no need right now).
+
+```Python
+from oceanprotocol_job_details.job_details import OceanProtocolJobDetails
+from oceanprotocol_job_details.loaders.impl.environment import Keys
+
+# Fill in with values that will be used instead of env
+custom_mapper = {
+    Keys.ALGORITHM: " ... ",
+    Keys.DIDS: " ... ",
+    Keys.ROOT: " ... ",
+    Keys.SECRET: " ... ",
+}
+
+job_details = OceanProtocolJobDetails(mapper=custom_mapper).load()
+```
+

oceanprotocol_job_details-0.0.5.dist-info/RECORD

@@ -0,0 +1,13 @@
+oceanprotocol_job_details/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oceanprotocol_job_details/dataclasses/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oceanprotocol_job_details/dataclasses/constants.py,sha256=CWkWtBgKjI8xyHPKIwJ2lStpyCTDnfnWXvcXlIFYWig,773
+oceanprotocol_job_details/dataclasses/job_details.py,sha256=7y8LoiPmAPsS71HRzm6pWbB7TwV9qIwe1Cd2Dgd4liE,860
+oceanprotocol_job_details/job_details.py,sha256=GfzHNAWpYC0SBHdB1O4im5MNfuxLyRn-dFrhhxo2Ogw,946
+oceanprotocol_job_details/loaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oceanprotocol_job_details/loaders/impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oceanprotocol_job_details/loaders/impl/environment.py,sha256=2fu46KssPvwI0wal3UVKeKMf5_WEHJnVW0aLKMf7Nk8,3414
+oceanprotocol_job_details/loaders/loader.py,sha256=JwR6OSkzIQQkeeyAU-ad_F89W9WNvoRwvHQY7Q3zIXI,256
+oceanprotocol_job_details-0.0.5.dist-info/LICENSE,sha256=ni3ix7P_GxK1W3VGC4fJ3o6QoCngCEpSuTJwO4nkpbw,1055
+oceanprotocol_job_details-0.0.5.dist-info/METADATA,sha256=vCYufxlwewMK8WpL37ej6tEZ_7eu-IJMhHKKKusyum8,2793
+oceanprotocol_job_details-0.0.5.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+oceanprotocol_job_details-0.0.5.dist-info/RECORD,,

oceanprotocol_job_details-0.0.1.dist-info/RECORD

@@ -1,27 +0,0 @@
-src/oceanprotocol_job_details/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/oceanprotocol_job_details/dataclasses/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/oceanprotocol_job_details/dataclasses/__pycache__/__init__.cpython-313.pyc,sha256=0ONMfxi9YdNbrlvd7HHyKh2D2cclkF8_sfHxnk4QPT4,210
-src/oceanprotocol_job_details/dataclasses/__pycache__/__init__.cpython-39.pyc,sha256=7IaVhvOAnm2gtr5G8j5exCNzoBYsr7hcEbDmAEEqTro,214
-src/oceanprotocol_job_details/dataclasses/__pycache__/constants.cpython-313.pyc,sha256=_7cahtV77VBhIQRsHzVXEkdJy-hZcJfbx50EAvwhrB8,1886
-src/oceanprotocol_job_details/dataclasses/__pycache__/constants.cpython-39.pyc,sha256=CKNB_CwiQ3ovpftAPEeQF1ZvZgz7OmpNYN7DGA94yZM,1428
-src/oceanprotocol_job_details/dataclasses/__pycache__/job_details.cpython-313.pyc,sha256=kUxopSviCQSMPQCP5YcApB9TXUwR6XN9BI9m3rE-UKo,1369
-src/oceanprotocol_job_details/dataclasses/__pycache__/job_details.cpython-39.pyc,sha256=C3n5BqEo0ZQo4DYXqWvMj3NYW-XKVFxWtec7dbUpJ6k,1042
-src/oceanprotocol_job_details/dataclasses/constants.py,sha256=CWkWtBgKjI8xyHPKIwJ2lStpyCTDnfnWXvcXlIFYWig,773
-src/oceanprotocol_job_details/dataclasses/job_details.py,sha256=7y8LoiPmAPsS71HRzm6pWbB7TwV9qIwe1Cd2Dgd4liE,860
-src/oceanprotocol_job_details/job_details.py,sha256=w0SKnmNlAj7rBRx3uqZ3VkxFcLK15tzDKV-a2ZjJLio,765
-src/oceanprotocol_job_details/loaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/oceanprotocol_job_details/loaders/__pycache__/__init__.cpython-313.pyc,sha256=caqlfFNy8aRS-NJB1cTGZcxYpTtEN-jo3ko3URP0xnA,206
-src/oceanprotocol_job_details/loaders/__pycache__/__init__.cpython-39.pyc,sha256=pc23pM8sGE4f260FM8sT-M0Qql660vUDjtrt7phY4W8,210
-src/oceanprotocol_job_details/loaders/__pycache__/loader.cpython-313.pyc,sha256=vHfalXDEN178-qFNfAqPhkFTSB8JhlBG_lRcpPbddUU,827
-src/oceanprotocol_job_details/loaders/__pycache__/loader.cpython-39.pyc,sha256=tXChWYmZnyBtRgPQoHGP3i3dHMpPmxP-f_rCz92i1Gk,693
-src/oceanprotocol_job_details/loaders/impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/oceanprotocol_job_details/loaders/impl/__pycache__/__init__.cpython-313.pyc,sha256=SfhHqoTLJUeOLvPm9_x4niYNVumJaP4L4ilj8GNLbR0,211
-src/oceanprotocol_job_details/loaders/impl/__pycache__/__init__.cpython-39.pyc,sha256=zeCeX-1xNkV2K7Wc-pxUiqiA6YGSzxHtrX0MwHvs46g,215
-src/oceanprotocol_job_details/loaders/impl/__pycache__/environment.cpython-313.pyc,sha256=hWSoqiSjFPAPuPZTiagjcHQpKDvHJU0feETedMVXenM,5628
-src/oceanprotocol_job_details/loaders/impl/__pycache__/environment.cpython-39.pyc,sha256=jRusbU4hEZNwAceFjicor38yipl3_768zeUnOHuy5BA,3824
-src/oceanprotocol_job_details/loaders/impl/environment.py,sha256=Eej428jnf2XX3Tv_K4sGFBKG-ZYIyDqN6e4m3_gF1JI,3041
-src/oceanprotocol_job_details/loaders/loader.py,sha256=JwR6OSkzIQQkeeyAU-ad_F89W9WNvoRwvHQY7Q3zIXI,256
-oceanprotocol_job_details-0.0.1.dist-info/LICENSE,sha256=ni3ix7P_GxK1W3VGC4fJ3o6QoCngCEpSuTJwO4nkpbw,1055
-oceanprotocol_job_details-0.0.1.dist-info/METADATA,sha256=4BJ-6XobKtaD-c0lBVGGLQhxV-qdppugIIFP0DHwkY8,1857
-oceanprotocol_job_details-0.0.1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-oceanprotocol_job_details-0.0.1.dist-info/RECORD,,

src/oceanprotocol_job_details/job_details.py

@@ -1,20 +0,0 @@
-from typing import Literal, Optional
-from src.oceanprotocol_job_details.dataclasses.job_details import JobDetails
-from src.oceanprotocol_job_details.loaders.loader import Loader
-from src.oceanprotocol_job_details.loaders.impl.environment import EnvironmentLoader
-
-_Implementations = Literal["env"]
-
-
-class OceanProtocolJobDetails(Loader[JobDetails]):
-    """Decorator that loads the JobDetails from the given implementation"""
-
-    def __init__(self, implementation: Optional[_Implementations], *args, **kwargs):
-        # As there are not more implementations, we can use the EnvironmentLoader directly
-        self._loader = lambda: EnvironmentLoader(*args, **kwargs)
-
-    def load(self) -> JobDetails:
-        return self._loader().load()
-
-
-del _Implementations