Local draft read-only private review branch packet generator.
Project description
review-branch-packet
review-branch-packet is a local draft package candidate for building private review branch packets from read-only git state. It packages the repeated MachLib private-review inspection workflow into a small CLI and library surface.
Status:
- Local draft only.
- No PyPI release performed.
- No PyPI package name availability check performed.
- No PyPI token handling performed.
- No package publish performed.
- No release artifacts created.
- Not release-ready and not upload-ready.
- Package name availability is unknown and was not checked.
Install From Source
Use a local editable install only inside an isolated development environment:
python -m pip install -e package_candidates/review_branch_packet
This is not a publication instruction and does not upload anything.
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, npm run deploy, twine upload, deploy commands, upload commands, or 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.
Relation To Monogate/MachLib
This package candidate is a local helper for MachLib/Monogate 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
This package does not validate theorem/proof content, does not create pull requests, does not merge, does not deploy, does not push, and does not publish packages. It is not a PR creator, not a deploy tool, not a package publisher, and not a release/publication gate by itself. It is a local reviewer packet helper for MachLib/Monogate workflow evidence.
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.0.dev0.tar.gz.
File metadata
- Download URL: review_branch_packet-0.0.0.dev0.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 |
093924188f6e84b644b2d9b838f81bd6d315472d0a950c397eae1390a9e68f05
|
|
| MD5 |
4584e95742d23166948a69315b596308
|
|
| BLAKE2b-256 |
8188a29b8394cb7951d320d57179347b4b9d48aad3e63667bc9ff8660cb0bfa8
|
File details
Details for the file review_branch_packet-0.0.0.dev0-py3-none-any.whl.
File metadata
- Download URL: review_branch_packet-0.0.0.dev0-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 |
765daf824ea1c5d8c4d350d569dbbcdc99ddf9943dcd9962c424ccb0d82e4eba
|
|
| MD5 |
6ec686d6c0d10d94872f916290a7e5c1
|
|
| BLAKE2b-256 |
8bc99f702537b7652a633106447c1ebd4068c45e7c9f9ea69fdcb0f865cd6d25
|