krystal-quorum 0.6.1__tar.gz

krystal_quorum-0.6.1/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://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. (Don't 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
+
+http://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.

krystal_quorum-0.6.1/PKG-INFO

@@ -0,0 +1,382 @@
+Metadata-Version: 2.4
+Name: krystal-quorum
+Version: 0.6.1
+Summary: Preflight review for AI coding plans.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/KrystalUnity/krystal-quorum
+Project-URL: Repository, https://github.com/KrystalUnity/krystal-quorum
+Project-URL: Issues, https://github.com/KrystalUnity/krystal-quorum/issues
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.7
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: twine>=5; extra == "dev"
+Dynamic: license-file
+
+# Krystal Quorum
+
+[![CI](https://github.com/KrystalUnity/krystal-quorum/actions/workflows/ci.yml/badge.svg)](https://github.com/KrystalUnity/krystal-quorum/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+```text
++-- Krystal Quorum ------------------------+
+| Review the plan before agents edit code. |
++------------------------------------------+
+```
+
+Review the plan before your AI coding agent creates the mess.
+
+Krystal Quorum is a local CLI that reviews markdown implementation plans with one or more independent reviewers, then writes a reconciled human-triage summary. It is designed for developers using AI coding agents who want to catch vague requirements, missing acceptance criteria, contradictions, unsafe assumptions, rollback gaps, and test gaps before code is written.
+
+Krystal Quorum is not an agent runtime and not a code generator. It is a review step before implementation.
+
+## Quickstart
+
+Until Krystal Quorum is published to PyPI, install it from a source checkout:
+
+```bash
+git clone https://github.com/KrystalUnity/krystal-quorum.git
+cd krystal-quorum
+python -m pip install .
+python -m krystal_quorum review examples/bad-plan.md --reviewers mock --format pretty
+```
+
+The no-key mock reviewer returns `REVISE` for the deliberately weak plan and
+writes an append-only review run under `.krystal-quorum/reviews/`.
+
+By default Quorum rejects plans over 120,000 characters before reviewers are
+constructed, with a rough token estimate in the error. Use `--max-plan-chars`
+to raise the limit or `--max-plan-chars 0` to disable the guard for a
+controlled run.
+
+For development from the checkout:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+## See It Work
+
+```bash
+python -m krystal_quorum review examples/bad-plan.md --reviewers mock --format pretty
+```
+
+```text
++ Krystal Quorum ------------------------------------------------------------+
+VERDICT: REVISE | Confidence: 0.77
+Reviewers: mock
+Diversity: ok
+
+Singleton Blockers (1)
+- [Acceptance] The plan does not include explicit acceptance criteria.
+
+Artifacts: .krystal-quorum/reviews/...
++----------------------------------------------------------------------------+
+```
+
+`REVISE` exits with code `1`, so CI scripts can fail fast when a plan needs
+work. Review artifacts are written locally and ignored by git.
+
+Now run the fixed plan:
+
+```bash
+python -m krystal_quorum review examples/good-plan.md --reviewers mock --format pretty
+```
+
+The mock reviewer sees explicit acceptance criteria and returns `APPROVE`
+with exit code `0`. See [docs/demo.md](docs/demo.md) for a short transcript and
+terminal card.
+
+JSON remains available for scripts with `--format json`, which is also the
+default.
+
+## Agent Import Packs
+
+Install project-local skills or prompt files for the agents you already use:
+
+| Target | Command |
+| --- | --- |
+| Claude Code | `krystal-quorum init --target claude-code` |
+| Codex | `krystal-quorum init --target codex` |
+| Hermes-style runners | `krystal-quorum init --target hermes` |
+| Claw / OpenClaw | `krystal-quorum init --target claw` |
+| OpenCode | `krystal-quorum init --target opencode` |
+| Everything | `krystal-quorum init --target all` |
+
+The packs share one workflow file at
+`.krystal-quorum/agents/quorum-review.md`, so every agent gets the same review
+gate. Details live in [docs/agent-integrations.md](docs/agent-integrations.md)
+and [docs/agent-import-packs.md](docs/agent-import-packs.md).
+
+List supported targets with:
+
+```bash
+krystal-quorum init --list-targets
+```
+
+Example JSON output:
+
+```json
+{
+  "schema_version": "1.2",
+  "verdict": "REVISE",
+  "confidence": 0.9,
+  "reviewers_used": ["mock"],
+  "diversity": "ok",
+  "diversity_reason": null,
+  "diversity_reviewers": [{"reviewer": "mock", "backend": "mock", "family": "mock"}],
+  "output_dir": ".krystal-quorum/reviews/bad-plan_20260619-102618"
+}
+```
+
+## Reviewers
+
+Krystal Quorum is bring-your-own-LLM. The CLI sends the plan text to each
+configured reviewer, asks for strict JSON, then reconciles the responses into
+one human-triage summary.
+
+If a reviewer returns malformed text instead of the strict JSON contract,
+Krystal Quorum retries that reviewer once with a JSON-only reminder. The final
+artifact records the retry count and preserves raw text from both attempts.
+Transient HTTP failures from Ollama or OpenAI-compatible reviewers are retried
+before the reviewer is marked `ABSTAIN`.
+When a reviewer omits `<json>` tags, Quorum searches for complete reviewer JSON
+objects and prefers the last one, which reduces false parses when a model echoes
+the schema before its final answer. Reasoning-only responses are parsed only
+when they contain explicit `<json>...</json>` tags.
+
+Use the mock reviewer first to prove the workflow works. It uses no network and
+requires no keys:
+
+```bash
+krystal-quorum review examples/bad-plan.md --reviewers mock --format pretty
+```
+
+### Local Ollama
+
+Start Ollama with any model you already have available, then pass the model name
+after `ollama:`:
+
+```bash
+krystal-quorum review plan.md --reviewers ollama:qwen2.5:14b
+```
+
+Prefer instruct-tuned models for reviewer adapters. Reasoning-heavy models can
+spend most of the default timeout on internal thinking and may abstain if they
+do not return the strict JSON contract in time.
+
+For Ollama-compatible servers that support reasoning controls, project config
+can disable thinking and cap generation:
+
+```toml
+[ollama]
+think = false
+num_predict = 1024
+```
+
+If Ollama is running somewhere other than `http://localhost:11434`, set
+`OLLAMA_BASE_URL`:
+
+```bash
+OLLAMA_BASE_URL=http://192.168.1.20:11434 krystal-quorum review plan.md --reviewers ollama:your-model
+```
+
+### OpenAI API
+
+```bash
+export OPENAI_API_KEY=...
+krystal-quorum review plan.md --reviewers openai:gpt-4.1
+```
+
+PowerShell:
+
+```powershell
+$env:OPENAI_API_KEY = "..."
+krystal-quorum review plan.md --reviewers openai:gpt-4.1
+```
+
+### OpenAI-Compatible Servers
+
+Any server that exposes an OpenAI-compatible `/chat/completions` endpoint can be
+used by setting `OPENAI_BASE_URL`. This is how you connect hosted providers,
+gateway services, or local inference servers that mimic the OpenAI API.
+
+```bash
+export OPENAI_API_KEY=your-provider-key-or-local-placeholder
+export OPENAI_BASE_URL=http://localhost:1234/v1
+krystal-quorum review plan.md --reviewers openai:your-model
+```
+
+PowerShell:
+
+```powershell
+$env:OPENAI_API_KEY = "your-provider-key-or-local-placeholder"
+$env:OPENAI_BASE_URL = "http://localhost:1234/v1"
+krystal-quorum review plan.md --reviewers openai:your-model
+```
+
+### Local Command Reviewers
+
+Use `command:<name>` reviewers when you already have local coding agents or
+review scripts installed. Command reviewers receive the full review prompt on
+stdin and can return the strict reviewer JSON on stdout.
+
+```toml
+# krystal-quorum.toml
+[reviewers.local-codex]
+type = "command"
+command = ["codex", "exec", "--sandbox", "read-only", "--ephemeral", "-"]
+timeout_s = 180
+```
+
+Then run:
+
+```bash
+krystal-quorum review plan.md --config krystal-quorum.toml --reviewers command:local-codex
+```
+
+If a tool writes its final answer to a file, configure `output_file`. This is
+useful for wrappers that start a detached local agent process and collect the
+final review later.
+
+```toml
+[reviewers.local-agent]
+type = "command"
+command = ["bash", "reviewers/local-agent-review.sh"]
+timeout_s = 30
+output_file = ".krystal-quorum/tmp/local-agent-review.json"
+wait_for_output_s = 300
+```
+
+Command reviewers are intentionally generic. They can wrap installed CLIs,
+local scripts, or remote shells. If a command times out, exits without output,
+or still returns unparseable text after the one-shot parse retry, Krystal
+Quorum records that reviewer as `ABSTAIN` instead of blocking the whole run.
+Multi-reviewer runs surface partial abstentions in `unresolved_for_human`; if a
+multi-reviewer quorum collapses to only one usable reviewer, the merged verdict
+is forced to `REVISE` for human triage.
+
+Try the bundled command-reviewer example:
+
+```bash
+krystal-quorum review examples/bad-plan.md --config examples/command-reviewer.toml --reviewers command:example-local
+```
+
+### Multiple Reviewers
+
+Pass a comma-separated reviewer list to compare independent model reviews:
+
+```bash
+krystal-quorum review plan.md --reviewers ollama:model-a,openai:model-b
+```
+
+Add `--round2` when you want reviewers to cross-audit each other's findings
+before the final reconciliation:
+
+```bash
+krystal-quorum review plan.md --reviewers ollama:model-a,openai:model-b --round2
+```
+
+Round 2 artifacts include `round2_delta` and per-reviewer before/after verdicts
+so you can see whether cross-audit changed any reviewer positions.
+When `--round2` is used, the short CLI JSON also includes `round2_comparisons`
+for scripts that do not read the full artifact directory.
+
+### Reviewer Diversity
+
+Krystal Quorum reports reviewer diversity in both CLI output and persisted
+artifacts. Diversity is `low` when any two reviewers resolve to the same model
+family, such as `openai:gpt-4.1` and `openai:gpt-4.1-mini`, or
+`ollama:qwen2.5:14b` and `ollama:qwen2.5:32b`.
+
+Use `--require-diversity` to fail closed before review when reviewers are too
+correlated:
+
+```bash
+krystal-quorum review plan.md \
+  --reviewers ollama:qwen2.5:14b,ollama:qwen2.5:32b \
+  --require-diversity
+```
+
+Command reviewers use the command name as their family by default. You can
+override that in config:
+
+```toml
+[reviewers.local-agent-a]
+type = "command"
+command = ["bash", "reviewers/a.sh"]
+family = "local-agent"
+```
+
+Low diversity does not change the verdict by itself, but it reduces the
+reported system confidence.
+
+## Reconciliation Model
+
+Krystal Quorum is safety-biased rather than majority-rule voting. A single
+`BLOCK` verdict blocks the merged result, and a single unresolved blocking issue
+forces at least `REVISE`. When two or more reviewers report substantially
+similar blocking issues, Quorum promotes that finding to a shared blocker. This
+single-`BLOCK` veto is intentional fail-safe behavior; run Round 2 or inspect
+the artifacts when a lone reviewer disagrees with the rest of the quorum.
+
+Consensus matching is deterministic and explainable. Quorum groups reviewer
+findings with a small public concept matcher for common review areas such as
+acceptance criteria, rollback, tests, security, dependencies, and observability.
+It does not use embeddings or hidden model calls to decide whether two issues
+match. Persisted review artifacts include `issue_clusters` with members, direct
+match edges, and match reasons.
+
+Support-overlap consensus requires at least two shared support terms and an
+overlap coefficient of at least `0.50`. Absence-style findings require a shared
+topic-specific gap term, so broad words like "missing" or generic section names
+like "Plan" are not enough to create consensus.
+
+Set `KRYSTAL_QUORUM_CONSENSUS_MATCHER=legacy` to temporarily restore the older
+token-overlap grouping behavior. This is a behavior rollback, not a schema
+downgrade: schema-1.1-only consumers should pin a v0.3.x release or revert the
+v0.4 change.
+
+Reviewers are asked to emit `per_clause` statuses for common plan clauses such
+as acceptance criteria, rollback, tests, safety assumptions, security risk,
+dependency scope, and observability plan. Contradictory clause statuses are
+surfaced for human triage instead of being averaged away. Common key variants
+such as `acceptance_criteria` and `security_risk` are normalized before
+comparison; unknown keys are flagged in `unresolved_for_human`.
+
+The `confidence` field is a system-adjusted signal. It starts from reviewer
+self-reported confidence, then discounts weak quorum health, low diversity,
+singleton blockers, and contradictions.
+
+Architecture notes:
+
+- [Consensus matching](docs/architecture/consensus-matching.md)
+- [Local command reviewers](docs/architecture/local-command-reviewers.md)
+
+Benchmark fixtures live in [benchmarks/](benchmarks/). They provide a small,
+public way to compare single-reviewer and multi-reviewer behavior without
+claiming more evidence than the project has collected.
+
+## Exit Codes
+
+- `0`: approve
+- `1`: revise
+- `2`: block
+- `3`: runtime or configuration error
+
+Reviewer outputs are advisory. A human should triage the findings before implementation.
+
+## License
+
+Apache-2.0.