---
name: stagecoach
description: >
  Add your description here. Use when writing Python code that uses the stagecoach package.
compatibility: Requires Python >=3.12.
---

# stagecoach

Add your description here

## Installation

```bash
pip install stagecoach
```

## API overview

### Classes

Core classes

- `stagecoach.ManifestChecker`
- `stagecoach.StageCoach`
- `manifest_checker.ManifestChecker`

### Dataclasses

Data-holding classes

- `stagecoach.StageResult`
- `manifest_checker.CheckResult`
- `stage.StageResult`
- `checks.CheckResult`
- `customs.Clearance`

### Enumerations

Enum types

- `stagecoach.Severity`
- `manifest_checker.Severity`
- `checks.Severity`
- `ui.Severity`

### Functions

Public functions

- `stagecoach.create_outpost`
- `stagecoach.check_gold_mine_clearance`
- `stagecoach.check_globus_clearance`
- `stagecoach.create_stage_directories`
- `stagecoach.stage_data_from_fasrc`
- `stagecoach.stage_data_from_globus`
- `stagecoach.banner`
- `stagecoach.success`
- `stagecoach.warning`
- `stagecoach.error`
- `stagecoach.info`
- `stagecoach.failure_panel`
- `stagecoach.handbook_note`
- `stagecoach.check_result`
- `manifest_checker.check_project_exists`
- `manifest_checker.check_git_repo_exists`
- `manifest_checker.check_environment_exists`
- `manifest_checker.check_code_exists`
- `manifest_checker.check_narrative_exists`
- `manifest_checker.check_readme_exists`
- `manifest_checker.check_project_structure`
- `issue_manifest.check_citizenship`
- `issue_manifest.load_template`
- `issue_manifest.fill_manifest_interactively`
- `issue_manifest.write_manifest`
- `issue_manifest.info`
- `issue_manifest.success`
- `stage.info`
- `stage.error`
- `stage.success`
- `stage.warning`
- `stage.create_stage_directories`
- `stage.check_globus_clearance`
- `stage.build_globus_transfer`
- `stage.globus_transfer_client`
- `stage.check_gold_mine_clearance`
- `stage.stage_data_from_globus`
- `stage.stage_data_from_fasrc`
- `checks.check_project_exists`
- `checks.check_git_repo_exists`
- `checks.check_environment_exists`
- `checks.check_code_exists`
- `checks.check_narrative_exists`
- `checks.check_readme_exists`
- `checks.check_project_structure`
- `outpost.create_outpost`
- `customs.globus_transfer_client`
- `customs.check_globus_clearance`
- `customs.build_globus_transfer`
- `customs.check_gold_mine_clearance`
- `ui.banner`
- `ui.success`
- `ui.warning`
- `ui.error`
- `ui.info`
- `ui.failure_panel`
- `ui.handbook_note`
- `ui.format_principle`
- `ui.check_result`

### 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`

## Resources

- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs