oceanprotocol-job-details 0.0.1__tar.gz → 0.0.3__tar.gz

{oceanprotocol_job_details-0.0.1 → oceanprotocol_job_details-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: oceanprotocol-job-details
-Version: 0.0.1
+Version: 0.0.3
 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.3/README.md

@@ -0,0 +1,39 @@
+A Python package to get details from OceanProtocol jobs
+
+---
+
+## Installation
+
+```
+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.3/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

{oceanprotocol_job_details-0.0.1/src → oceanprotocol_job_details-0.0.3}/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)

{oceanprotocol_job_details-0.0.1 → oceanprotocol_job_details-0.0.3}/pyproject.toml

@@ -2,7 +2,7 @@
 license = { file = "LICENSE" }
 
 name = "oceanprotocol-job-details"
-version = "0.0.1"
+version = "0.0.3"
 authors = [
     { name = "Christian López García", email = "christian.lopez@udl.cat" },
 ]
@@ -24,7 +24,7 @@ requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-packages = [{ include = "src/oceanprotocol_job_details" }]
+packages = [{ include = "oceanprotocol_job_details" }]
 
 [tool.poetry.dependencies]
 python = ">3.9"

oceanprotocol_job_details-0.0.1/README.md

@@ -1,9 +0,0 @@
-A Python package to get details from OceanProtocol jobs
-
----
-
-## Installation
-
-```
-pip install oceanprotocol-job-details
-```

oceanprotocol_job_details-0.0.1/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