oceanprotocol-job-details 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

oceanprotocol_job_details/__init__.py

@@ -0,0 +1,4 @@
+from .ocean import JobDetails
+
+
+__all__ = [JobDetails]

oceanprotocol_job_details/ocean.py

@@ -264,7 +264,13 @@ class JobDetails(Generic[T]):
                 ) from e
 
     @classmethod
-    def load(cls, _type: Type[T] | None = None) -> JobDetails[T]:
+    def load(
+        cls,
+        _type: Type[T] | None = None,
+        dids: str | None = None,
+        transformation_did: str | None = None,
+        secret: str | None = None,
+    ) -> JobDetails[T]:
         """Load a JobDetails instance that holds the runtime details.
 
         Loading it will check the following:
@@ -284,9 +290,10 @@ class JobDetails(Generic[T]):
         container = Container()
         container.config.from_dict(
             {
-                "dids": os.environ.get("DIDS"),
-                "transformation_did": os.environ.get("TRANSFORMATION_DID"),
-                "secret": os.environ.get("SECRET"),
+                "dids": dids or os.environ.get("DIDS"),
+                "transformation_did": transformation_did
+                or os.environ.get("TRANSFORMATION_DID"),
+                "secret": secret or os.environ.get("SECRET"),
             }
         )
 

{oceanprotocol_job_details-0.2.0.dist-info → oceanprotocol_job_details-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oceanprotocol-job-details
-Version: 0.2.0
+Version: 0.2.2
 Summary: A Python package to get details from OceanProtocol jobs
 Project-URL: Homepage, https://github.com/AgrospAI/oceanprotocol-job-details
 Project-URL: Issues, https://github.com/AgrospAI/oceanprotocol-job-details/issues
@@ -37,10 +37,10 @@ pip install oceanprotocol-job-details
 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
+from oceanprotocol_job_details import JobDetails
 
 # Having no algorithm input parameters
-job_details = OceanProtocolJobDetails().load()  # type: ignore
+job_details = JobDetails.load()
 
 ```
 
@@ -49,15 +49,16 @@ If our algorithm has custom input parameters and we want to load them into our a
 ```Python
 
 from dataclasses import dataclass
-from oceanprotocol_job_details.job_details import OceanProtocolJobDetails
-from oceanprotocol_job_details.ocean import JobDetails
+from oceanprotocol_job_details import JobDetails
+
 
 @dataclass
-class Input:
+class InputParameters:
     name: str
     age: int
 
-job_details: JobDetails[Input] = OceanProtocolJobDetails(Input).load()
+
+job_details: JobDetails[InputParameters] = JobDetails.load(InputParameters)
 
 # Usage (is type hinted)
 job_details.input_parameters.name
@@ -65,20 +66,11 @@ job_details.input_parameters.age
 
 ```
 
-Assumes the following directory structure:
-```
-<ROOT_FOLDER>
-└───data
-    ├───ddos
-    ├───transformation
-    ├───inputs
-    └───logs
-```
+Assumes the directory structure of OceanProtocol algorithms.
 
 ### Core functionalities
 
-Given the Ocean Protocol job details structure as in [https://github.com/GX4FM-Base-X/pontus-x-ontology](Pontus-X Ontology), parses the passed algorithm parameters into an object to use in your algorithms.
+Given the Ocean Protocol job details structure, parses the passed algorithm parameters into an object to use in your algorithms.
 
-1. Parsing JSON
-1. Validation
-1. Metadata and service extraction
+1. Input parameter JSON parsing and validation
+1. Metadata and service extraction from the directory structure.

{oceanprotocol_job_details-0.2.0.dist-info → oceanprotocol_job_details-0.2.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
-oceanprotocol_job_details/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oceanprotocol_job_details/__init__.py,sha256=C67wv7fy5ZT5FtbGD-oQeSoLU-x6e2ts-820koFo034,55
 oceanprotocol_job_details/di.py,sha256=mLhxm-fiqC4TuPUIEG5eqsgmtmY3N64g6Ep8NgQR6pA,1131
-oceanprotocol_job_details/ocean.py,sha256=l-MunbeDBZhPATLZL5nKyo2i7RAznTqMRjY-wJEkxVw,6686
+oceanprotocol_job_details/ocean.py,sha256=WB8xEw5y0G0klbbdgmJFZfaM62bw4nfvyuYU11lgw4g,6880
 oceanprotocol_job_details/paths.py,sha256=gzWj8HPKjJAQ6FUjOobWWzrW1Kzpxq2bXxQ9icDAy24,723
 oceanprotocol_job_details/loaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 oceanprotocol_job_details/loaders/loader.py,sha256=HIzsVKCuGP7ghfM7ppN3ANVybvsA64wr3h8I68mqS6A,195
@@ -8,7 +8,7 @@ oceanprotocol_job_details/loaders/impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JC
 oceanprotocol_job_details/loaders/impl/ddo.py,sha256=_xl0PozuvIm0n6jU--Znk6qfw1A6OLBq3SERbDGIF74,844
 oceanprotocol_job_details/loaders/impl/files.py,sha256=oFkA_0Ma5NBgWvVEk_rhyDIDrAam_zjesh0-bxZaIU8,1443
 oceanprotocol_job_details/loaders/impl/job_details.py,sha256=wf0xNAG4tESq57vqkdtMQ8BdiyS91j5f7FL8Gfwbjh4,770
-oceanprotocol_job_details-0.2.0.dist-info/METADATA,sha256=1oFkqVCvdw0vue35sCM2EmkfbLFcwTIwptJLHxFo4DY,3214
-oceanprotocol_job_details-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oceanprotocol_job_details-0.2.0.dist-info/licenses/LICENSE,sha256=ni3ix7P_GxK1W3VGC4fJ3o6QoCngCEpSuTJwO4nkpbw,1055
-oceanprotocol_job_details-0.2.0.dist-info/RECORD,,
+oceanprotocol_job_details-0.2.2.dist-info/METADATA,sha256=cz9Y5MwTyD0Lz-snU0rEF6H1HjdMKKrMp070fMclLiE,2948
+oceanprotocol_job_details-0.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oceanprotocol_job_details-0.2.2.dist-info/licenses/LICENSE,sha256=ni3ix7P_GxK1W3VGC4fJ3o6QoCngCEpSuTJwO4nkpbw,1055
+oceanprotocol_job_details-0.2.2.dist-info/RECORD,,