add local run example (#8)

Author: genric

.dockerignore

@@ -1,2 +1,3 @@
 .git
 .tox
+venv/

.gitignore

@@ -7,4 +7,5 @@ build/
 dist/
 doc/build
 doc/source/generated
+venv/
 .tox

Makefile

@@ -1,4 +1,4 @@
-.PHONY: help python_build docker_build_latest run
+.PHONY: help python_build docker_build_latest run install_to_venv
 
 IMAGE_NAME?=bbp-workflow
 
@@ -23,3 +23,10 @@ docker_build_latest: # python_build
 
 run:
 	docker run -it --rm --user $$(id -u) -e DEBUG=True $(IMAGE_NAME)
+
+venv:
+	if python -m ensurepip --version; then python -m venv $@; else virtualenv $@; fi
+	venv/bin/pip install --upgrade pip
+
+install_to_venv: | venv
+	venv/bin/pip install --upgrade bbp-workflow

README.rst

@@ -27,6 +27,14 @@ Tests
     pip install tox
     tox
 
+Local Run
+=========
+
+.. code-block:: bash
+
+    make install_to_venv
+    ./bbp-workflow-launch.sh --config workflows/foo.cfg foo Bar dynamic-param=world
+
 Acknowledgements
 ================
 

bbp-workflow-launch.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+set -e
+source venv/bin/activate
+
+WORKFLOWS_DIR=$(realpath workflows)
+if [[ $1 == '--workflows-dir' ]]; then
+    WORKFLOWS_DIR=$(realpath "$2")
+    shift; shift
+fi
+
+if [[ $1 == '--config' ]]; then
+    export LUIGI_CONFIG_PATH=$(realpath "$2")
+    shift; shift
+fi
+
+export PYTHONPATH=$WORKFLOWS_DIR
+
+if [[ "$1" ]]; then
+    MODULE=$1; shift
+else
+    echo "No module provided!"; exit 1
+fi
+if [[ "$1" ]]; then
+    TASK=$1; shift
+else
+    echo "No task provided!"; exit 1
+fi
+echo LUIGI_CONFIG_PATH=$LUIGI_CONFIG_PATH
+echo PYTHONPATH=$PYTHONPATH
+for i in "$@"; do
+    PARAMS="$PARAMS --${i%=*} ${i#*=}"
+done
+
+cd $WORKFLOWS_DIR
+luigi --local-scheduler --module $MODULE $TASK$PARAMS
+echo "exit: $?"

workflows/foo.cfg

@@ -0,0 +1,2 @@
+[Bar]
+static-param: hello

workflows/foo.py

@@ -0,0 +1,8 @@
+from luigi import Task, Parameter
+
+
+class Bar(Task):
+    static_param = Parameter()
+    dynamic_param = Parameter()
+    def run(self):
+        print(f"\n>>> {self.static_param} {self.dynamic_param}! <<<\n", flush=True)