Reference

Classes

Core classes

stagecoach.ManifestChecker: Run the standard Stagecoach manifest checks for a project.
stagecoach.StageCoach: Orchestrate manifest issuance, inspection, and data staging.
manifest_checker.ManifestChecker: Run the standard Stagecoach manifest checks for a project.

Dataclasses

Data-holding classes

stagecoach.StageResult: Summarize the result of a staging operation.
manifest_checker.CheckResult: Represent the outcome of a single manifest check.
stage.StageResult: Summarize the result of a staging operation.
checks.CheckResult: Represent the outcome of a single manifest check.
customs.Clearance: Represent the outcome of a source access check.

Enumerations

Enum types

stagecoach.Severity: Severity levels for manifest validation results.
manifest_checker.Severity: Severity levels for manifest validation results.
checks.Severity: Severity levels for manifest validation results.
ui.Severity: Severity levels for manifest validation results.

Functions

Public functions

stagecoach.create_outpost(): Create a temporary mock Frontier file and point THE_FRONTIER at it.
stagecoach.check_gold_mine_clearance(): Validate readability of requested Gold Mine paths on FASRC.
stagecoach.check_globus_clearance(): Validate access to Globus endpoints and requested source paths.
stagecoach.create_stage_directories(): Create the standard Stagecoach data directories.
stagecoach.stage_data_from_fasrc(): Stage Gold Mine data by creating symlinks on FASRC.
stagecoach.stage_data_from_globus(): Submit a Globus transfer for manifest-declared items.
stagecoach.banner(): Render a highlighted banner message.
stagecoach.success(): Render a success message.
stagecoach.warning(): Render a warning message.
stagecoach.error(): Render an error message.
stagecoach.info(): Render an informational message.
stagecoach.failure_panel(): Render an error message inside a bordered panel.
stagecoach.handbook_note(): Print a link to the Frontier handbook principles.
stagecoach.check_result(): Render a manifest check result using severity-specific styling.
manifest_checker.check_project_exists(): Verify that the project directory exists.
manifest_checker.check_git_repo_exists(): Verify that the project directory is under Git version control.
manifest_checker.check_environment_exists(): Look for a project environment specification or lockfile.
manifest_checker.check_code_exists(): Check whether the project contains analysis or source code files.
manifest_checker.check_narrative_exists(): Check whether the project contains narrated analysis notebooks.
manifest_checker.check_readme_exists(): Check whether the project contains a top-level README document.
manifest_checker.check_project_structure()
issue_manifest.check_citizenship(): Validate Frontier citizenship through the sheriff.
issue_manifest.load_template(): Load the packaged Stagecoach manifest template.
issue_manifest.fill_manifest_interactively(): Prompt the user for manifest values at the command line.
issue_manifest.write_manifest(): Write a manifest to disk as YAML.
issue_manifest.info(): Render an informational message.
issue_manifest.success(): Render a success message.
stage.info(): Render an informational message.
stage.error(): Render an error message.
stage.success(): Render a success message.
stage.warning(): Render a warning message.
stage.create_stage_directories(): Create the standard Stagecoach data directories.
stage.check_globus_clearance(): Validate access to Globus endpoints and requested source paths.
stage.build_globus_transfer(): Build a Globus transfer request from manifest settings.
stage.globus_transfer_client(): Yield an authenticated Globus transfer client.
stage.check_gold_mine_clearance(): Validate readability of requested Gold Mine paths on FASRC.
stage.stage_data_from_globus(): Submit a Globus transfer for manifest-declared items.
stage.stage_data_from_fasrc(): Stage Gold Mine data by creating symlinks on FASRC.
checks.check_project_exists(): Verify that the project directory exists.
checks.check_git_repo_exists(): Verify that the project directory is under Git version control.
checks.check_environment_exists(): Look for a project environment specification or lockfile.
checks.check_code_exists(): Check whether the project contains analysis or source code files.
checks.check_narrative_exists(): Check whether the project contains narrated analysis notebooks.
checks.check_readme_exists(): Check whether the project contains a top-level README document.
checks.check_project_structure()
outpost.create_outpost(): Create a temporary mock Frontier file and point THE_FRONTIER at it.
customs.globus_transfer_client(): Yield an authenticated Globus transfer client.
customs.check_globus_clearance(): Validate access to Globus endpoints and requested source paths.
customs.build_globus_transfer(): Build a Globus transfer request from manifest settings.
customs.check_gold_mine_clearance(): Validate readability of requested Gold Mine paths on FASRC.
ui.banner(): Render a highlighted banner message.
ui.success(): Render a success message.
ui.warning(): Render a warning message.
ui.error(): Render an error message.
ui.info(): Render an informational message.
ui.failure_panel(): Render an error message inside a bordered panel.
ui.handbook_note(): Print a link to the Frontier handbook principles.
ui.format_principle(): Format one or more principle identifiers for display.
ui.check_result(): Render a manifest check result using severity-specific styling.

Constants

Module-level constants and data

manifest_checker.SEVERITY_RANK
manifest_checker.PRINCIPLES
manifest_checker.ex_check
checks.SEVERITY_RANK
checks.PRINCIPLES
checks.ex_check
ui.HANDBOOK_URL

Other

Additional exports

validate_manifest