Skip to content

Kelp

kelp

Top-level kelp package exports.

Expose a small ergonomic surface so callers can do:

import kelp
kelp.init(...)

We re-export a thin public API from :mod:kelp.api which delegates to internal runtime implementations.

get_context 

get_context(init=True)

Get kelp runtime context with auto-init by default.

Parameters:

Name Type Description Default
init bool

If True (default), auto-initialize from current directory when context doesn't exist yet.

 True

Returns:

Type Description

MetaRuntimeContext for kelp.

Raises:

Type Description
RuntimeError

If context doesn't exist and init=False.
Source code in src/kelp/config/config.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def get_context(init: bool = True):
    """Get kelp runtime context with auto-init by default.

    Args:
        init: If True (default), auto-initialize from current directory
            when context doesn't exist yet.

    Returns:
        MetaRuntimeContext for kelp.

    Raises:
        RuntimeError: If context doesn't exist and init=False.
    """
    return KelpFramework.get_context(init=init)

init 

init(
    project_file_path=None,
    target=None,
    init_vars=None,
    manifest_file_path=None,
    refresh=False,
    store_in_global=True,
    run_policy_checks=False,
    log_level=None,
)

Initialize kelp runtime context from current directory.

When manifest_file_path is provided (or resolved from KELP_MANIFEST_FILE environment variable), the context is loaded directly from a pre-built manifest JSON file, skipping all project discovery, Jinja rendering, and metadata loading.

When policy_config.enabled is True in the project settings, metadata governance policies are evaluated immediately after loading. Warn-severity violations are logged; error-severity violations raise a RuntimeError.

Parameters:

Name Type Description Default
project_file_path str | None

Path to project file or directory.

 None
target str | None

Target environment name.

 None
init_vars dict[str, Any] | None

Runtime variable overrides.

 None
manifest_file_path str | None

Path to a manifest JSON file. When provided, skips source file loading. Also resolved from KELP_MANIFEST_FILE env var.

 None
refresh bool

If True, recreate context even if one already exists.

 False
store_in_global bool

Whether to store context globally.

 True
run_policy_checks bool

Whether to run policy checks.

 False
log_level str | None

Optional log level to configure.

 None

Returns:

Type Description
MetaRuntimeContext

The initialized MetaRuntimeContext.
Source code in src/kelp/config/config.py 
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def init(
    project_file_path: str | None = None,
    target: str | None = None,
    init_vars: dict[str, Any] | None = None,
    manifest_file_path: str | None = None,
    refresh: bool = False,
    store_in_global: bool = True,
    run_policy_checks: bool = False,
    log_level: str | None = None,
) -> MetaRuntimeContext:
    """Initialize kelp runtime context from current directory.

    When ``manifest_file_path`` is provided (or resolved from ``KELP_MANIFEST_FILE``
    environment variable), the context is loaded directly from a pre-built
    manifest JSON file, skipping all project discovery, Jinja rendering, and
    metadata loading.

    When ``policy_config.enabled`` is True in the project settings, metadata
    governance policies are evaluated immediately after loading. Warn-severity
    violations are logged; error-severity violations raise a RuntimeError.

    Args:
        project_file_path: Path to project file or directory.
        target: Target environment name.
        init_vars: Runtime variable overrides.
        manifest_file_path: Path to a manifest JSON file. When provided, skips
            source file loading. Also resolved from KELP_MANIFEST_FILE env var.
        refresh: If True, recreate context even if one already exists.
        store_in_global: Whether to store context globally.
        run_policy_checks: Whether to run policy checks.
        log_level: Optional log level to configure.

    Returns:
        The initialized MetaRuntimeContext.
    """
    if log_level:
        configure_logging(log_level)

    ctx = KelpFramework.init(
        project_file_path=project_file_path,
        target=target,
        init_vars=init_vars,
        manifest_file_path=manifest_file_path,
        refresh=refresh,
        store_in_global=store_in_global,
    )

    _run_policy_checks(ctx, run_policy_checks)

    return ctx