Metadata-Version: 2.4
Name: hirschauers-protocol-registry-wizard
Version: 0.1.0
Summary: Textual TUI for designing protocol registry entries with hard guardrails
Project-URL: Homepage, https://github.com/stratagemresearch/protocol-registry-wizard
Project-URL: Repository, https://github.com/stratagemresearch/protocol-registry-wizard
Project-URL: Issues, https://github.com/stratagemresearch/protocol-registry-wizard/issues
Author-email: "C. Hirschauer" <ch@stratagemresearch.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: textual>=0.40.0
Description-Content-Type: text/markdown

# Protocol Registry Wizard

A Textual TUI for designing protocol registry entries with hard guardrails.

## Features

- Capture protocol identity, deployment identity, ABI sources, and subgraph wiring
- Enforce one ABI per one address for live protocol drafts
- Refuse to generate a live draft when address-local ABI coverage is incomplete
- Emit explicit validation logs and a markdown onboarding draft
- Keep metadata-only and live-protocol paths separate

## Installation

```bash
pip install protocol-registry-wizard
```

## Usage

```bash
protocol-wizard
```

Or run as a module:

```bash
python -m protocol_registry
```

### Key Bindings

| Binding | Action |
|---------|--------|
| `Ctrl+Q` | Quit |
| `Ctrl+R` | Refresh preview |
| `Ctrl+G` | Generate draft (JSON + markdown) |
| `Ctrl+S` | Scaffold (stub + env snippet + test + promotion patch) |

## Output

- **Drafts**: Written to `docs/protocol_registry_drafts/`
- **Scaffolded code**: Written to `docs/protocol_registry_drafts/generated/`

## Docker

```bash
docker build -t protocol-wizard .
docker run -it -v $(pwd)/output:/app/output protocol-wizard
```

## Development

```bash
git clone https://github.com/stratagemresearch/protocol-registry-wizard.git
cd protocol-registry-wizard
uv venv && uv pip install -e .
```

## License

MIT
