oceanprotocol-job-details 0.3.1__py3-none-any.whl → 0.3.2__py3-none-any.whl

oceanprotocol_job_details/__init__.py

@@ -1,4 +1,4 @@
+from .helpers import create_container, load_job_details
 from .ocean import JobDetails
 
-
-__all__ = [JobDetails]  # type: ignore
+__all__ = [JobDetails, load_job_details, create_container]  # type: ignore

oceanprotocol_job_details/helpers.py

@@ -0,0 +1,29 @@
+from typing import Any, Dict, Type, TypeVar
+
+from pydantic import BaseModel, JsonValue
+
+from oceanprotocol_job_details.di import Container
+from oceanprotocol_job_details.ocean import JobDetails
+from oceanprotocol_job_details.settings import JobSettings
+
+InputParametersT = TypeVar("InputParametersT", bound=BaseModel)
+
+
+def create_container(config: Dict[str, Any]) -> Container[InputParametersT]:  # type: ignore[explicit-any]
+    """Return a fully configured Container from a config dict."""
+    container = Container[InputParametersT]()
+    settings = JobSettings(**config)
+    container.config.from_pydantic(settings)
+    return container
+
+
+def load_job_details(
+    config: Dict[str, JsonValue],
+    input_type: Type[InputParametersT],
+) -> JobDetails[InputParametersT]:
+    """
+    Load JobDetails for a given input_type using the config.
+    Returns a fully initialized JobDetails instance.
+    """
+    container: Container[InputParametersT] = create_container(config)
+    return container.job_details_loader(input_type=input_type).load()

{oceanprotocol_job_details-0.3.1.dist-info → oceanprotocol_job_details-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oceanprotocol-job-details
-Version: 0.3.1
+Version: 0.3.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
@@ -30,24 +30,29 @@ A Python package to get details from OceanProtocol jobs
 
 ## Installation
 
-```
+```bash
 pip install oceanprotocol-job-details
 ```
 
-## Usage 
+```bash
+uv add oceanprotocol-job-details
+```
+
+## Usage
 
-As a simple library, we only need to import `JobDetails` and load it, it will:
+As a simple library, we only need to import `load_job_details` and run it. It will:
 
-1. Fetch the needed parameters to populate the `JobDetails` instance from the environment variables or use the passed values to the `load()` method.
+1. Fetch the needed parameters to populate the `JobDetails` instance from the environment variables or use the passed values to the function.
 1. Look for the files corresponding to the passed DIDs in the filesystem according to the [Ocean Protocol Structure](#oceanprotocol-structure) and load them into the `JobDetails` instance.
 
-
 ### Minimal Example
 
 ```python
-from oceanprotocol_job_details import JobDetails
+from oceanprotocol_job_details import load_job_details
 
-job_details = JobDetails.load()
+class InputParameters(BaseModel): ...
+
+job_details = load_job_details({}, InputParameters)
 ```
 
 ### Custom Input Parameters
@@ -55,58 +60,40 @@ 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:
-    foobar: str
-
-
-job_details = JobDetails[InputParameters].load(InputParameters)
-
-# Usage
-job_details.input_parameters.foobar
-```
-
-```python
-from dataclasses import dataclass
-from oceanprotocol_job_details import JobDetails
+from pydantic import BaseModel
+from oceanprotocol_job_details import load_job_details
 
 
-@dataclass
-class Foo:
+class Foo(BaseModel):
     bar: str
 
 
-@dataclass
-class InputParameters:
+class InputParameters(BaseModel):
     # Allows for nested types
     foo: Foo
 
 
-job_details = JobDetails[InputParameters].load(InputParameters)
+job_details = load_job_details({}, InputParameters)
 
 # Usage
+job_details.input_parameters.foo
 job_details.input_parameters.foo.bar
 ```
 
-The values to fill the custom `InputParameters` will be parsed from the `algoCustomData.json` located next to the input data directories. 
+The values to fill the custom `InputParameters` will be parsed from the `algoCustomData.json` located next to the input data directories.
 
 ### Iterating Input Files the clean way
 
 ```python
-from oceanprotocol_job_details import JobDetails
+from oceanprotocol_job_details import load_job_details
 
 
-job_details = JobDetails.load()
+job_details = load_job_details
 
-for idx, file_path in job_details.next_file():
+for idx, file_path in job_details.inputs():
     ...
 
-# Or if you just want one file path
-_, file_path = job_details.next_file()
+_, file_path = next(job_details.inputs())
 ```
 
 ## OceanProtocol Structure
@@ -124,4 +111,4 @@ data        # Root /data directory
 └── outputs # Algorithm output files dir
 ```
 
-> **_Note:_** Even though it's possible that the algorithm is passed multiple datasets, right now the implementation only allows to use **one dataset** per algorithm execution, so **normally** the executing job will only have **one ddo**, **one dir** inside inputs, and **one data file** named `0`.
+> **_Note:_** Even though it's possible that the algorithm is passed multiple datasets, right now the implementation only allows to use **one dataset** per algorithm execution, so **normally** the executing job will only have **one ddo**, **one dir** inside inputs, and **one data file** named `0`.

{oceanprotocol_job_details-0.3.1.dist-info → oceanprotocol_job_details-0.3.2.dist-info}/RECORD

@@ -1,6 +1,7 @@
-oceanprotocol_job_details/__init__.py,sha256=iVJs6gQHV84d25iTq2Ot-R2BDWMor5jum04Wh_PuYzg,71
+oceanprotocol_job_details/__init__.py,sha256=nJMrZsEC5F1n9WF-v5QV095Yyc8UkhFw0AzD9o7X0IE,162
 oceanprotocol_job_details/di.py,sha256=lsogbmjvmPfkd0mjLvn9vYLIZebwJm5RNraWt7WE5LA,1316
 oceanprotocol_job_details/domain.py,sha256=2_USbeA_7VIEYS8DVb2MW6dCZasjiqIxQaGUnNUKspY,3851
+oceanprotocol_job_details/helpers.py,sha256=ubH_KjAROqYvn0mkbA0-89vpdKIhVNGZ0h9pQLfPNow,1045
 oceanprotocol_job_details/ocean.py,sha256=q8rgT5ycA2ifey3XNhUW0bcJwfMp7hpKU-6EVDeKV1o,1620
 oceanprotocol_job_details/settings.py,sha256=Xliw3SXSGboCp2OqF-yzXVLDuEoq9kAPhQQSMuHSoDg,1014
 oceanprotocol_job_details/loaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -9,7 +10,7 @@ oceanprotocol_job_details/loaders/impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JC
 oceanprotocol_job_details/loaders/impl/ddo.py,sha256=XthrQFhmP85XSVzVjBlLePtTowGR3BAsmVp3jngiQ08,668
 oceanprotocol_job_details/loaders/impl/files.py,sha256=3Zg7JnxT67iFKsd95VVKYMEYZgjPcGU4Kqpo2B9aZQI,1327
 oceanprotocol_job_details/loaders/impl/job_details.py,sha256=7mEdeTo-cmsWuqWPdN7btjLjo6p5Oa1_acjSLWL5tb8,697
-oceanprotocol_job_details-0.3.1.dist-info/METADATA,sha256=6TRbrQ3P91_U1sjami7o5r0SwS-BNZNMiJym0yaI0IA,4573
-oceanprotocol_job_details-0.3.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-oceanprotocol_job_details-0.3.1.dist-info/licenses/LICENSE,sha256=ni3ix7P_GxK1W3VGC4fJ3o6QoCngCEpSuTJwO4nkpbw,1055
-oceanprotocol_job_details-0.3.1.dist-info/RECORD,,
+oceanprotocol_job_details-0.3.2.dist-info/METADATA,sha256=VDGsLGPWchYb0Or1sEmqQw3bJxh5y8z6NdAkEF8qXgE,4416
+oceanprotocol_job_details-0.3.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+oceanprotocol_job_details-0.3.2.dist-info/licenses/LICENSE,sha256=ni3ix7P_GxK1W3VGC4fJ3o6QoCngCEpSuTJwO4nkpbw,1055
+oceanprotocol_job_details-0.3.2.dist-info/RECORD,,