ocean-runner 0.2.3__tar.gz → 0.2.5__tar.gz

{ocean_runner-0.2.3 → ocean_runner-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ocean-runner
-Version: 0.2.3
+Version: 0.2.5
 Summary: A fluent API for OceanProtocol algorithms
 Project-URL: Homepage, https://github.com/AgrospAI/ocean-runner
 Project-URL: Issues, https://github.com/AgrospAI/ocean-runner/issues
@@ -26,6 +26,14 @@ Description-Content-Type: text/markdown
 Ocean Runner is a package that brings a fluent API for APP creation and running in the scope of OceanProtocol.
 
 
+## Installation
+
+```bash
+pip install ocean-runner
+# or
+uv add ocean-runner
+```
+
 ## Usage
 
 ### Minimal Example
@@ -126,6 +134,11 @@ Algorithm(
             """
             Random secret to use while testing.
             """
+
+            runtime: "dev",
+            """
+            Runtime mode. "dev" to run normally, "test" to run pytest
+            """
         )
         """
         Should not be needed in production algorithms, used to mock environment variables, defaults to using env.
@@ -180,8 +193,9 @@ As seen in the minimal example, all methods implemented in `Algorithm` have a de
 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.
+- `DIDS` Input dataset(s) DID's, must have format: `["abc..90"]`
+- `TRANSFORMATION_DID` Algorithm DID, must have format: `abc..90`
+- `SECRET` Algorithm secret.
+- `BASE_DIR` (optional, default="/data"): Base path to the OceanProtocol data directories.
+- `RUNTIME` (optional, default="dev"): Runtime mode
 

{ocean_runner-0.2.3 → ocean_runner-0.2.5}/README.md

@@ -3,6 +3,14 @@
 Ocean Runner is a package that brings a fluent API for APP creation and running in the scope of OceanProtocol.
 
 
+## Installation
+
+```bash
+pip install ocean-runner
+# or
+uv add ocean-runner
+```
+
 ## Usage
 
 ### Minimal Example
@@ -103,6 +111,11 @@ Algorithm(
             """
             Random secret to use while testing.
             """
+
+            runtime: "dev",
+            """
+            Runtime mode. "dev" to run normally, "test" to run pytest
+            """
         )
         """
         Should not be needed in production algorithms, used to mock environment variables, defaults to using env.
@@ -157,8 +170,9 @@ As seen in the minimal example, all methods implemented in `Algorithm` have a de
 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.
+- `DIDS` Input dataset(s) DID's, must have format: `["abc..90"]`
+- `TRANSFORMATION_DID` Algorithm DID, must have format: `abc..90`
+- `SECRET` Algorithm secret.
+- `BASE_DIR` (optional, default="/data"): Base path to the OceanProtocol data directories.
+- `RUNTIME` (optional, default="dev"): Runtime mode
 

{ocean_runner-0.2.3 → ocean_runner-0.2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ocean-runner"
-version = "0.2.3"
+version = "0.2.5"
 description = "A fluent API for OceanProtocol algorithms"
 authors = [
     { name = "AgrospAI", email = "agrospai@udl.cat" },