kedro.framework.context.load_context

kedro.framework.context.load_context(project_path, **kwargs)[source]

Loads the KedroContext object of a Kedro Project. This is the default way to load the KedroContext object for normal workflows such as CLI, Jupyter Notebook, Plugins, etc. It assumes the following project structure under the given project_path:

<project_path>
    |__ <src_dir>
    |__ .kedro.yml
    |__ kedro_cli.py

The name of the <scr_dir> is src by default and configurable in .kedro.yml.

Parameters:
  • project_path (Union[str, Path]) – Path to the Kedro project.
  • kwargs – Optional kwargs for ProjectContext class in run.py.
Return type:

KedroContext

Returns:

Instance of KedroContext class defined in Kedro project.

Raises:

KedroContextError – Either ‘.kedro.yml’ was not found or loaded context has package conflict.