From 4b23354d446ca493c949d258cda3b6a62c02ccf9 Mon Sep 17 00:00:00 2001 From: Pablo Martin Date: Wed, 18 Jan 2023 17:20:54 +0100 Subject: [PATCH] Improved the quickstart a bit --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6785aa8..e7b7994 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,7 @@ You can find below examples of how to leverage `lolafect` in your flows. ```python from lolafect.lolaconfig import build_lolaconfig -lolaconfig = build_lolaconfig( - flow_name="some-flow", - env_s3_bucket="bucket", - kubernetes_labels=["some_label"], - kubernetes_image="the-image:latest", -) +lolaconfig = build_lolaconfig(flow_name="some-flow") # Now you can access all the env stuff from here lolaconfig.FLOW_NAME @@ -30,6 +25,15 @@ lolaconfig.TRINO_CREDENTIALS lolaconfig.SSH_TUNNEL_CREDENTIALS lolaconfig.PREFECT_HOST # etc + +# Your flow is different from the typical one? +# You can customize the behaviour of LolaConfig +lolaconfig = build_lolaconfig( + flow_name="some-flow", + env_s3_bucket="my-odd-bucket", + kubernetes_labels=["some-unusual-label"], + kubernetes_image="the-image:not-the-production-one", +) ``` **Send a warning message to slack if your tasks fails**