Usage

Installation¶

runnable is a python package and should be installed like any other python package. The minimum python version is 3.8

pip install runnable

We recommend the installation in a virtual environment using poetry or any other package manager.

To run the pipelines/functions/notebooks in a container, install runnable with docker functionality.

pip install "runnable[docker]"

To use notebooks as tasks, install runnable with notebook functionality.

pip install "runnable[notebook]"

Pipelines defined in runnable can be either via python sdk or yaml based definitions.

To execute a pipeline, defined in yaml, use the runnable cli. The options are detailed below:

-f, --file (str): The pipeline definition file, defaults to pipeline.yaml
-c, --config-file (str): config file to be used for the run [default: None]
-p, --parameters-file (str): Parameters accessible by the application [default: None]
--log-level : The log level, one of INFO | DEBUG | WARNING| ERROR| FATAL [default: INFO]
--tag (str): A tag attached to the run[default: ]
--run-id (str): An optional run_id, one would be generated if not provided
--use-cached (str): Provide the previous run_id to re-run.

All the examples in the documentation are present in the examples directory of the repo with instructions on how to run them.

All the examples are tested, with multiple configurations, as part of our CI test suite.