Skip to content

cayu.build_provenance

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

from cayu import current_runtime_build_provenance

Resolve and cache one immutable build identity for this process.

current_runtime_build_provenance() -> RuntimeBuildProvenance

Release source · Runtime guarantees · Capability guides

from cayu import RUNTIME_BUILD_PROVENANCE_ENV
RUNTIME_BUILD_PROVENANCE_ENV = 'CAYU_RUNTIME_BUILD_PROVENANCE'

Release source · Runtime guarantees · Capability guides

from cayu import RUNTIME_BUILD_PROVENANCE_RECIPE
RUNTIME_BUILD_PROVENANCE_RECIPE = 'cayu.runtime-build-provenance.v1'

Release source · Runtime guarantees · Capability guides

from cayu import RUNTIME_BUILD_PROVENANCE_SCHEMA_VERSION
RUNTIME_BUILD_PROVENANCE_SCHEMA_VERSION = 1

Release source · Runtime guarantees · Capability guides

from cayu import RUNTIME_BUILD_PROVENANCE_STRICT_ENV
RUNTIME_BUILD_PROVENANCE_STRICT_ENV = 'CAYU_REQUIRE_STRONG_RUNTIME_BUILD_PROVENANCE'

Release source · Runtime guarantees · Capability guides

from cayu import RuntimeBuildArtifactKind

Digest domain whose bytes or manifest identify the build.

Bases: StrEnum.

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
WHEEL class attribute 'wheel'
OCI_IMAGE class attribute 'oci_image'
SOURCE_TREE class attribute 'source_tree'
OTHER class attribute 'other'

Release source · Runtime guarantees · Capability guides

from cayu import RuntimeBuildProvenance

Versioned, bounded identity for the exact Cayu runtime build.

Bases: BaseModel.

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
schema_version Literal[1] RUNTIME_BUILD_PROVENANCE_SCHEMA_VERSION
recipe Literal['cayu.runtime-build-provenance.v1'] RUNTIME_BUILD_PROVENANCE_RECIPE
origin RuntimeBuildProvenanceOrigin required
availability RuntimeBuildProvenanceAvailability required
strength RuntimeBuildProvenanceStrength required
fingerprint str | None None
artifact_kind RuntimeBuildArtifactKind | None None
artifact_digest str | None None
source_revision str | None None
detail_code str | None None
RuntimeBuildProvenance.validate_optional_sha256(value: str | None, info) -> str | None
RuntimeBuildProvenance.validate_source_revision(value: str | None) -> str | None
RuntimeBuildProvenance.validate_detail_code(value: str | None) -> str | None
RuntimeBuildProvenance.validate_state() -> RuntimeBuildProvenance
RuntimeBuildProvenance.unavailable(detail_code: str, *, legacy: bool=False) -> RuntimeBuildProvenance

Return explicit unavailable or legacy provenance.

RuntimeBuildProvenance.from_artifact_digest(*, origin: RuntimeBuildProvenanceOrigin, artifact_kind: RuntimeBuildArtifactKind, artifact_digest: str, source_revision: str | None=None, strength: RuntimeBuildProvenanceStrength=RuntimeBuildProvenanceStrength.STRUCTURAL) -> RuntimeBuildProvenance

Derive a domain-separated runtime fingerprint from build evidence.

Release source · Runtime guarantees · Capability guides

from cayu import RuntimeBuildProvenanceAvailability

Whether exact build identity is available for admission.

Bases: StrEnum.

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
AVAILABLE class attribute 'available'
UNAVAILABLE class attribute 'unavailable'

Release source · Runtime guarantees · Capability guides

from cayu import RuntimeBuildProvenanceOrigin

Boundary that supplied one runtime build identity.

Bases: StrEnum.

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
WHEEL_RECORD class attribute 'wheel_record'
OCI_IMAGE_DIGEST class attribute 'oci_image_digest'
DEVELOPMENT_SOURCE_TREE class attribute 'development_source_tree'
EXPLICIT_MANIFEST class attribute 'explicit_manifest'
LEGACY_RECORD class attribute 'legacy_record'
UNAVAILABLE class attribute 'unavailable'

Release source · Runtime guarantees · Capability guides

from cayu import RuntimeBuildProvenanceStrength

Execution-profile strength vocabulary for runtime build identity.

Bases: StrEnum.

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
STRUCTURAL class attribute 'structural'
APPLICATION_VERSIONED class attribute 'application_versioned'
UNAVAILABLE class attribute 'unavailable'

Release source · Runtime guarantees · Capability guides