Function copy_demo_notebooks

sdk/python/feast/demos.py:765–851

Generate tailored demo notebooks for each Feast project found nearby. The function searches *repo_path* (default: current working directory) for feature-store YAML files in: * `` /feature_store.yaml`` * Every file inside `` /feast-config/`` For each project

(
    output_dir: str = "./feast-demo-notebooks",
    repo_path: str = ".",
    overwrite: bool = False,
)

def copy_demo_notebooks(
    output_dir: str = "./feast-demo-notebooks",
    repo_path: str = ".",
    overwrite: bool = False,
) -> None:
    """Generate tailored demo notebooks for each Feast project found nearby.

    The function searches *repo_path* (default: current working directory) for
    feature-store YAML files in:

    * ``<repo_path>/feature_store.yaml``
    * Every file inside ``<repo_path>/feast-config/``

    For each project discovered a sub-directory is created under *output_dir*
    and one or more notebooks are written (the exact set depends on the project
    configuration and may grow in future releases).

    Parameters
    ----------
    output_dir:
        Root directory where notebooks are written.
        Defaults to ``./feast-demo-notebooks``.
    repo_path:
        Directory to search for ``feature_store.yaml`` files.
        Defaults to the current working directory.
    overwrite:
        When *False* (default) raise :class:`FileExistsError` if *output_dir*
        already exists.  Set to *True* to update notebooks in place.
    """
    out = pathlib.Path(output_dir).resolve()

    if not overwrite and out.exists():
        raise FileExistsError(
            f"Directory '{out}' already exists. "
            "Remove it or pass overwrite=True to update notebooks in place."
        )

    root = pathlib.Path(repo_path).absolute()
    yaml_paths = _find_feature_store_yamls(root)

    if not yaml_paths:
        _logger.warning(
            "No feature_store.yaml found under '%s'. "
            "Make sure you run this from a directory that contains feature_store.yaml "
            "or a feast-config/ subdirectory.",
            root,
        )
        return

    out.mkdir(parents=True, exist_ok=True)
    print(f"Writing demo notebooks to: {out}\n")

    for yaml_path in yaml_paths:
        raw = _parse_yaml(yaml_path)
        info = _extract_store_info(raw)
        project = info["project"]

        project_dir = out / project