Startup

kedro.framework.startup

This module provides metadata for a Kedro project.

Name	Type	Description
bootstrap_project	Function	Run setup required at the beginning of the workflow when running in project mode, and return project metadata.
ProjectMetadata	Class	Structure holding project metadata derived from pyproject.toml.

kedro.framework.startup.bootstrap_project

bootstrap_project(project_path)

Run setup required at the beginning of the workflow when running in project mode, and return project metadata.

Source code in kedro/framework/startup.py

def bootstrap_project(project_path: str | Path) -> ProjectMetadata:
    """Run setup required at the beginning of the workflow
    when running in project mode, and return project metadata.
    """

    project_path = Path(project_path).expanduser().resolve()
    metadata = _get_project_metadata(project_path)
    _add_src_to_path(metadata.source_dir, project_path)
    configure_project(metadata.package_name)
    return metadata

kedro.framework.startup.ProjectMetadata

Bases: NamedTuple

Structure holding project metadata derived from pyproject.toml

config_file instance-attribute

config_file

example_pipeline instance-attribute

example_pipeline

kedro_init_version instance-attribute

kedro_init_version

package_name instance-attribute

package_name

project_name instance-attribute

project_name

project_path instance-attribute

project_path

source_dir instance-attribute

source_dir

tools instance-attribute

tools