ocean-runner 0.2.3__py3-none-any.whl → 0.2.5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. {ocean_runner-0.2.3.dist-info → ocean_runner-0.2.5.dist-info}/METADATA +19 -5
  2. {ocean_runner-0.2.3.dist-info → ocean_runner-0.2.5.dist-info}/RECORD +4 -4
  3. {ocean_runner-0.2.3.dist-info → ocean_runner-0.2.5.dist-info}/WHEEL +0 -0
  4. {ocean_runner-0.2.3.dist-info → ocean_runner-0.2.5.dist-info}/licenses/LICENSE +0 -0
{ocean_runner-0.2.3.dist-info → ocean_runner-0.2.5.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ocean-runner
3
- Version: 0.2.3
3
+ Version: 0.2.5
4
4
  Summary: A fluent API for OceanProtocol algorithms
5
5
  Project-URL: Homepage, https://github.com/AgrospAI/ocean-runner
6
6
  Project-URL: Issues, https://github.com/AgrospAI/ocean-runner/issues
@@ -26,6 +26,14 @@ Description-Content-Type: text/markdown
26
26
  Ocean Runner is a package that brings a fluent API for APP creation and running in the scope of OceanProtocol.
27
27
 
28
28
 
29
+ ## Installation
30
+
31
+ ```bash
32
+ pip install ocean-runner
33
+ # or
34
+ uv add ocean-runner
35
+ ```
36
+
29
37
  ## Usage
30
38
 
31
39
  ### Minimal Example
@@ -126,6 +134,11 @@ Algorithm(
126
134
  """
127
135
  Random secret to use while testing.
128
136
  """
137
+
138
+ runtime: "dev",
139
+ """
140
+ Runtime mode. "dev" to run normally, "test" to run pytest
141
+ """
129
142
  )
130
143
  """
131
144
  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
180
193
  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.
181
194
 
182
195
  Environment variables:
183
- - *DIDS*: Input dataset(s) DID's.
184
- - *TRANSFORMATION_DID*: Algorithm DID.
185
- - *SECRET*: Algorithm secret.
186
- - *BASE_DIR* (optional, default='/data'): Base path to the OceanProtocol data directories.
196
+ - `DIDS` Input dataset(s) DID's, must have format: `["abc..90"]`
197
+ - `TRANSFORMATION_DID` Algorithm DID, must have format: `abc..90`
198
+ - `SECRET` Algorithm secret.
199
+ - `BASE_DIR` (optional, default="/data"): Base path to the OceanProtocol data directories.
200
+ - `RUNTIME` (optional, default="dev"): Runtime mode
187
201
 
{ocean_runner-0.2.3.dist-info → ocean_runner-0.2.5.dist-info}/RECORD RENAMED
@@ -2,7 +2,7 @@ ocean_runner/__init__.py,sha256=awAmE6kZhuwcrD3gT7qFZArdhiuzW-EFTA6tGKhw06k,138
2
2
  ocean_runner/config.py,sha256=zzpGxotGhGnNdHKFJqQ7fuXK5zW2IGOpzftHilcySD4,1644
3
3
  ocean_runner/runner.py,sha256=n5odQp11yUllkOXrrwYsnQGRGXmCJCh0cQhPR81am94,4503
4
4
  ocean_runner/runtime_mode.py,sha256=WbGTaoL3hxBWbxM8luwyOwwtQonqyIhbus0_Jd-F-3k,83
5
- ocean_runner-0.2.3.dist-info/METADATA,sha256=ukIdHO2uumLlDyunACWc8UV-mPE_UsfmVEncLrqNTaQ,5781
6
- ocean_runner-0.2.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
7
- ocean_runner-0.2.3.dist-info/licenses/LICENSE,sha256=_B25KqK4amoADWkMN150tnZFm_Fy7VvZpvIC8ZydWdI,1053
8
- ocean_runner-0.2.3.dist-info/RECORD,,
5
+ ocean_runner-0.2.5.dist-info/METADATA,sha256=BU0al5bWLGj6P7PzWXyOMH6T5AJTQe9jN52OnXBgYs0,6102
6
+ ocean_runner-0.2.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
7
+ ocean_runner-0.2.5.dist-info/licenses/LICENSE,sha256=_B25KqK4amoADWkMN150tnZFm_Fy7VvZpvIC8ZydWdI,1053
8
+ ocean_runner-0.2.5.dist-info/RECORD,,