cayu.delivery.git

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.

`approve_remote_git_delivery`

from cayu.delivery import approve_remote_git_delivery

Create exact application-owned approval for commit and push effects.

approve_remote_git_delivery(request: RemoteGitDeliveryRequest, prepared: RemoteGitPreparedIntent, *, approval_id: str) -> RemoteGitDeliveryApproval

Release source · Runtime guarantees · Capability guides

`remote_git_broker_behavior_fingerprint`

from cayu.delivery import remote_git_broker_behavior_fingerprint

Return the package behavior identity bound by delivery requests.

remote_git_broker_behavior_fingerprint() -> str

Release source · Runtime guarantees · Capability guides

`remote_git_delivery_request`

from cayu.delivery import remote_git_delivery_request

Bind one immutable delivery request to an accepted patch-ready result.

remote_git_delivery_request(publication: CodingProductPublication, *, delivery_id: str, session_id: str, idempotency_key: str, repository: RemoteGitRepositoryAuthority, commit: RemoteGitCommitAuthority, security: RemoteGitSecurityAuthority, limits: RemoteGitDeliveryLimits | None=None) -> RemoteGitDeliveryRequest

Release source · Runtime guarantees · Capability guides

`REMOTE_GIT_DELIVERY_RESULT_KIND`

from cayu.delivery import REMOTE_GIT_DELIVERY_RESULT_KIND

REMOTE_GIT_DELIVERY_RESULT_KIND = 'remote_git_delivery_result'

Release source · Runtime guarantees · Capability guides

`REMOTE_GIT_DELIVERY_SCHEMA_VERSION`

from cayu.delivery import REMOTE_GIT_DELIVERY_SCHEMA_VERSION

REMOTE_GIT_DELIVERY_SCHEMA_VERSION = 'cayu.remote_git_delivery.v1'

Release source · Runtime guarantees · Capability guides

`RemoteGitBrokerProfile`

from cayu.delivery import RemoteGitBrokerProfile

Decorators: @dataclass(frozen=True).

Fields and attributes

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
`broker_id`	`str`	`required`
`repository_id`	`str`	`required`
`broker_repository_id`	`str`	`required`
`root`	`Path`	`required`
`git_executable`	`str`	`required`
`behavior_fingerprint`	`str`	`required`
`remotes`	`Mapping[str, RemoteGitRemoteConfig]`	`required`
`destination_prefix`	`str`	`'refs/heads/cayu/'`

Release source · Runtime guarantees · Capability guides

`RemoteGitCommitAuthority`

from cayu.delivery import RemoteGitCommitAuthority

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`author_name`	`str`	`required`
`author_email`	`str`	`required`
`committer_name`	`str`	`required`
`committer_email`	`str`	`required`
`authored_at`	`str`	`required`
`title`	`str`	`required`
`body`	`str`	`''`

validate_name (method)

RemoteGitCommitAuthority.validate_name(value: str, info) -> str

validate_email (method)

RemoteGitCommitAuthority.validate_email(value: str, info) -> str

validate_title (method)

RemoteGitCommitAuthority.validate_title(value: str) -> str

validate_body (method)

RemoteGitCommitAuthority.validate_body(value: str) -> str

validate_authored_at (method)

RemoteGitCommitAuthority.validate_authored_at(value: str) -> str

message (property)

RemoteGitCommitAuthority.message() -> str

message_sha256 (property)

RemoteGitCommitAuthority.message_sha256() -> str

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryAdmissionError`

from cayu.delivery import RemoteGitDeliveryAdmissionError

Delivery authority or its patch-ready source failed admission.

Bases: RemoteGitDeliveryError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryApproval`

from cayu.delivery import RemoteGitDeliveryApproval

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`approval_id`	`str`	`required`
`request_fingerprint`	`str`	`required`
`prepared_tree`	`str`	`required`
`policy_fingerprint`	`str`	`required`
`commit_approved`	`StrictBool`	`required`
`push_approved`	`StrictBool`	`required`

validate_identity (method)

RemoteGitDeliveryApproval.validate_identity(value: str) -> str

validate_fingerprint (method)

RemoteGitDeliveryApproval.validate_fingerprint(value: str, info) -> str

validate_tree (method)

RemoteGitDeliveryApproval.validate_tree(value: str) -> str

fingerprint (property)

RemoteGitDeliveryApproval.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryBroker`

from cayu.delivery import RemoteGitDeliveryBroker

Prepare, approve, commit, push, and reconcile one bounded Git delivery.

init (method)

RemoteGitDeliveryBroker.__init__(profile: RemoteGitBrokerProfile, *, repository: RemoteGitDeliveryRepository, coding_repository: CodingProductArtifactRepository) -> None

prepare (method)

async RemoteGitDeliveryBroker.prepare(request: RemoteGitDeliveryRequest, publication: CodingProductPublication, *, source_workspace: Workspace) -> RemoteGitPreparedIntent

Materialize and verify an exact tree without creating a commit or push.

run (method)

async RemoteGitDeliveryBroker.run(request: RemoteGitDeliveryRequest, publication: CodingProductPublication, *, source_workspace: Workspace, approval: RemoteGitDeliveryApproval | None=None) -> RemoteGitDeliveryPublication

Settle an approved exact commit/ref or return a truthful non-success state.

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryConflictError`

from cayu.delivery import RemoteGitDeliveryConflictError

The observed remote state conflicts with immutable delivery intent.

Bases: RemoteGitDeliveryAdmissionError.

init (method)

RemoteGitDeliveryConflictError.__init__(reason_code: str, *, observed_base: str | None, observed_destination: str | None) -> None

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryError`

from cayu.delivery import RemoteGitDeliveryError

Base error for the optional remote Git delivery product.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryLimits`

from cayu.delivery import RemoteGitDeliveryLimits

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`timeout_seconds`	`StrictInt`	`Field(default=120, ge=1, le=1800)`
`output_limit_bytes`	`StrictInt`	`Field(default=64 * 1024, ge=1024, le=1024 * 1024)`
`max_paths`	`StrictInt`	`Field(default=20000, ge=1, le=100000)`
`max_path_bytes`	`StrictInt`	`Field(default=4096, ge=1, le=16384)`
`max_file_bytes`	`StrictInt`	`Field(default=16 * 1024 * 1024, ge=1, le=64 * 1024 * 1024)`
`max_total_file_bytes`	`StrictInt`	`Field(default=512 * 1024 * 1024, ge=1, le=1024 * 1024 * 1024)`
`max_manifest_bytes`	`StrictInt`	`Field(default=4 * 1024 * 1024, ge=1024, le=16 * 1024 * 1024)`
`max_git_objects`	`StrictInt`	`Field(default=100000, ge=1, le=1000000)`
`max_git_storage_bytes`	`StrictInt`	`Field(default=1024 * 1024 * 1024, ge=1024, le=2 * 1024 * 1024 * 1024)`
`retry_limit`	`StrictInt`	`Field(default=1, ge=0, le=1)`

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryPublication`

from cayu.delivery import RemoteGitDeliveryPublication

Decorators: @dataclass(frozen=True).

Fields and attributes

Name	Type	Default
`result`	`RemoteGitDeliveryResult`	`required`
`artifact`	`CodingArtifactReference`	`required`

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryReconstructionRequiredError`

from cayu.delivery import RemoteGitDeliveryReconstructionRequiredError

Durable evidence must be reconciled before delivery can continue.

Bases: RemoteGitDeliveryError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryRepository`

from cayu.delivery import RemoteGitDeliveryRepository

Append-only delivery authority, lifecycle, and result storage.

init (method)

RemoteGitDeliveryRepository.__init__(store: ArtifactStore) -> None

request_artifact_id (method)

RemoteGitDeliveryRepository.request_artifact_id(delivery_id: str) -> str

prepared_artifact_id (method)

RemoteGitDeliveryRepository.prepared_artifact_id(delivery_id: str) -> str

approval_artifact_id (method)

RemoteGitDeliveryRepository.approval_artifact_id(delivery_id: str) -> str

lifecycle_artifact_id (method)

RemoteGitDeliveryRepository.lifecycle_artifact_id(delivery_id: str, ordinal: int) -> str

ensure_request (method)

async RemoteGitDeliveryRepository.ensure_request(request: RemoteGitDeliveryRequest) -> CodingArtifactReference

ensure_prepared (method)

async RemoteGitDeliveryRepository.ensure_prepared(request: RemoteGitDeliveryRequest, prepared: RemoteGitPreparedIntent) -> CodingArtifactReference

ensure_approval (method)

async RemoteGitDeliveryRepository.ensure_approval(request: RemoteGitDeliveryRequest, approval: RemoteGitDeliveryApproval) -> CodingArtifactReference

append_lifecycle (method)

async RemoteGitDeliveryRepository.append_lifecycle(request: RemoteGitDeliveryRequest, receipt: RemoteGitLifecycleReceipt) -> CodingArtifactReference

load_prepared (method)

async RemoteGitDeliveryRepository.load_prepared(request: RemoteGitDeliveryRequest) -> RemoteGitPreparedIntent | None

load_lifecycle (method)

async RemoteGitDeliveryRepository.load_lifecycle(request: RemoteGitDeliveryRequest) -> tuple[RemoteGitLifecycleReceipt, ...]

publish_result (method)

async RemoteGitDeliveryRepository.publish_result(request: RemoteGitDeliveryRequest, result: RemoteGitDeliveryResult) -> RemoteGitDeliveryPublication

load_result (method)

async RemoteGitDeliveryRepository.load_result(request: RemoteGitDeliveryRequest, digest: str) -> RemoteGitDeliveryPublication

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryRequest`

from cayu.delivery import RemoteGitDeliveryRequest

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal['cayu.remote_git_delivery.v1']`	`REMOTE_GIT_DELIVERY_SCHEMA_VERSION`
`delivery_id`	`str`	`required`
`session_id`	`str`	`required`
`idempotency_key`	`str`	`required`
`source`	`RemoteGitSourceAuthority`	`required`
`repository`	`RemoteGitRepositoryAuthority`	`required`
`commit`	`RemoteGitCommitAuthority`	`required`
`security`	`RemoteGitSecurityAuthority`	`required`
`limits`	`RemoteGitDeliveryLimits`	`Field(default_factory=RemoteGitDeliveryLimits)`
`force_update`	`Literal[False]`	`False`
`delete_ref`	`Literal[False]`	`False`

validate_identity (method)

RemoteGitDeliveryRequest.validate_identity(value: str, info) -> str

fingerprint (property)

RemoteGitDeliveryRequest.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryResult`

from cayu.delivery import RemoteGitDeliveryResult

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal['cayu.remote_git_delivery_result.v1']`	`'cayu.remote_git_delivery_result.v1'`
`delivery_id`	`str`	`required`
`session_id`	`str`	`required`
`request_fingerprint`	`str`	`required`
`state`	`RemoteGitDeliveryState`	`required`
`product_result_artifact_id`	`str`	`required`
`product_result_sha256`	`str`	`required`
`product_run_id`	`str`	`required`
`source_workspace_id`	`str`	`required`
`final_source_revision`	`str`	`required`
`diff_artifact_id`	`str`	`required`
`diff_sha256`	`str`	`required`
`check_evidence_sha256`	`str`	`required`
`repository_id`	`str`	`required`
`broker_repository_id`	`str`	`required`
`remote_identity`	`str`	`required`
`base_ref`	`str`	`required`
`expected_base_commit`	`str`	`required`
`expected_destination_commit`	`str \| None`	`None`
`observed_base_commit`	`str \| None`	`None`
`destination_ref`	`str`	`required`
`destination_before`	`str \| None`	`None`
`destination_after`	`str \| None`	`None`
`local_commit`	`str \| None`	`None`
`parent_commit`	`str \| None`	`None`
`tree`	`str \| None`	`None`
`commit_message_sha256`	`str`	`required`
`policy_fingerprint`	`str`	`required`
`approval_policy_fingerprint`	`str`	`required`
`redaction_profile_fingerprint`	`str`	`required`
`approval_id`	`str \| None`	`None`
`approval_fingerprint`	`str \| None`	`None`
`credential_profile_id`	`str`	`required`
`egress_profile_id`	`str`	`required`
`broker_behavior_fingerprint`	`str`	`required`
`limits`	`RemoteGitDeliveryLimits`	`required`
`steps`	`tuple[RemoteGitStepEvidence, ...]`	`()`
`cleanup_settled`	`StrictBool`	`False`
`reason_code`	`str \| None`	`None`
`next_commit`	`str \| None`	`None`
`next_ref`	`str \| None`	`None`

validate_optional_identity (method)

RemoteGitDeliveryResult.validate_optional_identity(value: str | None, info) -> str | None

validate_optional_fingerprint (method)

RemoteGitDeliveryResult.validate_optional_fingerprint(value: str | None, info) -> str | None

validate_optional_ref (method)

RemoteGitDeliveryResult.validate_optional_ref(value: str | None, info) -> str | None

validate_optional_object (method)

RemoteGitDeliveryResult.validate_optional_object(value: str | None, info) -> str | None

validate_pushed_claim (method)

RemoteGitDeliveryResult.validate_pushed_claim() -> RemoteGitDeliveryResult

digest (property)

RemoteGitDeliveryResult.digest() -> str

Release source · Runtime guarantees · Capability guides

`RemoteGitDeliveryState`

from cayu.delivery import RemoteGitDeliveryState

Bases: StrEnum.

Fields and attributes

Name	Type	Default
`PREPARING`	`class attribute`	`'preparing'`
`PREPARED`	`class attribute`	`'prepared'`
`APPROVAL_REQUIRED`	`class attribute`	`'approval_required'`
`COMMITTING`	`class attribute`	`'committing'`
`COMMITTED_LOCALLY`	`class attribute`	`'committed_locally'`
`PUSHING`	`class attribute`	`'pushing'`
`PUSHED`	`class attribute`	`'pushed'`
`CONFLICT`	`class attribute`	`'conflict'`
`DENIED`	`class attribute`	`'denied'`
`FAILED`	`class attribute`	`'failed'`
`CANCELLED`	`class attribute`	`'cancelled'`
`PARTIAL`	`class attribute`	`'partial'`
`AMBIGUOUS`	`class attribute`	`'ambiguous'`
`RECONSTRUCTION_REQUIRED`	`class attribute`	`'reconstruction_required'`

Release source · Runtime guarantees · Capability guides

`RemoteGitHttpCredentials`

from cayu.delivery import RemoteGitHttpCredentials

Vault-backed HTTPS credential refs resolved only by remote Git calls.

Decorators: @dataclass(frozen=True).

Fields and attributes

Name	Type	Default
`credential_profile_id`	`str`	`required`
`username`	`SecretRef`	`required`
`password`	`SecretRef`	`required`
`resolver`	`SecretResolver`	`required`

Release source · Runtime guarantees · Capability guides

`RemoteGitLifecycleReceipt`

from cayu.delivery import RemoteGitLifecycleReceipt

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`delivery_id`	`str`	`required`
`request_fingerprint`	`str`	`required`
`ordinal`	`StrictInt`	`Field(ge=1, le=REMOTE_GIT_MAX_LIFECYCLE_RECEIPTS)`
`state`	`RemoteGitDeliveryState`	`required`
`prior_state`	`RemoteGitDeliveryState \| None`	`None`
`evidence_sha256`	`str \| None`	`None`
`tree`	`str \| None`	`None`
`commit`	`str \| None`	`None`
`reason_code`	`str \| None`	`None`

validate_identity (method)

RemoteGitLifecycleReceipt.validate_identity(value: str | None, info) -> str | None

validate_fingerprint (method)

RemoteGitLifecycleReceipt.validate_fingerprint(value: str | None, info) -> str | None

validate_object (method)

RemoteGitLifecycleReceipt.validate_object(value: str | None, info) -> str | None

validate_transition (method)

RemoteGitLifecycleReceipt.validate_transition() -> RemoteGitLifecycleReceipt

Release source · Runtime guarantees · Capability guides

`RemoteGitPreparedIntent`

from cayu.delivery import RemoteGitPreparedIntent

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`delivery_id`	`str`	`required`
`request_fingerprint`	`str`	`required`
`repository_id`	`str`	`required`
`remote_identity`	`str`	`required`
`observed_base_commit`	`str`	`required`
`observed_destination_commit`	`str \| None`	`None`
`tree`	`str`	`required`
`changed_paths`	`tuple[str, ...]`	`required`
`source_revision`	`str`	`required`
`source_manifest_sha256`	`str`	`required`
`commit_message_sha256`	`str`	`required`
`steps`	`tuple[RemoteGitStepEvidence, ...]`	`required`

validate_identity (method)

RemoteGitPreparedIntent.validate_identity(value: str, info) -> str

validate_fingerprint (method)

RemoteGitPreparedIntent.validate_fingerprint(value: str, info) -> str

validate_object (method)

RemoteGitPreparedIntent.validate_object(value: str | None, info) -> str | None

validate_paths (method)

RemoteGitPreparedIntent.validate_paths(value: tuple[str, ...]) -> tuple[str, ...]

fingerprint (property)

RemoteGitPreparedIntent.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

`RemoteGitRemoteConfig`

from cayu.delivery import RemoteGitRemoteConfig

Decorators: @dataclass(frozen=True).

Fields and attributes

Name	Type	Default
`alias`	`str`	`required`
`remote_identity`	`str`	`required`
`url`	`str`	`required`
`default_branch_ref`	`str`	`required`
`credential_profile_id`	`str`	`'none'`
`egress_profile_id`	`str`	`'application-local'`
`credentials`	`RemoteGitHttpCredentials \| None`	`None`

Release source · Runtime guarantees · Capability guides

`RemoteGitRepositoryAuthority`

from cayu.delivery import RemoteGitRepositoryAuthority

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`repository_id`	`str`	`required`
`broker_repository_id`	`str`	`required`
`remote_alias`	`str`	`required`
`remote_identity`	`str`	`required`
`base_ref`	`str`	`required`
`expected_base_commit`	`str`	`required`
`destination_ref`	`str`	`required`
`expected_destination_commit`	`str \| None`	`None`

validate_identity (method)

RemoteGitRepositoryAuthority.validate_identity(value: str, info) -> str

validate_ref (method)

RemoteGitRepositoryAuthority.validate_ref(value: str, info) -> str

validate_commit (method)

RemoteGitRepositoryAuthority.validate_commit(value: str) -> str

validate_destination_commit (method)

RemoteGitRepositoryAuthority.validate_destination_commit(value: str | None) -> str | None

parent_commit (property)

RemoteGitRepositoryAuthority.parent_commit() -> str

validate_distinct_refs (method)

RemoteGitRepositoryAuthority.validate_distinct_refs() -> RemoteGitRepositoryAuthority

Release source · Runtime guarantees · Capability guides

`RemoteGitSecurityAuthority`

from cayu.delivery import RemoteGitSecurityAuthority

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`broker_behavior_fingerprint`	`str`	`required`
`credential_profile_id`	`str`	`required`
`egress_profile_id`	`str`	`required`
`policy_fingerprint`	`str`	`required`
`approval_policy_fingerprint`	`str`	`required`
`redaction_profile_fingerprint`	`str`	`required`

validate_identity (method)

RemoteGitSecurityAuthority.validate_identity(value: str, info) -> str

validate_fingerprint (method)

RemoteGitSecurityAuthority.validate_fingerprint(value: str, info) -> str

Release source · Runtime guarantees · Capability guides

`RemoteGitSourceAuthority`

from cayu.delivery import RemoteGitSourceAuthority

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`product_result_artifact_id`	`str`	`required`
`product_result_sha256`	`str`	`required`
`product_request_fingerprint`	`str`	`required`
`product_run_id`	`str`	`required`
`source_workspace_id`	`str`	`required`
`final_source_revision`	`str`	`required`
`diff_artifact_id`	`str`	`required`
`diff_sha256`	`str`	`required`
`check_evidence_sha256`	`str`	`required`

validate_identity (method)

RemoteGitSourceAuthority.validate_identity(value: str, info) -> str

validate_fingerprint (method)

RemoteGitSourceAuthority.validate_fingerprint(value: str, info) -> str

Release source · Runtime guarantees · Capability guides

`RemoteGitStepEvidence`

from cayu.delivery import RemoteGitStepEvidence

Bases: _FrozenDeliveryModel.

Fields and attributes

Name	Type	Default
`operation`	`str`	`required`
`argv_sha256`	`str`	`required`
`status`	`Literal['passed', 'nonzero', 'timed_out', 'cancelled', 'failed']`	`required`
`exit_code`	`StrictInt \| None`	`None`
`duration_ms`	`StrictInt`	`Field(ge=0)`
`output_sha256`	`str`	`required`
`output_truncated`	`StrictBool`	`False`

validate_operation (method)

RemoteGitStepEvidence.validate_operation(value: str) -> str

validate_fingerprint (method)

RemoteGitStepEvidence.validate_fingerprint(value: str, info) -> str

Release source · Runtime guarantees · Capability guides