ocean-runner 0.1.0__py3-none-any.whl

ocean_runner-0.1.0.dist-info/METADATA

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: ocean-runner
+Version: 0.1.0
+Summary: A Python PyPI package template
+Project-URL: Homepage, https://github.com/AgrospAI/ocean-runner
+Project-URL: Issues, https://github.com/AgrospAI/ocean-runner/issues
+Author-email: John Doe <john.doe@foo.bar>
+License: Copyright 2025 spin3l
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: oceanprotocol-job-details==0.2.4
+Requires-Dist: pytest>=8.4.2
+Description-Content-Type: text/markdown
+
+# ocean-runner
+
+Ocean Runner is a package that brings a fluent API for APP creation and running in the scope of OceanProtocol.
+
+
+## Usage
+
+### Minimal Example
+
+```python
+import random
+from ocean_runner import Algorithm, Config
+
+
+Algorithm().run(lambda _: random.randint()).save_results()    
+```
+
+To use minimally the API, you can just provide a callback to the run method, defaulting for the rest of behaviours. This code snippet will:
+
+- Read the OceanProtocol JobDetails from the environment variables and use default file paths.
+- Generate a random integer.
+- Store the result in a "result.txt" file within the default outputs path.
+
+### Tuning
+
+#### Application Config
+
+The application configuration can be tweaked by passing a Config instance to its' constructor.
+
+```python
+Algorithm(
+    Config(
+        custom_input: ... # dataclass
+        # Custom algorithm parameters dataclass.
+        
+        error_callback: ... # Callable[[Exception], None]
+        # Callback to run on exceptions.
+        
+        logger: ... # type: logging.Logger
+        # Custom logger to use.
+        
+        environment: ... 
+        # type: ocean_runner.Environment. Mock of environment variables.
+    )
+)
+```
+
+```python
+import logging
+
+
+@dataclass
+class CustomInput:
+    foobar: string 
+
+
+logger = logging.getLogger(__name__)
+
+
+Algorithm(
+    Config(
+        custom_input: CustomInput,
+        """
+        Load the Algorithm's Custom Input into a CustomInput dataclass instance.
+        """
+
+        error_callback: lambda ex: logger.exception(ex),
+        """
+        Run this callback when an exception is caught
+        NOTE: it's not recommended to catch exceptions this way. Should re-raise and halt the execution.
+        """
+
+        logger: logger,
+        """
+        Custom logger to use in the Algorithm.
+        """
+
+        environment: Environment(
+            base_dir: "./_data",
+            """
+            Custom data path to use test data.
+            """
+
+            dids: '["17feb697190d9f5912e064307006c06019c766d35e4e3f239ebb69fb71096e42"]',
+            """
+            Dataset DID.
+            """
+
+            transformation_did: "1234",
+            """
+            Random transformation DID to use while testing.
+            """
+
+            secret: "1234",
+            """
+            Random secret to use while testing.
+            """
+        )
+        """
+        Should not be needed in production algorithms, used to mock environment variables, defaults to using env.
+        """
+    )
+)
+
+```
+
+## Default behaviours
+
+### Default implementations
+
+As seen in the minimal example, all methods implemented in `Algorithm` have a default implementation which will be commented here.
+
+```python
+
+(
+    Algorithm()
+    
+        """
+        Default constructor, will use default values of Config.
+        """
+    
+    .validate()
+    
+        """
+        Will validate the algorithm's job detail instance, checking for the existence of:
+        - `job_details.ddos` 
+        - `job_details.files`
+        """
+
+    .run()
+
+        """ 
+        Has NO default implementation, must pass a callback that returns a result of any type.
+        """
+
+    .save_results()
+
+        """
+        Stores the result of running the algorithm in "outputs/results.txt"
+        """
+
+)
+
+
+```
+
+### Job Details
+
+To load the OceanProtocol JobDetails instance, the program will read some environment variables, they can be mocked passing an instance of `Environment` through the configuration of the algorithm.
+
+Environment variables:
+- *DIDS*: Input dataset(s) DID's.
+- *TRANSFORMATION_DID*: Algorithm DID.
+- *SECRET*: Algorithm secret.
+- *BASE_DIR* (optional, default='/data'): Base path to the OceanProtocol data directories.
+

ocean_runner-0.1.0.dist-info/RECORD

@@ -0,0 +1,4 @@
+ocean_runner-0.1.0.dist-info/METADATA,sha256=RNcTJa7JJDpda1CbBiRFUQgBANV0h8PR_b-TNuYgS2U,5420
+ocean_runner-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ocean_runner-0.1.0.dist-info/licenses/LICENSE,sha256=_B25KqK4amoADWkMN150tnZFm_Fy7VvZpvIC8ZydWdI,1053
+ocean_runner-0.1.0.dist-info/RECORD,,

ocean_runner-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ocean_runner-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 spin3l
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.