prpt 0.1.0__tar.gz

prpt-0.1.0/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 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 accept and charge a
+      fee for the 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 PromptPilot contributors
+
+   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.

prpt-0.1.0/PKG-INFO

@@ -0,0 +1,350 @@
+Metadata-Version: 2.4
+Name: prpt
+Version: 0.1.0
+Summary: PromptPilot — prompt-optimizing wrapper for AI coding CLIs; uses a cheap SLM to reduce token consumption on expensive models
+Author: PromptPilot contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/steyangdot/PromptPilot
+Project-URL: Issues, https://github.com/steyangdot/PromptPilot/issues
+Project-URL: Repository, https://github.com/steyangdot/PromptPilot
+Keywords: llm,prompt-optimization,token-savings,claude,openai,codex
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: claude
+Requires-Dist: anthropic>=0.39.0; extra == "claude"
+Provides-Extra: codex
+Requires-Dist: openai>=1.0.0; extra == "codex"
+Requires-Dist: tiktoken>=0.7.0; extra == "codex"
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.39.0; extra == "anthropic"
+Provides-Extra: openai
+Requires-Dist: openai>=1.0.0; extra == "openai"
+Requires-Dist: tiktoken>=0.7.0; extra == "openai"
+Provides-Extra: all
+Requires-Dist: anthropic>=0.39.0; extra == "all"
+Requires-Dist: openai>=1.0.0; extra == "all"
+Requires-Dist: tiktoken>=0.7.0; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Dynamic: license-file
+
+# PromptPilot
+
+Prompt-optimizing wrapper for AI coding CLIs. Uses a cheap SLM (Claude Haiku or GPT-4o-mini) to rewrite developer prompts before they hit expensive models, reducing token consumption.
+
+> **First-time user?** Start with **[QUICKSTART.md](QUICKSTART.md)** — five-minute onboarding covering install, auth, and the `handoff.md` workflow.
+
+## Install
+
+Pick the extra that matches your coding agent:
+
+```bash
+pip install prpt[claude]      # for use with claude-code (Claude Haiku SLM)
+pip install prpt[codex]       # for use with codex (GPT-4o-mini SLM)
+pip install prpt[all]         # both
+```
+
+`[anthropic]` / `[openai]` are kept as aliases for backward compatibility.
+
+## Auth: which path to pick
+
+**Recommended for Max/Pro users:** `claude auth login --claudeai`. PromptPilot
+auto-detects the OAuth session and routes the SLM via the official `claude`
+CLI subprocess. No API key needed, no incremental charges — calls bill against
+your subscription's monthly quota (which Anthropic doubled for Pro/Max in
+2026).
+
+**Alternative:** drop `ANTHROPIC_API_KEY` (or `OPENAI_API_KEY`) into `.env`.
+The SDK paths run faster (~1-2s/call vs ~5-7s for subprocess) and use prompt
+caching. Billed per-call against your API credits.
+
+### Compliance posture (worth understanding before relying on subscription routing)
+
+Anthropic clarified on **Feb 20, 2026** that subscription OAuth credentials are
+"intended exclusively to support ordinary use of Claude Code and other native
+Anthropic applications." On **Apr 4, 2026**, technical enforcement landed
+against third-party tools (OpenClaw, OpenCode, etc.) that extracted OAuth
+tokens and made direct API calls while spoofing Claude Code's request shape.
+
+**PromptPilot is structurally different from those tools:**
+
+| Axis | OpenClaw / OpenCode | PromptPilot |
+|---|---|---|
+| OAuth token handling | Read `~/.claude/.credentials.json`, sent bearer directly | Never touches the token; official `claude` binary owns it |
+| API endpoint | Direct calls to `api.anthropic.com/v1/messages` | No direct API calls — the binary makes them |
+| Request shape | Spoofed Claude Code's headers, system prompt, tool defs | The real `claude` binary builds the request |
+| Client identity | Client *replacement* impersonating Claude Code | Single local user invoking their own CLI as a child process |
+| Fan-out | Shared service across many accounts | Runs locally with the user's own logged-in CLI |
+
+When PromptPilot calls `claude -p`, Anthropic's server logs see a request from the
+real `claude` binary with the real user-agent and request shape — because
+that's what made the call. The literal token-clause prohibition does not apply.
+
+**What's still interpretive:** the Feb 20 ToS phrase "ordinary use of Claude
+Code" is broader than the token clause. Whether driving `claude -p` from a
+programmatic loop counts as "ordinary use" depends on Anthropic's
+interpretation. Interactive single-shot use is clearly ordinary; high-volume
+batched chain runs are harder to characterize. The risk is much lower than
+the OpenClaw pattern but not zero.
+
+A separate monthly credit pool for Agent SDK / `claude -p` is expected
+**Jun 15, 2026**, which may formalize programmatic subscription use under a
+sanctioned billing model. This note will be updated then.
+
+### On the codex / OpenAI side
+
+`CodexCliJudge` is the symmetric path for users with a ChatGPT subscription
+(`codex login`). Auto-detected after Max OAuth in the priority order
+`max > codex > anthropic > openai`. Same compliance posture as MaxHaikuJudge:
+we invoke the official `codex` binary; the OAuth token stays inside the
+codex process.
+
+Two operational caveats specific to codex:
+1. **Heavier per-call overhead.** ~20k input tokens of subscription quota per
+   call due to the agent-loop spin-up (~6.5k of which are cached) — vs
+   MaxHaikuJudge's lighter `claude -p --model haiku` path. Suitable for
+   light SLM use within quota; not great for high-volume chain experiments.
+2. **Model name follows the codex naming scheme.** ChatGPT-auth codex
+   accepts current-gen names like `gpt-5.4-mini`, `gpt-5.4`, `gpt-5.3-codex`,
+   `gpt-5.2` (and the unspecified default `gpt-5.5`). Legacy names like
+   `gpt-4o-mini` return a 400. The judge defaults to `gpt-5.4-mini` — the
+   smallest SLM-tier model available on ChatGPT-subscription auth. Override
+   via the constructor if you have an `OPENAI_API_KEY` backing codex (no
+   such restriction applies on API-keyed codex).
+
+`OPENAI_API_KEY` remains the supported per-call API path for codex users
+who want predictable, cached, per-token billing — and is the cheapest path
+overall (gpt-5.4-nano at $0.20/M input via SDK vs the ~19k-token subscription
+quota burn per CodexCliJudge call).
+
+## Pick a setup
+
+PromptPilot supports four auth paths. Any one of them works on its own — you do
+**not** need to set up multiple. The list is in rough order of how much setup
+work they involve.
+
+### 1. Max subscription only (Claude users)
+
+```bash
+claude auth login --claudeai
+prpt "fix the flaky test in payments"
+```
+
+No API key, no `.env` editing. SLM routes via `MaxHaikuJudge` (`claude -p
+--model haiku --tools ""` subprocess); LLM routes via `claude` CLI. Both bill
+against your Max subscription quota; zero incremental $.
+
+### 2. ChatGPT subscription only (Codex users)
+
+```bash
+codex login
+prpt --tool codex "fix the flaky test in payments"
+```
+
+SLM routes via `CodexCliJudge` (`codex exec -m gpt-5.4-mini` subprocess); LLM
+routes via `codex` CLI. Both bill against your ChatGPT subscription. Caveat:
+each SLM call consumes ~19k tokens of subscription quota due to codex's
+agent-loop overhead — fine for interactive use, heavy for chain experiments.
+See "Advanced: hybrid" below if this becomes a quota concern.
+
+### 3. API key only
+
+```bash
+echo 'ANTHROPIC_API_KEY=sk-ant-...' >> .env    # Claude users
+# or
+echo 'OPENAI_API_KEY=sk-proj-...' >> .env      # Codex users
+```
+
+Fully supported, fastest per-call (~1-2s SDK round-trips), prompt caching
+active. Bills against API credits per call. Use this if you don't have a
+relevant subscription or want predictable per-call billing.
+
+### 4. Advanced: hybrid auth (API SLM + subscription LLM)
+
+**Optional optimization.** If you have *both* a subscription *and* a
+matching API key, you can route the cheap SLM work through the API and the
+expensive LLM work through the subscription. This is the most
+cost-efficient configuration but requires both auths to be set up.
+
+#### Hybrid for codex / ChatGPT users
+
+```bash
+# .env:
+OPENAI_API_KEY=sk-proj-...
+
+# Plus:
+codex login
+
+# Invocation (the --normalizer slm-openai flag is required to force the SDK path):
+prpt --normalizer slm-openai --tool codex "fix the flaky test in payments"
+```
+
+- **SLM normalizer** → `OPENAI_API_KEY` via SDK + `gpt-5.4-nano` ($0.20/M
+  input, $1.25/M output). Each rewrite call ~$0.0001-0.0003. Fast,
+  prompt-cached.
+- **Downstream agent** → ChatGPT subscription via `codex exec`. Free
+  incremental.
+
+The big win over codex-subscription-for-everything: codex inflates every SLM
+call to ~19k input tokens (agent-loop overhead). At gpt-5.4-mini's $0.75/M
+input rate inside codex that's $0.015 real-$ equivalent / call (or 30% of
+GPT-5.4 quota on the subscription side). The SDK path sends only ~400
+tokens. Same SLM work, ~100× cheaper per call. Plus nano is 3.6–3.75×
+cheaper than mini per token.
+
+#### Hybrid for claude-code / Max users
+
+```bash
+# .env:
+ANTHROPIC_API_KEY=sk-ant-...
+
+# Plus:
+claude auth login --claudeai
+
+# Invocation:
+prpt --normalizer slm-anthropic --tool claude-code "fix the flaky test in payments"
+```
+
+- **SLM normalizer** → `ANTHROPIC_API_KEY` via SDK + Haiku. ~$0.001/call.
+  Fast, prompt-cached.
+- **Downstream agent** → claude-code via Max OAuth subscription. Free
+  incremental.
+
+The gain is smaller than the codex case — `MaxHaikuJudge`'s subprocess uses
+`--tools ""` which strips the agent loop, so it's ~20× more expensive than
+SDK Haiku per call (not 100× like codex). Still a real win: SDK is faster
+(~4s vs ~7s) and prompt caching is active. **Bonus:** moves the SLM layer
+to a fully-supported API path, leaving only the LLM layer in the
+subscription-routing gray zone discussed above.
+
+#### When hybrid is worth setting up
+
+- You're running high-volume work (chain tests, long sessions, batched edits)
+  where per-call overhead compounds
+- You already have an API key from your provider account (often included
+  with codex/ChatGPT or Anthropic developer accounts)
+- You want SLM walltime to stay sub-2-seconds per call
+- You want to reduce subscription-routing surface area (claude case)
+
+#### When standalone subscription is fine
+
+- Light interactive use (a handful of calls per session)
+- You don't want to manage an API key in `.env`
+- Your subscription quota is comfortably larger than your usage
+
+The auto-detect order is **`max > codex > anthropic > openai`** — a fallback
+priority, not a setup requirement. You pick which auth(s) to configure; the
+auto-detect chooses among what's available.
+
+## Usage
+
+```bash
+prpt --dry-run "fix flaky test in payments"
+prpt --normalizer slm --dry-run "refactor auth, no API changes"
+prpt --normalizer slm --tool anthropic "add dark mode"
+prpt --theme dark --dry-run "add dark mode"
+prpt install-hook   # wire into Claude Code as a UserPromptSubmit hook
+```
+
+With `--normalizer slm-openai-v2`, the SLM can route prompts to **clarify**
+(ask a question and exit), **passthrough** (run the raw prompt unmodified),
+or **answer** (respond directly without invoking the agent) instead of the
+default **act** path. See `promptpilot/core/spec.py` for the routing schema.
+
+## Tool-output compression
+
+PromptPilot ships a `PostToolUse` hook that intercepts `Bash` tool responses
+and shrinks them before the LLM sees them. Targets the dominant token-bleed
+in agent sessions: pytest tracebacks, grep floods, deep `find` results,
+verbose `git diff`, linter spew, installer logs. The compressor is
+command-type-aware ([promptpilot/compress/tool_output.py](promptpilot/compress/tool_output.py)).
+
+**Install for Claude Code:**
+
+Add a hooks block to your project-level `.claude/settings.json` (or global
+`~/.claude/settings.json`):
+
+```json
+{
+  "hooks": {
+    "PostToolUse": [{
+      "matcher": "Bash",
+      "hooks": [{
+        "type": "command",
+        "command": "python /path/to/PromptPilot/.claude/hooks/compress_tool_output.py",
+        "timeout": 10
+      }]
+    }]
+  }
+}
+```
+
+**Install for codex:**
+
+codex picks up `.codex/hooks.json` automatically when run inside a PromptPilot
+checkout. No manual wiring needed.
+
+**Telemetry:**
+
+Each compression event is appended to `~/.promptpilot/compress_stats.jsonl`
+(disable with `PROMPTPILOT_COMPRESS_LOG_DISABLE=1`). Surface aggregate stats
+with:
+
+```bash
+prpt stats        # includes "--- Tool-output compression ---" section
+```
+
+**Kill switch:**
+
+```bash
+PROMPTPILOT_COMPRESS_DISABLE=1 claude   # bypass compression for this session
+```
+
+## License
+
+PromptPilot is licensed under the [Apache License 2.0](LICENSE).
+
+PromptPilot wraps multiple LLM vendors' tools (Claude, Codex, OpenAI) in an
+area where patent claims are unsettled, and the explicit patent grant in
+Apache §3 protects both users and contributors. It keeps every permissive
+freedom MIT offers (commercial use, modification, redistribution) and adds a
+patent grant plus a termination clause that discourages frivolous patent
+litigation. For a control-plane tool meant to slot into other people's
+production setups, that protection felt like the wrong corner to cut.
+
+### License FAQ
+
+**Why not MIT?**
+MIT is simpler and works for most projects, but has no patent provision.
+Apache 2.0 explicitly grants patent rights from every contributor (§3) and
+terminates the license for anyone who sues for patent infringement — useful
+insurance when the legal landscape around LLM tooling is still moving.
+
+**Can I use this commercially?**
+Yes. Commercial use, modification, private use, and redistribution are all
+allowed. No royalties, no copyleft. You don't owe anything back.
+
+**What are my obligations if I redistribute it?**
+Keep the `LICENSE` file with the copy, note any files you modified, and
+preserve the `NOTICE` file's contents (when one exists). That's it. No
+share-alike requirement.
+
+**Can I fork and rename?**
+Yes, but you can't use "PromptPilot" or related marks to imply your fork is
+the official project (§6 trademark clause). Pick a new name for
+substantially-changed forks.
+
+Contributions are accepted under the same license per Apache 2.0 §5 — by
+opening a PR you agree your work is contributed under Apache 2.0 unless
+explicitly stated otherwise.