This section documents the SOG command processor Application Programming Interface (API). The API allows software that runs SOG (e.g. SoG-bloomcast) so that SOG commands can be used dirctly, rather than by way of a subprocess.
Run a collection of SOG jobs in batch mode.
Parameters: |
|
---|---|
Returns: | Return code from batch run; zero if all runs succeed, otherwise, maximum of return codes from failed jobs. |
Return type: | int |
Return value for specified infile key.
Parameters: |
|
---|---|
Returns value: | Infile value associated with key |
Return type: | str |
Launch SOG with the specified args, and return the run’s subprocess instance.
Parameters: |
|
---|---|
Returns: | Process object for the launched SOG run. |
Return type: | subprocess.Popen instance |