Kedro integration
vizro.integrations.kedro
Functions to use the Kedro Data Catalog inside Vizro.
Usage documentation
catalog_from_project
Fetches a Kedro project's Data Catalog.
Parameters:
-
project_path(, default:str |Path | NoneNone) –Path to the Kedro project root directory. If not specified then attempts to find a Kedro project in the current directory or above.
Other Parameters:
-
**kwargs() –Any Keyword arguments to pass to
KedroSession.create, for exampleenv.
Returns:
-
–DataCatalog Kedro Data Catalog.
datasets_from_catalog
Fetches a Kedro Data Catalog's pandas dataset loading functions to use in the Vizro data manager.
Parameters:
-
catalog() –DataCatalog Kedro Data Catalog.
-
pipeline(, default:Pipeline None) –Optional Kedro pipeline. If specified, the factory-based Kedro datasets it defines are also returned.
Returns:
-
–dict [str ,pd_DataFrameCallable ]Mapping of dataset names to dataset loading functions that can be used in the Vizro data manager.
pipelines_from_project
Fetches a Kedro project's pipelines.
Parameters:
-
project_path(, default:str |Path | NoneNone) –Path to the Kedro project root directory. If not specified then attempts to find a Kedro project in the current directory or above.
Returns:
-
–dict [str ,Pipeline ]Mapping of pipeline names to pipelines.