barrage-checker
Checker and validator for the Barrage language.
Barrage is a plain-language format that makes any code readable by anyone (including people who do not program).
This package checks whether a document follows the official Barrage structure.
Install
pip install barrage-checker
(Once published to PyPI)
Or install directly from GitHub:
pip install git+https://github.com/fitzyracing1/barrage-checker.git
Usage
barrage-check path/to/file.barrage
or
python -m barrage_checker path/to/file.barrage
Example output
Valid document:
✓ reset-and-count.barrage is a valid Barrage document
Invalid document:
✗ myfile.barrage has problems:
- Missing required section matching: ^## Purpose
- No code fence found — original code must be present
What it checks
The tool verifies that a Barrage document contains all required sections defined in the official specification:
- Title
- One-sentence summary
- Purpose
- How it works (plain English)
- Key ideas
- The actual code
- Line-by-line translation
- Decisions the program makes
- What a person would notice
- Current status
- Next possible steps
Related
- Barrage language repository: https://github.com/fitzyracing1/barrage
- Official specification: https://github.com/fitzyracing1/barrage/blob/main/SPEC.md
License
MIT
1 maintainer
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 barrage_checker-1.0.0.tar.gz.
File metadata
- Download URL: barrage_checker-1.0.0.tar.gz
- Upload date:
- Size: 3.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0cda2a2b64e788cbce0556e2e5eacf5d0f14876d91f3f887dfefffad03d6c6dc
|
|
| MD5 |
5bab5f960045929b1c4262c2765878ce
|
|
| BLAKE2b-256 |
b83daf592841e270088677df8bb3d7d1ac3f8f123552b474062a634f0b4061a4
|
File details
Details for the file barrage_checker-1.0.0-py3-none-any.whl.
File metadata
- Download URL: barrage_checker-1.0.0-py3-none-any.whl
- Upload date:
- Size: 4.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b7699afce72335e1b68cf469691a40da7880ffe9305667b0ffedb5c92d5484a4
|
|
| MD5 |
ec108a6d6a725ed52990a719ffd29873
|
|
| BLAKE2b-256 |
f5b59fecd9faa5311f260d28e45748f4686778ceb40f0c8564cdff35c15d28c2
|
