oceanprotocol-job-details 0.2.0__tar.gz → 0.2.2__tar.gz

{oceanprotocol_job_details-0.2.0 → oceanprotocol_job_details-0.2.2}/PKG-INFO

@@ -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.2/README.md

@@ -0,0 +1,52 @@
+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 import JobDetails
+
+# Having no algorithm input parameters
+job_details = JobDetails.load()
+
+```
+
+If our algorithm has custom input parameters and we want to load them into our algorithm, we can do it as follows:
+
+```Python
+
+from dataclasses import dataclass
+from oceanprotocol_job_details import JobDetails
+
+
+@dataclass
+class InputParameters:
+    name: str
+    age: int
+
+
+job_details: JobDetails[InputParameters] = JobDetails.load(InputParameters)
+
+# Usage (is type hinted)
+job_details.input_parameters.name
+job_details.input_parameters.age
+
+```
+
+Assumes the directory structure of OceanProtocol algorithms.
+
+### Core functionalities
+
+Given the Ocean Protocol job details structure, parses the passed algorithm parameters into an object to use in your algorithms.
+
+1. Input parameter JSON parsing and validation
+1. Metadata and service extraction from the directory structure.

oceanprotocol_job_details-0.2.2/oceanprotocol_job_details/__init__.py

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

{oceanprotocol_job_details-0.2.0 → oceanprotocol_job_details-0.2.2}/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 → oceanprotocol_job_details-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oceanprotocol-job-details"
-version = "0.2.0"
+version = "0.2.2"
 description = "A Python package to get details from OceanProtocol jobs"
 authors = [
     { name = "Christian López García", email = "christian.lopez@udl.cat" },

oceanprotocol_job_details-0.2.0/README.md

@@ -1,60 +0,0 @@
-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
-
-# Having no algorithm input parameters
-job_details = OceanProtocolJobDetails().load()  # type: ignore
-
-```
-
-If our algorithm has custom input parameters and we want to load them into our algorithm, we can do it as follows:
-
-```Python
-
-from dataclasses import dataclass
-from oceanprotocol_job_details.job_details import OceanProtocolJobDetails
-from oceanprotocol_job_details.ocean import JobDetails
-
-@dataclass
-class Input:
-    name: str
-    age: int
-
-job_details: JobDetails[Input] = OceanProtocolJobDetails(Input).load()
-
-# Usage (is type hinted)
-job_details.input_parameters.name
-job_details.input_parameters.age
-
-```
-
-Assumes the following directory structure:
-```
-<ROOT_FOLDER>
-└───data
-    ├───ddos
-    ├───transformation
-    ├───inputs
-    └───logs
-```
-
-### 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.
-
-1. Parsing JSON
-1. Validation
-1. Metadata and service extraction