Metadata-Version: 2.4
Name: zenodotus
Version: 0.3.0
Summary: OSS release-readiness gate: deterministic pre-gates + a no-context reviewer panel
Project-URL: Homepage, https://github.com/Kromatic-Innovation/zenodotus
Project-URL: Repository, https://github.com/Kromatic-Innovation/zenodotus
Project-URL: Issues, https://github.com/Kromatic-Innovation/zenodotus/issues
Author-email: Kromatic <oss@kromatic.com>
License: 
                                         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 2026 Kromatic Innovation
        
           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.
License-File: LICENSE
Keywords: gate,llm,open-source,readiness,release,review
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff==0.16.0; extra == 'dev'
Provides-Extra: llm
Requires-Dist: anthropic>=0.40; extra == 'llm'
Provides-Extra: tools
Requires-Dist: pyroma>=4.2; extra == 'tools'
Requires-Dist: twine>=5.0; extra == 'tools'
Description-Content-Type: text/markdown

# Zenodotus

![zenodotus: three judge archetypes — developer, compliance officer, security reviewer — stamping verdicts at a checkpoint gate](docs/assets/hero.png)

**An OSS release-readiness review gate: deterministic pre-gates + a no-context reviewer panel.** It renders a three-state verdict — **pass / warn / block** — where warnings are advisory and **never block** (exit 0). Blocking is reserved for genuine blockers and is opt-in per the maintainer's trust level; the default posture is advisory.

**Use case:** you're about to open-source a repo and want more than a green CI badge before you flip it public — something that catches the stuff linters structurally can't: leaked internal context, a README that only makes sense to people who already work here, scope creep, an unfinished feature dressed up as done.

**Differentiator:** every "is this OSS-ready" tool on the market is a checklist — license present, CoC present, no secrets. Zenodotus composes those (via existing tools: Scorecard, REUSE, Gitleaks, pyroma) as a hard floor, then adds what checklists can't do: independent, no-context reviewers who render a judgment call, not a checkbox. Verdicts get logged; every panel-only finding (something the deterministic floor missed) is the evidence the panel earns its keep.

**Why:** a repo can pass every automated check and still be unreadable, still leak org-internal assumptions, still not actually be finished — because none of that is mechanically checkable. Zenodotus exists because "the linters are green" and "this is actually ready for strangers" are different questions, and only one of them has been getting asked.

Most "is this repo open-source ready?" checks are mechanical and already solved
by great tools (OpenSSF Scorecard, REUSE, Gitleaks, pyroma, twine, GitHub
Community Standards). Zenodotus **composes those as a hard floor**, then adds the
part tools don't do: a panel of independent, *no-context* reviewers that judge
the things a linter can't — is the README coherent to an outsider, is the scope
and naming sensible, is there internal/proprietary leakage that isn't a
"secret", is this actually useful and finished?

The novel piece is the **reviewer-panel-as-gate**, not the checklist.

> Zenodotus's panel (`panel.py`) is a standalone Python implementation, purpose-built
> for release-gate judgment calls. It's conceptually related to (but does not
> depend on) [**panelist**](https://github.com/Kromatic-Innovation/panelist) —
> the org's general-purpose synthetic persona-panel engine (npm). They're kept
> separate by design; both satisfy a shared verdict shape instead of sharing
> code — see [`docs/PANEL_VERDICT_SPEC.md`](docs/PANEL_VERDICT_SPEC.md)
> (rationale: zenodotus#36).

## Status

**Public and published** — `zenodotus` is on PyPI (`pip install zenodotus`)
and this repo is open source. The core pipeline (deterministic gates → no-context
reviewer panel → discovery log → verdict) is wired end to end via
`zenodotus review`. Still pre-1.0: the "prove itself" work (docs/CONCEPT.md) —
accumulating panel-only discoveries and distilling them into the eval suite — now
serves as ongoing validation that the panel earns its keep, not as a gate holding
back a publication that has already happened.

## How it works

```
zenodotus review <path-or-repo>
  ├─ 1. Deterministic pre-gates (must all pass)  ── gates.py
  │      license · community files · secrets · packaging · security posture
  ├─ 2. No-context reviewer panel (judgment)      ── panel.py
  │      N independent reviewers, each blind to the others, raise
  │      severity-graded findings (blocker / major / minor)
  └─ 3. Discovery log + three-state verdict        ── discovery_log.py
         every panel-only finding (something the deterministic gates MISSED)
         is logged — this is how the panel earns its keep.
```

The command short-circuits: the panel only runs once the deterministic floor
passes. It then renders a **three-state verdict** — `pass` / `warn` / `block`
(see [`docs/PANEL_VERDICT_SPEC.md`](docs/PANEL_VERDICT_SPEC.md)):

- **`pass`** — nothing to act on. Exit `0`.
- **`warn`** — advisory findings exist, but none is a blocker. **Warnings never
  block** — exit `0`. This is the default posture: panel findings warn, they do
  not fail your build.
- **`block`** — a genuine blocker. Exit non-zero. A panel finding only escalates
  to `block` when you opt in with `--fail-on blocker`; the deterministic floor
  (a missing license, a leaked secret) is a hard gate and always blocks.

So the panel is a **review gate**, not a hard merge gate: it complements linters
with judgment-level review and, by default, advises rather than fails closed.
Blocking remains available (`--fail-on blocker`) but is reserved for genuine
blockers, opt-in per the maintainer's trust level.

## Prerequisites & setup

Zenodotus **composes** existing tools. Some ship with the package; others are
separate binaries you install out of band. **Every external tool is optional:
if it is absent, its gate reports `skipped` and the floor still runs** — see
[Skipped is not passed](#skipped-is-not-passed) below for why that matters.

### 1. Install the package (+ optional extras)

```bash
pip install "zenodotus[llm,tools]"   # or: pipx install "zenodotus[llm,tools]"
```

| Extra    | Provides                                             | Needed for |
| -------- | --------------------------------------------------- | ---------- |
| _(base)_ | the `zenodotus` CLI and deterministic gates         | always     |
| `llm`    | the default reviewer provider (Anthropic Claude)    | a live panel run |
| `tools`  | `pyroma` + `twine` (the `packaging_ok` gate)        | packaging checks |

A live panel run also needs an API key: `export ANTHROPIC_API_KEY=sk-...`.

### 2. Install the out-of-band binaries (optional)

These are Go/Ruby tools that are **not** pip-installable. Install only the ones
whose gate you want to run:

| Binary      | Gate it enables      | Install                                             | Skipped if absent |
| ----------- | -------------------- | --------------------------------------------------- | ----------------- |
| `gitleaks`  | `no_secrets`         | `brew install gitleaks` / [releases][gl]            | secret scan does not run |
| `licensee`  | `license_present` (enrichment only — a pure-Python check still runs) | `gem install licensee` | license enrichment does not run |
| `scorecard` | `security_posture` (optional, off unless `--include-optional`) | [ossf/scorecard][sc] | posture check does not run |

[gl]: https://github.com/gitleaks/gitleaks/releases
[sc]: https://github.com/ossf/scorecard

The exact versions and invocations are documented in
[docs/CONCEPT.md → Tools wired](docs/CONCEPT.md#tools-wired-into-the-deterministic-floor-srczenodotusgatespy).

### Skipped is not passed

A gate whose tool is absent reports **`skipped`, which is neither `passed` nor
`failed`** — the check simply did not run. `floor_passed()` treats a skipped
gate as non-blocking (so a missing optional tool never fails your build), which
means a green-looking verdict can still hide checks that never executed. If you
need a specific gate enforced, install its tool above and confirm the gate
reports `passed` (not `skipped`) — `zenodotus review . --json` lists each gate's
status explicitly.

## Usage

### Local

```bash
pipx install zenodotus            # or: pip install "zenodotus[llm]"
export ANTHROPIC_API_KEY=sk-...   # the default reviewer provider (Claude); your own key
zenodotus review /path/to/repo                     # human-readable verdict
zenodotus review /path/to/repo --json              # machine-readable
python -m zenodotus review . --reviewers 5 --log discoveries.jsonl
```

Options:

- `--json` — machine-readable output (includes each gate's `skipped`/`passed` status, the three-state `verdict`, and the raw `panel_verdict` before policy).
- `--reviewers N` — panel size (default 3).
- `--log PATH` — discovery-log JSONL path; `--log ''` disables logging.
- `--include-optional` — also run heavier optional gates such as OpenSSF Scorecard.
- `--fail-on {blocker,never}` — block threshold for **panel** findings. `never`
  (default) keeps panel findings advisory (they `warn`, never block); `blocker`
  makes a blocker-severity finding or a reviewer no-go exit non-zero. The
  deterministic floor blocks regardless.
- `--shadow` — advisory, non-blocking run (see [Shadow mode](#shadow-mode-recommended-for-accumulating-evidence) below).
- `--emit-verdict-marker` — also emit a durable, machine-readable cross-repo verdict marker (see [Cross-repo review](#cross-repo-review-verdict-marker) below).
- `--repo OWNER/NAME` — the slug recorded in that marker (defaults to the reviewed tree's git `origin` remote, then its directory name).
- `--reviewer-tools tool1,tool2` — explicit tool allowlist for reviewers ([issue #79](https://github.com/Kromatic-Innovation/zenodotus/issues/79)). Default: unset, i.e. fully isolated — reviewers get no tools at all, no matter what a provider requests. Anything not named here (including a tool-search/discovery capability) is denied, not implicitly reachable; the effective tool set and any denied attempt are reported (`--json` → `panel.isolation`).

Exit code follows the three-state verdict: `0` for `pass` and `warn` (warnings
never block), non-zero only for `block`. By default (`--fail-on never`) a panel
finding never blocks — you opt into blocking with `--fail-on blocker`. The
deterministic floor (missing license, leaked secret) is a hard gate and blocks
regardless.

### Shadow mode (recommended for accumulating evidence)

```bash
zenodotus review . --shadow --log discoveries.jsonl
```

`--shadow` runs Zenodotus on real release candidates **without blocking** them:
the reviewer panel runs even when the deterministic floor fails, every panel-only
finding is appended to the discovery log, and the process **always exits 0** — the
verdict is reported (as an advisory `warn`) but never blocks. Shadow is folded
into the three-state model as **warn-only**: any would-be `block` is presented as
`warn`. This is the **recommended way to accumulate "prove-itself" evidence** on
live RCs (docs/CONCEPT.md): gather a meaningful set of panel-only discoveries
safely, before Zenodotus blocks anything. Add it as a non-required CI step first,
review the accumulated log, and — once the evidence justifies it — tighten to a
blocking panel by dropping `--shadow` **and** setting `--fail-on blocker`.

### Cross-repo review (verdict marker)

Zenodotus can review an **external** repo — not just itself — and record a
durable verdict a separate tool can read. `zenodotus review <path>` already
accepts any checkout; add `--emit-verdict-marker` to also emit a small,
machine-readable marker recording the verdict against that tree's git HEAD:

```bash
zenodotus review /path/to/ideate-core --emit-verdict-marker \
  --repo Kromatic-Innovation/ideate-core
```

```html
<!-- zenodotus-verdict: v1
     repo: Kromatic-Innovation/ideate-core
     sha: <full commit SHA reviewed>
     verdict: pass | warn | block
     ran_at: <ISO-8601>
     runner: zenodotus vX.Y.Z
-->
```

Post that marker as a comment on the target repo. A consumer (e.g. hestia's
`oss-status` command) reads it to answer "has zenodotus cleared this repo's
current `main`?" and detects staleness for free by comparing the marker's `sha`
to the target's current HEAD — mismatch (or the `unknown` sentinel when the tree
was not a git checkout) means "stale, re-run", never a silent false "cleared".
Zenodotus only *writes* the marker; it stays dependency-free and does not post to
GitHub itself. Full format spec: [`docs/CROSS_REPO_VERDICT.md`](docs/CROSS_REPO_VERDICT.md).

### Deployable routine (container / CI job)

Run the same command in a container or CI step to gate a release candidate. A
minimal container:

```dockerfile
FROM python:3.11-slim
RUN pip install "zenodotus[llm,tools]"
ENTRYPOINT ["zenodotus", "review"]
```

```bash
docker run --rm -e ANTHROPIC_API_KEY -v "$PWD:/repo" zenodotus /repo --json
```

As a GitHub Actions step. By default the panel is **advisory** — it surfaces a
verdict and discoveries but exits `0` on `warn`, so it never fails the job on a
panel finding (only the deterministic floor blocks). Add `--fail-on blocker` when
you want a blocker-severity finding (or a reviewer no-go) to fail the job:

```yaml
- name: Zenodotus release-readiness review
  env:
    ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
  run: |
    pip install "zenodotus[llm,tools]"
    # advisory by default; add --fail-on blocker to make panel blockers fail CI
    zenodotus review . --json --log discoveries.jsonl
```

The deterministic floor (`gates.py`) composes external tools as optional
subprocesses and degrades gracefully when one is absent. The exact tools,
pinned versions, and invocations are documented in
[docs/CONCEPT.md → Tools wired](docs/CONCEPT.md#tools-wired-into-the-deterministic-floor-srczenodotusgatespy).
Install the pip-installable helpers with `pip install "zenodotus[tools]"`.

## Why the discovery log matters

Zenodotus only justifies its existence if the panel finds things the free
deterministic tools do not. Every such finding is recorded to a structured
**discovery log** (`discovery_log.py`). The log is the running evidence that the
panel earns its keep — see [docs/CONCEPT.md](docs/CONCEPT.md) and the "prove
itself" issues for how those discoveries feed the eval suite.

## License

Apache-2.0 — chosen for its explicit patent grant (see docs/POSITIONING.md).
