stagecoach.StageCoach

Orchestrate manifest issuance, inspection, and data staging.

Usage

stagecoach.StageCoach()

Parameters

sheriff: Sheriff | None = None

Sheriff instance used for identity and policy checks.

manifest_path: str | Path = "stagecoach_manifest.yml"

Path to the manifest used by instance methods.

console: Console | None = None
Rich console used for user-facing output.

Methods

Name Description
hail() Create a manifest for a new Stagecoach workflow.
inspect() Validate a manifest and report any blocking issues.
stage() Stage data declared by the instance manifest.

hail()

Create a manifest for a new Stagecoach workflow.

Usage

hail(
    interactive=True,
    overwrite=False,
    sheriff=None,
    console=None,
    manifest_path=None,
    outpost=False
)
Parameters
interactive: bool = True

Whether to prompt for manifest fields interactively.

overwrite: bool = False

Whether to overwrite an existing manifest file.

sheriff: Sheriff | None = None

Optional sheriff override for this invocation.

console: Console | None = None

Optional console override for this invocation.

manifest_path: str | Path | None = None

Optional manifest destination override.

outpost: bool = False
Whether to create a temporary mock Frontier citizenship scaffold for manifest creation outside the assigned Frontier.
Returns
bool
True when manifest creation completes successfully.

inspect()

Validate a manifest and report any blocking issues.

Usage

inspect(console=None, level=Severity.ERROR)
Parameters
console: Console | None = None

Optional console override for this invocation.

level: Severity = Severity.ERROR
Minimum severity that should cause inspection to fail.
Returns
bool
True when the manifest passes all checks at the requested severity threshold.

stage()

Stage data declared by the instance manifest.

Usage

stage(console=None)
Parameters
console: Console | None = None
Optional console override for this invocation.
Returns
bool
True when every requested source stages successfully.