Document SESSION_STORE_ARGS as optional in starter project settings (#…

…225) * Update SESSION_STORE_ARGS in settings * fix lint * fix ci build * fix lint * support py3.8 * address PR comments * address PR comments * minor tweak
kedro-org · Aug 8, 2024 · 4368583 · 4368583
1 parent c6b9e8b
commit 4368583
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/...pandas-viz/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/settings.py b/...pandas-viz/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/settings.py
@@ -12,13 +12,18 @@
 # Installed plugins for which to disable hook auto-registration.
 # DISABLE_HOOKS_FOR_PLUGINS = ("kedro-viz",)
 
-# Class that manages storing KedroSession data.
 from pathlib import Path  # noqa: E402
 
 from kedro_viz.integrations.kedro.sqlite_store import SQLiteStore  # noqa: E402
 
+# Class that manages storing KedroSession data.
 SESSION_STORE_CLASS = SQLiteStore
-# Keyword arguments to pass to the `SESSION_STORE_CLASS` constructor.
+
+# Setup for Experiment Tracking
+# The SQLite DB required for experiment tracking is stored by default
+# (supported from python >= 3.9 and Kedro-Viz 9.2.0) in the .viz folder
+# of your project. To store it in another directory, provide the keyword argument
+# `SESSION_STORE_ARGS` to pass to the `SESSION_STORE_CLASS` constructor.
 SESSION_STORE_ARGS = {"path": str(Path(__file__).parents[2])}
 
 # Directory that holds configuration.

diff --git a/...yspark-viz/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/settings.py b/...yspark-viz/{{ cookiecutter.repo_name }}/src/{{ cookiecutter.python_package }}/settings.py
@@ -16,9 +16,13 @@
 from kedro_viz.integrations.kedro.sqlite_store import SQLiteStore  # noqa: E402
 
 # Class that manages storing KedroSession data.
-
 SESSION_STORE_CLASS = SQLiteStore
-# Keyword arguments to pass to the `SESSION_STORE_CLASS` constructor.
+
+# Setup for Experiment Tracking
+# The SQLite DB required for experiment tracking is stored by default
+# (supported from python >= 3.9 and Kedro-Viz 9.2.0) in the .viz folder
+# of your project. To store it in another directory, provide the keyword argument
+# `SESSION_STORE_ARGS` to pass to the `SESSION_STORE_CLASS` constructor.
 SESSION_STORE_ARGS = {"path": str(Path(__file__).parents[2])}
 
 # Directory that holds configuration.