Release 0.5.5 (#125)

173TECH · Mar 18, 2021 · ed7ede5 · ed7ede5
1 parent 5d319ea
commit ed7ede5
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Change Log
 
-## Next release
+## [0.5.5] - 2021-03-18
 
 ### Changed
 

diff --git a/docs/settings/settings_yaml.md b/docs/settings/settings_yaml.md
@@ -85,17 +85,33 @@ whereas database connections are `Database` objects.
 Local settings can be set without the need of a `settings.yaml` file using environment variables instead.
 With environment variables we don't need to set profiles, only credentials and project parameters are
 defined. SAYN will interpret any environment variable names `SAYN_CREDENTIAL_name` or `SAYN_PARAMETER_name`.
-The values when using environment variables are json encoded.
+The values when using environment variables are either basic types (ie: strings), json or yaml encoded.
 
 Taking the `settings.yaml` example above for the dev profile, in environment variables:
 
 !!! example ".env.sh"
     ```bash
-    export SAYN_CREDENTIAL_warehouse="{'type': 'snowflake', 'account': ..."
+    # JSON encoded credential
+    export SAYN_CREDENTIAL_warehouse='{"type": "snowflake", "account": ...}'
+
+    # YAML encoded credential
+    export SAYN_CREDENTIAL_backend="
+    type: postgresql
+    host: host.address.com
+    user: ...
+    "
+
+    # Project parameters as strings
     export SAYN_PARAMETER_table_prefix="songoku_"
     export SAYN_PARAMETER_schema_logs="analytics_logs"
     export SAYN_PARAMETER_schema_staging="analytics_adhoc"
     export SAYN_PARAMETER_schema_models="analytics_adhoc"
+
+    # Project parameters allow complex types JSON or YAML encoded
+    export SAYN_PARAMETER_dict_param="
+    key1: value1
+    key2: value2
+    "
     ```
 
 When environement variables are defined and a `settings.yaml` file exists, the settings from both will

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sayn"
-version = "0.5.4"
+version = "0.5.5"
 description = "Data-modelling and processing framework for automating Python and SQL tasks"
 authors = ["Robin Watteaux <[email protected]>", "Adrian Macias <[email protected]>"]
 license = "Apache-2.0"

diff --git a/sayn/__init__.py b/sayn/__init__.py
@@ -1,3 +1,3 @@
-__version__ = "0.5.4"
+__version__ = "0.5.5"
 
 from .tasks import PythonTask