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
Metadata
1 maintainer
Release files for barrage-checker 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| barrage_checker-1.0.0.tar.gz | 3.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| barrage_checker-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.7 kB
Release files / barrage_checker-1.0.0.tar.gz
| Download URL | barrage_checker-1.0.0.tar.gz |
|---|---|
| Size | 3.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0cda2a2b64e788cbce0556e2e5eacf5d0f14876d91f3f887dfefffad03d6c6dc
|
|
BLAKE2b-256 checksum How to use checksums |
b83daf592841e270088677df8bb3d7d1ac3f8f123552b474062a634f0b4061a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
Release files / barrage_checker-1.0.0-py3-none-any.whl
| Download URL | barrage_checker-1.0.0-py3-none-any.whl |
|---|---|
| Size | 4.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b7699afce72335e1b68cf469691a40da7880ffe9305667b0ffedb5c92d5484a4
|
|
BLAKE2b-256 checksum How to use checksums |
f5b59fecd9faa5311f260d28e45748f4686778ceb40f0c8564cdff35c15d28c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
Security for barrage-checker 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
