Pre-alpha read-only private review branch packet generator.
Project description
review-branch-packet
review-branch-packet is a pre-alpha package for building private review branch
packets from read-only git state. It packages the repeated Monogate/MachLib
private-review inspection workflow into a small CLI and library surface.
It is not a PR creator, not a merge tool, not a deploy tool, not a package publisher, not a theorem prover, not a safety certifier, not production controller evidence, not a replacement for Mathlib, and not a public theorem/proof/open-problem claim.
Status
- Version:
0.0.1 - Published for early testing.
- Intended for read-only review packet generation.
- Does not push, pull, fetch, merge, deploy, upload, publish, or handle tokens.
Install
python -m pip install review-branch-packet
For repository development:
python -m pip install -e package_candidates/review_branch_packet
Usage
review-branch-packet inspect --target review/machlib-function-class-frontier-2026-05-20
review-branch-packet inspect --target review/machlib-function-class-frontier-2026-05-20 --json
review-branch-packet inspect --target review/machlib-function-class-frontier-2026-05-20 --out packet.json
review-branch-packet inspect --target review/machlib-function-class-frontier-2026-05-20 --markdown-out packet.md
review-branch-packet inspect --target review/machlib-function-class-frontier-2026-05-20 --repo . --remote origin --log-limit 20
review-branch-packet inspect --target review/machlib-function-class-frontier-2026-05-20 --include-validation-placeholder
PYTHONPATH=package_candidates/review_branch_packet/src python -m review_branch_packet.cli inspect --target review/machlib-function-class-frontier-2026-05-20 --json
The default command prints a Markdown packet. --json prints JSON. --out
writes JSON to a file, and --markdown-out writes Markdown to a file.
Read-Only Git Commands
The package only uses read-only commands:
git status --shortgit branch --show-currentgit remote -vgit log --oneline -Ngit ls-remote --heads <remote> <target>
The command runner is allowlist based. It refuses forbidden commands such as
git push, git pull, git fetch, git checkout, git merge, git rebase,
git reset, git add, git commit, gh pr create, deploy commands, upload
commands, and package publish commands.
Packet Contents
The JSON and Markdown packet include:
- branch summary
- remote review branch summary
- latest commits
- working tree status
- validation summary placeholders
- no-go confirmations
- human approval requirements
- recommended next actions
JSON Output Example
{
"packet_id": "review_branch_packet_2026_05_20",
"target_review_branch": "review/machlib-function-class-frontier-2026-05-20",
"local_only": true,
"read_only": true,
"review_branch_present": true,
"local_head_sha": "cafebabe",
"local_head_short": "cafebab",
"working_tree_clean": true,
"push_performed": false,
"github_pr_created": false,
"merge_performed": false,
"command_center_deploy_performed": false,
"package_publish_performed": false,
"pypi_token_handling_performed": false
}
Markdown Output Example
# Review Branch Packet
## Branch Summary
- Current branch: feat/ac-instances
- Local HEAD: cafebab
This packet is not a PR, not a merge, not a deploy, and not a publish.
Relationship To Monogate/MachLib
This package is a helper for Monogate/MachLib private-review preparation. It summarizes branch state and validation placeholders so a human reviewer can inspect a packet before any separately approved push, PR, merge, deploy, upload, or publication task.
Limitations
- Does not validate theorem/proof content.
- Does not create pull requests.
- Does not merge, deploy, push, upload, or publish packages.
- Does not manage credentials or tokens.
- Does not replace human review.
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 review_branch_packet-0.0.1.tar.gz.
File metadata
- Download URL: review_branch_packet-0.0.1.tar.gz
- Upload date:
- Size: 10.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd25c56f73f945a371162988d730a36b7bc9b93153ece8bff436c2af0b579a44
|
|
| MD5 |
d9b15611736b7f2d3c20933e3d28b7c6
|
|
| BLAKE2b-256 |
020eb9e0d05c8ca5bfcef0ec381ca08c437c3d0bb5b8cf436b4162258b5e6ebe
|
File details
Details for the file review_branch_packet-0.0.1-py3-none-any.whl.
File metadata
- Download URL: review_branch_packet-0.0.1-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
68f7b11fb80433030758ae02be5227b21b48618ef0fbd3bf87c1cb03a4adc172
|
|
| MD5 |
98b44b2cb1da56bcdb82ee630056a35a
|
|
| BLAKE2b-256 |
efa264ea319f62d44aa0c0f7010d83ee52e9fcb3df7690997b56cce62edd0da9
|