revrem 0.3.2__tar.gz

revrem-0.3.2/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the
+original version of the Work and any modifications or additions to
+that Work or Derivative Works thereof, that is intentionally submitted
+to Licensor for inclusion in the Work by the copyright owner or by an
+individual or Legal Entity authorized to submit on behalf of the
+copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. Do not include
+the brackets. The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

revrem-0.3.2/NOTICE

@@ -0,0 +1,10 @@
+code-review-loop
+Copyright 2026 Colin Farmer
+
+This product includes software developed by Colin Farmer.
+
+Third-party notices:
+
+No third-party NOTICE obligations have been identified for the current runtime
+dependency set. Optional development dependencies must be rechecked before
+publishing packaged artifacts or adding generated assets.

revrem-0.3.2/PKG-INFO

@@ -0,0 +1,309 @@
+Metadata-Version: 2.4
+Name: revrem
+Version: 0.3.2
+Summary: Bounded AI review, remediation, and re-review automation for local repositories.
+Author: Colin Farmer
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/GitCmurf/revrem
+Project-URL: Source, https://github.com/GitCmurf/revrem
+Project-URL: Issues, https://github.com/GitCmurf/revrem/issues
+Project-URL: Changelog, https://github.com/GitCmurf/revrem/blob/main/CHANGELOG.md
+Keywords: ai,code-review,automation,devex,cli,remediation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: jsonschema>=4.22
+Requires-Dist: tomli-w>=1.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: detect-secrets>=1.5; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: pip-licenses>=5; extra == "dev"
+Requires-Dist: pre-commit>=4; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: rich>=13.7; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: textual>=0.80; extra == "dev"
+Requires-Dist: twine>=6; extra == "dev"
+Provides-Extra: progress
+Requires-Dist: rich>=13.7; extra == "progress"
+Provides-Extra: redaction
+Requires-Dist: detect-secrets>=1.5; extra == "redaction"
+Provides-Extra: tui
+Requires-Dist: rich>=13.7; extra == "tui"
+Requires-Dist: textual>=0.80; extra == "tui"
+Dynamic: license-file
+
+# revrem
+
+[![CI](https://github.com/GitCmurf/revrem/actions/workflows/ci.yml/badge.svg)](https://github.com/GitCmurf/revrem/actions/workflows/ci.yml)
+[![Release](https://img.shields.io/github/v/release/GitCmurf/revrem)](https://github.com/GitCmurf/revrem/releases)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Python: 3.11 | 3.12](https://img.shields.io/badge/python-3.11%20%7C%203.12-3776ab.svg)](pyproject.toml)
+
+RevRem runs an automated review -> fix -> verify loop on your local branch before you open a pull request.
+
+It asks Codex to review a branch against a base, applies valid actionable
+findings through a bounded remediation pass, reruns your verification commands,
+and leaves an artifact trail you can inspect before committing or merging.
+
+The repository and Python package use the public name `revrem`. The legacy
+`code-review-loop` command remains available as a compatibility alias for
+existing local scripts.
+
+## Demo
+
+```text
+$ revrem --base main --max-iterations 2 --check "pytest -q"
+12:08:23|rev|1   |start: codex review --base main
+12:10:14|rev|1   |[P1] Preserve failure artifacts when review startup fails
+12:10:15|rem|1   |start: codex exec --full-auto --sandbox workspace-write ...
+12:13:41|rem|1   |done
+12:13:42|chk|1.1 |start: pytest -q
+12:14:18|chk|1.1 |passed
+12:14:19|rev|2   |clear
+
+Review-remediation loop: clear (review_clear)
+Artifacts: .revrem/runs/20260509T120823Z
+JSON summary: .revrem/runs/20260509T120823Z/summary.json
+```
+
+## Install
+
+RevRem is not published on PyPI yet. Install it from a checkout:
+
+```bash
+git clone https://github.com/GitCmurf/revrem.git
+cd revrem
+./scripts/install-dev
+./.venv/bin/revrem --version
+```
+
+For a stable `revrem` command that is available from other local repositories:
+
+```bash
+./scripts/promote-stable
+revrem --version
+```
+
+`./scripts/promote-stable` runs the local verification gate, copies the current
+source snapshot under `~/.local/share/revrem/releases/`, builds an isolated
+stable virtualenv under `~/.local/share/revrem/`, and updates these launchers:
+
+```text
+~/.local/bin/revrem
+~/.local/bin/code-review-loop
+```
+
+Use `./.venv/bin/revrem` while developing this repository. Use the promoted
+`revrem` command when reviewing other repositories.
+
+## Quick Start
+
+From the repository you want to review:
+
+```bash
+revrem --base main --max-iterations 2 --check "pytest -q"
+```
+
+Add checks that match the target repository:
+
+```bash
+revrem \
+  --base main \
+  --max-iterations 2 \
+  --check "pytest -q" \
+  --check "git diff --check"
+```
+
+Expected behavior:
+
+- exit `0` when the final loop status is clear;
+- exit `2` when findings or check failures remain after the bounded loop;
+- write artifacts to `.revrem/runs/<timestamp>/`;
+- append run metadata to `~/.local/share/revrem/runs.jsonl` unless
+  `--no-run-history` is used.
+
+Use repository-native checks. Python repositories can use `pytest`; TypeScript
+repositories should usually use commands such as `pnpm test`,
+`pnpm run typecheck`, and `pnpm run lint`.
+
+Machine-readable artifact contracts are documented under
+[`docs/52-api/`](docs/52-api/).
+
+Before a live model-backed loop, run local setup diagnostics:
+
+```bash
+revrem doctor --base main --check "pytest -q"
+```
+
+`revrem doctor` validates the local Git base, writable artifact path, Codex
+executable, and configured check executables without invoking a model. Relative
+`--artifact-dir` values are resolved against the doctor `cwd`, not the process
+working directory. It warns when profile timeouts explicitly disable a phase
+timeout and when the current locale is not UTF-8 capable. Use `--format json`
+for automation.
+
+To share a failed run safely, create a redacted bundle:
+
+```bash
+revrem bundle-bug-report .revrem/runs/<run-id> --output revrem-bug.tar.gz
+```
+
+If `--output` is omitted, RevRem writes `revrem-bug-<safe-run-id>.tar.gz` in
+the current working directory, using a basename-derived component from the run
+metadata and falling back to the run directory name when needed.
+
+The bundle command ignores symlinked artifacts so the archive cannot follow
+links out of the run directory. It includes `summary.json`, diagnostics/event
+JSON, status diagnostics, check output, and sanitized profile/preflight snapshots
+when those files are present in the run directory.
+
+Raw review/remediation transcripts are excluded by default. Use
+`--include-raw-transcripts` only when the extra context is necessary; contents
+are still redacted unless `--no-redact --i-understand-the-risks` is explicitly
+passed.
+
+## How It Works
+
+RevRem is intentionally local, watched, and bounded:
+
+1. Runs `codex review` against a chosen base branch.
+2. Detects whether the review is clear or has findings.
+3. Runs a bounded Codex remediation pass for valid actionable findings.
+4. Runs your configured verification commands.
+5. Repeats until the review is clear or `--max-iterations` is reached.
+6. Writes review, remediation, check, and summary artifacts for inspection.
+
+Optional features include finding triage, JSON summaries, automatic remediation
+commits after passing checks, Rich progress rendering, and a dependency-gated
+Textual TUI.
+
+When triage output is structured JSON, RevRem validates it against
+`triage-v1.schema.json`, writes `triage-N.json`, and forwards the structured
+handoff plus the original review context to remediation. Invalid structured
+triage writes `diagnostics-N.json` and fails safe by continuing with the original
+review context. The bug-report bundle includes both `diagnostics.json` and
+numbered `diagnostics-N.json` artifacts so triage failures stay diagnosable.
+Structured triage also supports explicit suppressions via `revrem suppress`:
+matching confirmed findings are moved to
+`suppressed_findings`, remain visible in `triage-N.json`, and do not trigger
+remediation when no unsuppressed findings remain.
+
+## Profiles
+
+Profiles keep long commands repeatable:
+
+```bash
+revrem config new final-pr --description "Full PR readiness check"
+revrem config edit final-pr
+revrem config show final-pr
+revrem --profile final-pr
+```
+
+Project-local profiles can be saved without running the loop:
+
+```bash
+revrem --base main --max-iterations 2 --check "git diff --check" --save-profile final-pr
+```
+
+`--save-profile` writes `.revrem.toml` at the repository root and refuses to
+overwrite an existing project profile unless `--save-profile-force` is
+supplied.
+
+## Safety Model
+
+RevRem is a pre-merge confidence tool, not a substitute for review or tests.
+Its safety posture is built around local operator control:
+
+- iteration count is bounded by default;
+- generated run artifacts are kept out of normal commits;
+- auto-commit requires a clean worktree before the loop starts;
+- remediation commits are made only after configured checks pass;
+- machine-readable output is opt-in with `--summary-format json` or
+  `--summary-format both`;
+- local run history can be disabled with `--no-run-history`;
+- no hosted service or telemetry is part of RevRem itself.
+
+Use `--commit-after-remediation` only when each verified remediation pass should
+become a git commit. RevRem stages with `git add -A` after checks pass, excludes
+the configured artifact directory, skips empty commits, and runs `git commit`
+itself. If commit hooks fail, the default policy is to preserve the staged
+changes, write the hook output to the commit artifact, and feed that output into
+the next bounded remediation pass. Use `--commit-on-hook-failure stop` to fail
+gracefully instead, or `--commit-on-hook-failure no-verify` only when bypassing
+hooks is an intentional operator decision.
+
+## Optional Progress And TUI
+
+For richer watched-terminal output:
+
+```bash
+./.venv/bin/pip install -e ".[progress]"
+revrem --profile final-pr --progress-style rich
+```
+
+The optional TUI is dependency-gated so the default CLI remains lightweight:
+
+```bash
+./.venv/bin/pip install -e ".[tui]"
+./.venv/bin/revrem ui
+./.venv/bin/revrem ui --profile final-pr
+```
+
+The TUI renders Home, Profiles, Pipeline, Run Monitor, and Controls views. It
+shells through the same CLI command plans as normal terminal usage.
+
+## Limitations
+
+- Codex must be installed and authenticated locally.
+- The current directory must be the repository under review.
+- The selected `--base` branch must share history with the current branch.
+- Review/remediation quality depends on the model and the checks you provide.
+- Human review, security review, and release approval still matter.
+- Avoid dirty worktrees unless the local edits are intentional and understood.
+- Do not use unbounded iteration counts for unattended automation.
+- Do not paste raw model transcripts or local run artifacts into public issues;
+  use the redacted bug-report workflow instead.
+
+## Development
+
+```bash
+./scripts/install-dev
+pre-commit install
+./scripts/dev-check
+pre-commit run --all-files
+```
+
+The development extra installs `ruff`, `mypy`, `pytest`, Rich, Textual, build
+tooling, `pre-commit`, `detect-secrets`, and license-review helpers. Ruff,
+mypy, pytest, DocOps checks, and `git diff --check` are required local and CI
+gates.
+
+Optional runtime extras stay narrow: `.[progress]` installs Rich, `.[tui]`
+installs Textual and Rich, and `.[redaction]` installs optional
+`detect-secrets` support for workflows that want an additional scanner alongside
+RevRem's built-in redaction regexes.
+
+The repository also carries tiny local compatibility shims for `tomli_w` and
+`jsonschema` so the test suite can collect in minimal environments. The
+published dependency declarations remain the supported install path.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution expectations, governed
+documentation, and release process details.
+
+## License
+
+This project is licensed under the Apache License 2.0; see [LICENSE](LICENSE)
+for details. [NOTICE](NOTICE) contains project attribution and must be preserved
+where Apache-2.0 notice requirements apply.