Textual TUI for designing protocol registry entries with hard guardrails
Project description
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
pip install protocol-registry-wizard
Usage
protocol-wizard
Or run as a module:
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
docker build -t protocol-wizard .
docker run -it -v $(pwd)/output:/app/output protocol-wizard
Development
git clone https://github.com/stratagemresearch/protocol-registry-wizard.git
cd protocol-registry-wizard
uv venv && uv pip install -e .
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hirschauers_protocol_registry_wizard-0.1.0.tar.gz.
File metadata
- Download URL: hirschauers_protocol_registry_wizard-0.1.0.tar.gz
- Upload date:
- Size: 12.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28b7cbb7a2a20d9540d26c3bbe1477fdfcf8bf061c60e4221b7bb7a9048317ce
|
|
| MD5 |
a1a1980f7fb992213a561e18a0fae79b
|
|
| BLAKE2b-256 |
1528bd6a5bb347c4eec8fb78ebec84b7aa556ffb75b3d2452ceaa80aae69a6d2
|
File details
Details for the file hirschauers_protocol_registry_wizard-0.1.0-py3-none-any.whl.
File metadata
- Download URL: hirschauers_protocol_registry_wizard-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1dc18b190e84296728920e390baec5aeb5a6177eab951ccd0c16c9439783c45b
|
|
| MD5 |
8a420c0e942fa836e643f43e2412d21f
|
|
| BLAKE2b-256 |
85e8dc100d504582bab758c986ccf38e186d0e024a38d4f8b8bf5f93490cac4c
|