prompt-optimizer-tool 0.1.0__tar.gz

prompt_optimizer_tool-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 khadar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

prompt_optimizer_tool-0.1.0/PKG-INFO

@@ -0,0 +1,298 @@
+Metadata-Version: 2.4
+Name: prompt-optimizer-tool
+Version: 0.1.0
+Summary: CLI tool that grades prompts 0-100 against 10 engineering principles and rewrites them, powered by Groq
+Author-email: khadar <khadarbashajilan001@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/khadarbashajilan/prompt-optimizer-tool
+Project-URL: Issues, https://github.com/khadarbashajilan/prompt-optimizer-tool/issues
+Keywords: prompt,prompt-engineering,llm,groq,langchain,cli
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: langchain-groq>=1.1.0
+Requires-Dist: langchain-core>=0.3.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Dynamic: license-file
+
+# Prompt Optimizer
+
+A CLI tool that **analyzes and rewrites prompts** following established prompt engineering best practices. Powered by **LangChain** + **Groq** (free tier, no credit card).
+
+## Why I Built This
+
+Prompt engineering is no longer about trial and error — it's a discipline with repeatable patterns (role definition, output contracts, chain-of-thought, constraints). Most developers still write vague, unstructured prompts that leave LLMs guessing. This tool automates the optimization cycle:
+
+1. **Analyze** — identify exactly what's wrong with a prompt against 10 principles
+2. **Structure** — rewrite it with role, objective, context, step-by-step instructions, constraints, and output format
+3. **Iterate** — test the optimized prompt, refine, and repeat
+
+The goal is to make production-quality prompting accessible from the terminal.
+
+## Architecture
+
+```
+                    ┌──────────────┐
+                    │  principles  │  10 rules + both system prompts
+                    │     .py      │  (generated from one table)
+                    └──────┬───────┘
+                           │
+   ┌───────────┐   ┌───────┴────────┐   ┌────────────┐   ┌──────────┐
+   │  cli.py   │──▶│  analyzer.py   │──▶│   llm.py   │──▶│  Groq    │
+   │ Click+Rich│   │  optimizer.py │   │ ChatGroq + │   │  API     │
+   └─────┬─────┘   └───────┬────────┘   │ structured │   └──────────┘
+         │                 │            │  output    │
+         │            ┌────┴─────┐      └─────┬──────┘
+         │            │ schemas  │            │
+         │            │  .py     │      ┌─────┴──────┐
+         │            │ Pydantic │      │ config.py  │
+         │            └──────────┘      │ settings  │
+         │                              │  + API key│
+         ▼                              └────────────┘
+   ┌──────────┐
+   │ storage  │  one timestamped file per run, into saved/
+   │   .py    │
+   └──────────┘
+```
+
+| Module | Role |
+|---|---|
+| `cli.py` | Click entry point, Rich rendering, input gathering (arg / `--file` / stdin) |
+| `analyzer.py` | Step 1 — prompt + grading instructions → `PromptAnalysis` |
+| `optimizer.py` | Step 2 — prompt + analysis + rewrite instructions → `OptimizedPrompt` |
+| `principles.py` | The 10 rules as one table; both system prompts are generated from it |
+| `schemas.py` | Pydantic contracts: `PromptWeakness`, `PromptAnalysis`, `OptimizedPrompt` |
+| `llm.py` | The only module that knows how to talk to Groq |
+| `config.py` | Every setting in one place, each overridable by env var |
+| `storage.py` | Builds a timestamped path per run and writes it |
+| `run.sh` | Bootstraps the venv, checks the API key, then offers an interactive menu |
+
+Dependencies point one way only: `cli` → `analyzer`/`optimizer` → `llm` → `config`.
+`principles` and `schemas` sit at the bottom with no internal dependencies, so
+either step can be swapped, retried, or tested without touching the other.
+
+### Workflow
+
+```
+User Prompt ──▶ Analyze ──▶ Quality Score (0-100)
+                    │           + Strengths
+                    │           + Weaknesses (with severity & suggestions)
+                    ▼
+               Optimize ──▶ Structured Prompt
+                               + Role / Objective / Context
+                               + Step-by-Step Instructions
+                               + Constraints & Rules
+                               + Output Format
+                               + Success Criteria
+                               + Changes Made Summary
+                               + Principles Applied List
+```
+
+### The 10 Principles
+
+Defined once in `principles.py` and reused everywhere:
+
+1. **Role & Persona Definition** — assign expertise level and perspective
+2. **Clear Objective** — one-sentence goal statement
+3. **Context Provision** — background, audience, environment
+4. **Step-by-Step Instructions** — sequential breakdown of complex tasks
+5. **Constraints & Rules** — boundaries, exclusions, length limits
+6. **Output Format Specification** — JSON, markdown, bullet points, etc.
+7. **Few-Shot Examples** — demonstrate desired pattern with examples
+8. **Chain of Thought** — request reasoning for multi-step problems
+9. **Success Criteria** — define measurable quality bar
+10. **Specific Language** — replace vague qualifiers with precise terms
+
+## Tech Stack
+
+| Technology | Where Used | Purpose |
+|---|---|---|
+| **Groq** (`openai/gpt-oss-20b`) | `src/llm.py:35` | Powers both LLM calls via `ChatGroq`. Free tier, no credit card required |
+| **LangChain** (`ChatGroq`, `ChatPromptTemplate`) | `src/llm.py:61`, `src/analyzer.py:30`, `src/optimizer.py:31` | Provider abstraction, prompt templates, chain composition with LCEL |
+| **Structured Outputs** (`with_structured_output`) | `src/llm.py:61` | Groq's `json_schema` mode in **strict** mode uses constrained decoding, so every response matches the Pydantic schema — no JSON parse errors, and `Literal` fields can only return declared values |
+| **Pydantic v2** (`BaseModel`, `Field`) | `schemas.py:19-56` | Data contracts for `PromptWeakness`, `PromptAnalysis`, `OptimizedPrompt` — validation + serialization |
+| **Click** (`@click.group`, `@click.command`, `@click.option`) | `src/cli.py:233-270` | CLI framework with composable commands, argument parsing, and auto-generated `--help` |
+| **Rich** (`Console`, `Panel`, `Table`, `Markdown`, `Columns`) | `src/cli.py:53-137` | Terminal UI — color-coded score panels, weakness tables, markdown rendering, status spinners |
+| **python-dotenv** (`load_dotenv`) | `src/config.py:15` | Auto-loads `GROQ_API_KEY` from `.env` file — no manual config flags |
+| **pytest** (offline suite) | `tests/` | ~43 cases, no API key or network needed: CLI flow via `CliRunner`, the LLM seam with a fake provider, schemas, principles, config, storage |
+| **uv** | `pyproject.toml` | Package manager — single `uv sync` installs deps, builds package, registers CLI entry point |
+| **Python 3.12** | `.python-version`, `pyproject.toml` | Type hints (`list[str]`, `dict[str, str]`), `str.removeprefix`/`removesuffix` |
+
+## Installation
+
+Published on PyPI as [`prompt-optimizer-tool`](https://pypi.org/project/prompt-optimizer-tool/).
+
+```bash
+# Try it instantly, nothing is installed
+uvx --from prompt-optimizer-tool prompt-optimizer list
+
+# Install as an isolated tool (recommended)
+uv tool install prompt-optimizer-tool
+
+# or with pipx
+pipx install prompt-optimizer-tool
+```
+
+### Set your Groq API key (free, no credit card: https://console.groq.com/keys)
+
+```bash
+export GROQ_API_KEY=gsk_your-key-here
+prompt-optimizer optimize "write code in python to fetch api data"
+```
+
+### Install from source (alternative)
+
+```bash
+git clone https://github.com/khadarbashajilan/prompt-optimizer-tool.git
+cd prompt-optimizer-tool
+cp .env.example .env   # then edit .env: GROQ_API_KEY=gsk_your-key-here
+./run.sh
+```
+
+### Quick start
+
+```bash
+# Interactive menu — the easiest way in
+./run.sh
+
+# Or pass arguments straight through to the CLI
+./run.sh optimize "write code in python to fetch api data"
+./run.sh optimize --file prompt.txt
+./run.sh list
+```
+
+`./run.sh` with no arguments opens a menu: optimize a pasted prompt, optimize
+a file, list the 10 principles, show help, or quit. It verifies
+`GROQ_API_KEY` is set and creates the virtualenv on first run.
+
+## Usage
+
+```bash
+# Basic — analyze + optimize a prompt
+uv run prompt-optimizer optimize "write code in python to fetch api data"
+
+# Read from file
+uv run prompt-optimizer optimize --file prompt.txt
+
+# Pipe from stdin
+echo "explain quantum computing to a 5 year old" | uv run prompt-optimizer optimize
+
+# Each run is auto-saved to its own timestamped file in saved/
+uv run prompt-optimizer optimize "write a blog post"
+#   → saved/optimized-20260927-143205.md
+
+# Choose a different output folder
+uv run prompt-optimizer optimize "write a blog post" --out ~/prompts
+
+# List all 10 prompting principles
+uv run prompt-optimizer list
+```
+
+### Configuration
+
+Every setting has a default and can be overridden with an environment
+variable, so none of them require a code change:
+
+| Variable | Default | Means |
+|---|---|---|
+| `GROQ_API_KEY` | *(required)* | Authorises the calls. Read from `.env` |
+| `PROMPT_OPTIMIZER_MODEL` | `openai/gpt-oss-20b` | Which Groq model to use |
+| `PROMPT_OPTIMIZER_TEMPERATURE` | `0.6` | Higher means more varied wording |
+| `PROMPT_OPTIMIZER_MAX_TOKENS` | `4096` | Reply ceiling; lower values truncate long rewrites |
+| `PROMPT_OPTIMIZER_MAX_RETRIES` | `3` | Attempts per call, handles free-tier rate limits |
+| `PROMPT_OPTIMIZER_TIMEOUT` | `60` | Per-request seconds, so a stalled call cannot hang |
+| `PROMPT_OPTIMIZER_OUTPUT_DIR` | `saved` | Default folder for saved rewrites |
+
+### Example Output
+
+The tool produces a structured report:
+
+- **Quality Score** — color-coded (green ≥70, yellow ≥40, red <40)
+- **Strengths** — what the original prompt does well
+- **Weaknesses & Improvements** — each issue with severity, violated principle, and concrete fix
+- **Changes Made** — summary of all improvements applied
+- **Optimized Prompt** — the complete rewritten prompt (copy-ready)
+- **Principles Applied** — which of the 10 principles were used
+- **Auto-save** — every run writes its own file to `saved/`, named for the date and time of the run, so results accumulate instead of overwriting
+
+## Limitations and Roadmap
+
+What this tool does **not** do yet, so expectations are clear:
+
+| Limitation | Current behavior | Fix |
+|---|---|---|
+| **No logging** | Errors print to the terminal only; no debug trail | Add structured logging (log file + `--debug` flag) |
+| **No caching** | Analyze + Optimize each hit the API on every run | Cache analyses by prompt hash to avoid repeat cost |
+| **No live-model tests** | The ~43 offline tests fake the provider seam only; real Groq structured-output calls are verified by hand | Add an opt-in integration test with a real key |
+| **No model fallback** | If the configured model is unavailable the run fails after retries | Add a second model to fall back to |
+| **Console only** | No way to diff a rewrite against its previous version | Add `--diff <file>` to compare two saved runs |
+| **No CI** | Checks only run locally | Add a GitHub Actions workflow |
+
+Planned next: logging, and an opt-in live-model integration test.
+
+## Key Design Decisions
+
+- **Structured Outputs in strict mode** — using `with_structured_output(Model, method="json_schema", strict=True)`. Groq's strict mode uses constrained decoding, so the response is guaranteed to match the Pydantic schema. Tool calling would be the alternative, but Groq does not support tool use together with Structured Outputs, and strict mode is the stronger guarantee.
+- **Constrained decoding doubles as validation** — because the decoder can only emit declared values, `Literal` fields (`severity`, `principle`, `principles_applied`) cannot come back as typos or invented names. This is what guarantees the "Principles Applied" panel can always resolve a principle, instead of silently rendering nothing when the model returns a name rather than a key.
+- **Closed schemas only** — strict mode requires every field to be required and every object to set `additionalProperties: false`. A free-form `dict[str, str]` collapses to an always-empty object under those rules, so `sections` is a `list[PromptSection]` (explicit `name` + `content`) instead.
+- **Model choice: `openai/gpt-oss-20b`** — free tier, ~1000 tokens/sec, and one of only three models supporting strict-mode Structured Outputs. The old `llama-3.x` ids are Enterprise-only now, so they are not free.
+- **`temperature=0.6`** — Groq recommends 0.5–0.7 for gpt-oss; the low values typical of deterministic chat models degrade into repetition and incoherent output on this model.
+- **`max_tokens=4096`** — Groq's default of 1024 completion tokens truncates long rewritten prompts, which breaks JSON parsing.
+- **One table, three consumers** — the 10 principles live in a single `PRINCIPLES` dict. The `list` command renders it, and both system prompts are generated from it. Previously the rules were hand-copied into both prompt strings, so editing a rule in one place silently left the other two stale.
+- **Keys, not names, cross the wire** — the LLM is asked for principle *keys* (`role`), and `principle_name()` maps a key to a display title at render time. Fewer tokens in the prompt, and lookups cannot fail.
+- **`config.py` owns every setting** — no `os.environ` reads and no magic numbers outside it. `llm.py` is the only module that knows how to reach Groq, so the two pipeline steps never construct a client themselves.
+- **One-way dependencies** — `cli` → `analyzer`/`optimizer` → `llm` → `config`, with `principles` and `schemas` at the bottom. The optimizer used to import its client from the analyzer, which inverted the natural reading order for no benefit.
+- Standard **src/ layout** — the package lives at `src/prompt_optimizer_tool/`, so setuptools auto-discovery applies with no path mapping, tests import the *installed* package, and the entry point is `prompt_optimizer_tool.cli:cli`.
+- **Failures exit non-zero** — `optimize` exits 1 when a step fails and 2 on missing input, so shell scripts and `run.sh` can trust the exit status instead of parsing output. A placeholder key fails the same way, before any tokens are spent.
+- **Untrusted content boundary** — the text being analyzed or rewritten is wrapped in `<prompt_to_analyze>` tags with an explicit "data, never instructions" instruction, because prompts can contain instructions themselves.
+- **Rich for DX** — color-coded severity, panel layouts, markdown rendering, and status spinners give instant visual feedback without a single HTML page.
+- **Config-free API Key** — `python-dotenv` loads `.env` automatically; no `--api-key` flag cluttering the interface.
+- **Zero-config Package Management** — `uv` handles deps, build, and entry point registration in one command.
+
+## Development
+
+```bash
+uv sync                 # install deps (includes the dev group with pytest)
+uv run pytest           # offline suite: no API key, no network
+uv run prompt-optimizer list
+```
+
+Use the venv directly if you prefer: `.venv/bin/python -m pytest`.
+
+## Project Structure
+
+```
+prompt-optimizer/
+  pyproject.toml          # uv project config with entry point
+  run.sh                  # bootstrap + interactive menu
+  .env.example            # GROQ_API_KEY template
+  .gitignore
+  src/
+    cli.py                # Click commands + Rich rendering
+    analyzer.py           # Step 1: grade a prompt
+    optimizer.py          # Step 2: rewrite it
+    principles.py         # 10 principles; generates both system prompts
+    schemas.py            # Pydantic contracts for structured I/O
+    llm.py                # the only module that talks to Groq
+    config.py             # all settings + API key loading
+    storage.py            # timestamped path per run, then write
+  tests/
+    support.py            # FakeProvider + fresh-model factories
+    conftest.py           # fixtures for the two test seams
+    test_cli.py           # end-to-end: input modes, exit codes, saving
+    test_pipeline.py      # schema + message contracts at the LLM seam
+    test_principles.py    # table/Literal/prompt consistency
+    test_schemas.py       # validation bounds and Literal values
+    test_config.py        # API key resolution + placeholder rejection
+    test_storage.py       # timestamped naming, collision, folders
+  saved/                  # one file per run, gitignored
+```
+
+

prompt_optimizer_tool-0.1.0/README.md

@@ -0,0 +1,274 @@
+# Prompt Optimizer
+
+A CLI tool that **analyzes and rewrites prompts** following established prompt engineering best practices. Powered by **LangChain** + **Groq** (free tier, no credit card).
+
+## Why I Built This
+
+Prompt engineering is no longer about trial and error — it's a discipline with repeatable patterns (role definition, output contracts, chain-of-thought, constraints). Most developers still write vague, unstructured prompts that leave LLMs guessing. This tool automates the optimization cycle:
+
+1. **Analyze** — identify exactly what's wrong with a prompt against 10 principles
+2. **Structure** — rewrite it with role, objective, context, step-by-step instructions, constraints, and output format
+3. **Iterate** — test the optimized prompt, refine, and repeat
+
+The goal is to make production-quality prompting accessible from the terminal.
+
+## Architecture
+
+```
+                    ┌──────────────┐
+                    │  principles  │  10 rules + both system prompts
+                    │     .py      │  (generated from one table)
+                    └──────┬───────┘
+                           │
+   ┌───────────┐   ┌───────┴────────┐   ┌────────────┐   ┌──────────┐
+   │  cli.py   │──▶│  analyzer.py   │──▶│   llm.py   │──▶│  Groq    │
+   │ Click+Rich│   │  optimizer.py │   │ ChatGroq + │   │  API     │
+   └─────┬─────┘   └───────┬────────┘   │ structured │   └──────────┘
+         │                 │            │  output    │
+         │            ┌────┴─────┐      └─────┬──────┘
+         │            │ schemas  │            │
+         │            │  .py     │      ┌─────┴──────┐
+         │            │ Pydantic │      │ config.py  │
+         │            └──────────┘      │ settings  │
+         │                              │  + API key│
+         ▼                              └────────────┘
+   ┌──────────┐
+   │ storage  │  one timestamped file per run, into saved/
+   │   .py    │
+   └──────────┘
+```
+
+| Module | Role |
+|---|---|
+| `cli.py` | Click entry point, Rich rendering, input gathering (arg / `--file` / stdin) |
+| `analyzer.py` | Step 1 — prompt + grading instructions → `PromptAnalysis` |
+| `optimizer.py` | Step 2 — prompt + analysis + rewrite instructions → `OptimizedPrompt` |
+| `principles.py` | The 10 rules as one table; both system prompts are generated from it |
+| `schemas.py` | Pydantic contracts: `PromptWeakness`, `PromptAnalysis`, `OptimizedPrompt` |
+| `llm.py` | The only module that knows how to talk to Groq |
+| `config.py` | Every setting in one place, each overridable by env var |
+| `storage.py` | Builds a timestamped path per run and writes it |
+| `run.sh` | Bootstraps the venv, checks the API key, then offers an interactive menu |
+
+Dependencies point one way only: `cli` → `analyzer`/`optimizer` → `llm` → `config`.
+`principles` and `schemas` sit at the bottom with no internal dependencies, so
+either step can be swapped, retried, or tested without touching the other.
+
+### Workflow
+
+```
+User Prompt ──▶ Analyze ──▶ Quality Score (0-100)
+                    │           + Strengths
+                    │           + Weaknesses (with severity & suggestions)
+                    ▼
+               Optimize ──▶ Structured Prompt
+                               + Role / Objective / Context
+                               + Step-by-Step Instructions
+                               + Constraints & Rules
+                               + Output Format
+                               + Success Criteria
+                               + Changes Made Summary
+                               + Principles Applied List
+```
+
+### The 10 Principles
+
+Defined once in `principles.py` and reused everywhere:
+
+1. **Role & Persona Definition** — assign expertise level and perspective
+2. **Clear Objective** — one-sentence goal statement
+3. **Context Provision** — background, audience, environment
+4. **Step-by-Step Instructions** — sequential breakdown of complex tasks
+5. **Constraints & Rules** — boundaries, exclusions, length limits
+6. **Output Format Specification** — JSON, markdown, bullet points, etc.
+7. **Few-Shot Examples** — demonstrate desired pattern with examples
+8. **Chain of Thought** — request reasoning for multi-step problems
+9. **Success Criteria** — define measurable quality bar
+10. **Specific Language** — replace vague qualifiers with precise terms
+
+## Tech Stack
+
+| Technology | Where Used | Purpose |
+|---|---|---|
+| **Groq** (`openai/gpt-oss-20b`) | `src/llm.py:35` | Powers both LLM calls via `ChatGroq`. Free tier, no credit card required |
+| **LangChain** (`ChatGroq`, `ChatPromptTemplate`) | `src/llm.py:61`, `src/analyzer.py:30`, `src/optimizer.py:31` | Provider abstraction, prompt templates, chain composition with LCEL |
+| **Structured Outputs** (`with_structured_output`) | `src/llm.py:61` | Groq's `json_schema` mode in **strict** mode uses constrained decoding, so every response matches the Pydantic schema — no JSON parse errors, and `Literal` fields can only return declared values |
+| **Pydantic v2** (`BaseModel`, `Field`) | `schemas.py:19-56` | Data contracts for `PromptWeakness`, `PromptAnalysis`, `OptimizedPrompt` — validation + serialization |
+| **Click** (`@click.group`, `@click.command`, `@click.option`) | `src/cli.py:233-270` | CLI framework with composable commands, argument parsing, and auto-generated `--help` |
+| **Rich** (`Console`, `Panel`, `Table`, `Markdown`, `Columns`) | `src/cli.py:53-137` | Terminal UI — color-coded score panels, weakness tables, markdown rendering, status spinners |
+| **python-dotenv** (`load_dotenv`) | `src/config.py:15` | Auto-loads `GROQ_API_KEY` from `.env` file — no manual config flags |
+| **pytest** (offline suite) | `tests/` | ~43 cases, no API key or network needed: CLI flow via `CliRunner`, the LLM seam with a fake provider, schemas, principles, config, storage |
+| **uv** | `pyproject.toml` | Package manager — single `uv sync` installs deps, builds package, registers CLI entry point |
+| **Python 3.12** | `.python-version`, `pyproject.toml` | Type hints (`list[str]`, `dict[str, str]`), `str.removeprefix`/`removesuffix` |
+
+## Installation
+
+Published on PyPI as [`prompt-optimizer-tool`](https://pypi.org/project/prompt-optimizer-tool/).
+
+```bash
+# Try it instantly, nothing is installed
+uvx --from prompt-optimizer-tool prompt-optimizer list
+
+# Install as an isolated tool (recommended)
+uv tool install prompt-optimizer-tool
+
+# or with pipx
+pipx install prompt-optimizer-tool
+```
+
+### Set your Groq API key (free, no credit card: https://console.groq.com/keys)
+
+```bash
+export GROQ_API_KEY=gsk_your-key-here
+prompt-optimizer optimize "write code in python to fetch api data"
+```
+
+### Install from source (alternative)
+
+```bash
+git clone https://github.com/khadarbashajilan/prompt-optimizer-tool.git
+cd prompt-optimizer-tool
+cp .env.example .env   # then edit .env: GROQ_API_KEY=gsk_your-key-here
+./run.sh
+```
+
+### Quick start
+
+```bash
+# Interactive menu — the easiest way in
+./run.sh
+
+# Or pass arguments straight through to the CLI
+./run.sh optimize "write code in python to fetch api data"
+./run.sh optimize --file prompt.txt
+./run.sh list
+```
+
+`./run.sh` with no arguments opens a menu: optimize a pasted prompt, optimize
+a file, list the 10 principles, show help, or quit. It verifies
+`GROQ_API_KEY` is set and creates the virtualenv on first run.
+
+## Usage
+
+```bash
+# Basic — analyze + optimize a prompt
+uv run prompt-optimizer optimize "write code in python to fetch api data"
+
+# Read from file
+uv run prompt-optimizer optimize --file prompt.txt
+
+# Pipe from stdin
+echo "explain quantum computing to a 5 year old" | uv run prompt-optimizer optimize
+
+# Each run is auto-saved to its own timestamped file in saved/
+uv run prompt-optimizer optimize "write a blog post"
+#   → saved/optimized-20260927-143205.md
+
+# Choose a different output folder
+uv run prompt-optimizer optimize "write a blog post" --out ~/prompts
+
+# List all 10 prompting principles
+uv run prompt-optimizer list
+```
+
+### Configuration
+
+Every setting has a default and can be overridden with an environment
+variable, so none of them require a code change:
+
+| Variable | Default | Means |
+|---|---|---|
+| `GROQ_API_KEY` | *(required)* | Authorises the calls. Read from `.env` |
+| `PROMPT_OPTIMIZER_MODEL` | `openai/gpt-oss-20b` | Which Groq model to use |
+| `PROMPT_OPTIMIZER_TEMPERATURE` | `0.6` | Higher means more varied wording |
+| `PROMPT_OPTIMIZER_MAX_TOKENS` | `4096` | Reply ceiling; lower values truncate long rewrites |
+| `PROMPT_OPTIMIZER_MAX_RETRIES` | `3` | Attempts per call, handles free-tier rate limits |
+| `PROMPT_OPTIMIZER_TIMEOUT` | `60` | Per-request seconds, so a stalled call cannot hang |
+| `PROMPT_OPTIMIZER_OUTPUT_DIR` | `saved` | Default folder for saved rewrites |
+
+### Example Output
+
+The tool produces a structured report:
+
+- **Quality Score** — color-coded (green ≥70, yellow ≥40, red <40)
+- **Strengths** — what the original prompt does well
+- **Weaknesses & Improvements** — each issue with severity, violated principle, and concrete fix
+- **Changes Made** — summary of all improvements applied
+- **Optimized Prompt** — the complete rewritten prompt (copy-ready)
+- **Principles Applied** — which of the 10 principles were used
+- **Auto-save** — every run writes its own file to `saved/`, named for the date and time of the run, so results accumulate instead of overwriting
+
+## Limitations and Roadmap
+
+What this tool does **not** do yet, so expectations are clear:
+
+| Limitation | Current behavior | Fix |
+|---|---|---|
+| **No logging** | Errors print to the terminal only; no debug trail | Add structured logging (log file + `--debug` flag) |
+| **No caching** | Analyze + Optimize each hit the API on every run | Cache analyses by prompt hash to avoid repeat cost |
+| **No live-model tests** | The ~43 offline tests fake the provider seam only; real Groq structured-output calls are verified by hand | Add an opt-in integration test with a real key |
+| **No model fallback** | If the configured model is unavailable the run fails after retries | Add a second model to fall back to |
+| **Console only** | No way to diff a rewrite against its previous version | Add `--diff <file>` to compare two saved runs |
+| **No CI** | Checks only run locally | Add a GitHub Actions workflow |
+
+Planned next: logging, and an opt-in live-model integration test.
+
+## Key Design Decisions
+
+- **Structured Outputs in strict mode** — using `with_structured_output(Model, method="json_schema", strict=True)`. Groq's strict mode uses constrained decoding, so the response is guaranteed to match the Pydantic schema. Tool calling would be the alternative, but Groq does not support tool use together with Structured Outputs, and strict mode is the stronger guarantee.
+- **Constrained decoding doubles as validation** — because the decoder can only emit declared values, `Literal` fields (`severity`, `principle`, `principles_applied`) cannot come back as typos or invented names. This is what guarantees the "Principles Applied" panel can always resolve a principle, instead of silently rendering nothing when the model returns a name rather than a key.
+- **Closed schemas only** — strict mode requires every field to be required and every object to set `additionalProperties: false`. A free-form `dict[str, str]` collapses to an always-empty object under those rules, so `sections` is a `list[PromptSection]` (explicit `name` + `content`) instead.
+- **Model choice: `openai/gpt-oss-20b`** — free tier, ~1000 tokens/sec, and one of only three models supporting strict-mode Structured Outputs. The old `llama-3.x` ids are Enterprise-only now, so they are not free.
+- **`temperature=0.6`** — Groq recommends 0.5–0.7 for gpt-oss; the low values typical of deterministic chat models degrade into repetition and incoherent output on this model.
+- **`max_tokens=4096`** — Groq's default of 1024 completion tokens truncates long rewritten prompts, which breaks JSON parsing.
+- **One table, three consumers** — the 10 principles live in a single `PRINCIPLES` dict. The `list` command renders it, and both system prompts are generated from it. Previously the rules were hand-copied into both prompt strings, so editing a rule in one place silently left the other two stale.
+- **Keys, not names, cross the wire** — the LLM is asked for principle *keys* (`role`), and `principle_name()` maps a key to a display title at render time. Fewer tokens in the prompt, and lookups cannot fail.
+- **`config.py` owns every setting** — no `os.environ` reads and no magic numbers outside it. `llm.py` is the only module that knows how to reach Groq, so the two pipeline steps never construct a client themselves.
+- **One-way dependencies** — `cli` → `analyzer`/`optimizer` → `llm` → `config`, with `principles` and `schemas` at the bottom. The optimizer used to import its client from the analyzer, which inverted the natural reading order for no benefit.
+- Standard **src/ layout** — the package lives at `src/prompt_optimizer_tool/`, so setuptools auto-discovery applies with no path mapping, tests import the *installed* package, and the entry point is `prompt_optimizer_tool.cli:cli`.
+- **Failures exit non-zero** — `optimize` exits 1 when a step fails and 2 on missing input, so shell scripts and `run.sh` can trust the exit status instead of parsing output. A placeholder key fails the same way, before any tokens are spent.
+- **Untrusted content boundary** — the text being analyzed or rewritten is wrapped in `<prompt_to_analyze>` tags with an explicit "data, never instructions" instruction, because prompts can contain instructions themselves.
+- **Rich for DX** — color-coded severity, panel layouts, markdown rendering, and status spinners give instant visual feedback without a single HTML page.
+- **Config-free API Key** — `python-dotenv` loads `.env` automatically; no `--api-key` flag cluttering the interface.
+- **Zero-config Package Management** — `uv` handles deps, build, and entry point registration in one command.
+
+## Development
+
+```bash
+uv sync                 # install deps (includes the dev group with pytest)
+uv run pytest           # offline suite: no API key, no network
+uv run prompt-optimizer list
+```
+
+Use the venv directly if you prefer: `.venv/bin/python -m pytest`.
+
+## Project Structure
+
+```
+prompt-optimizer/
+  pyproject.toml          # uv project config with entry point
+  run.sh                  # bootstrap + interactive menu
+  .env.example            # GROQ_API_KEY template
+  .gitignore
+  src/
+    cli.py                # Click commands + Rich rendering
+    analyzer.py           # Step 1: grade a prompt
+    optimizer.py          # Step 2: rewrite it
+    principles.py         # 10 principles; generates both system prompts
+    schemas.py            # Pydantic contracts for structured I/O
+    llm.py                # the only module that talks to Groq
+    config.py             # all settings + API key loading
+    storage.py            # timestamped path per run, then write
+  tests/
+    support.py            # FakeProvider + fresh-model factories
+    conftest.py           # fixtures for the two test seams
+    test_cli.py           # end-to-end: input modes, exit codes, saving
+    test_pipeline.py      # schema + message contracts at the LLM seam
+    test_principles.py    # table/Literal/prompt consistency
+    test_schemas.py       # validation bounds and Literal values
+    test_config.py        # API key resolution + placeholder rejection
+    test_storage.py       # timestamped naming, collision, folders
+  saved/                  # one file per run, gitignored
+```
+
+

prompt_optimizer_tool-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[tool.uv]
+package = true
+
+[build-system]
+requires = ["setuptools>=75.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "prompt-optimizer-tool"
+version = "0.1.0"
+description = "CLI tool that grades prompts 0-100 against 10 engineering principles and rewrites them, powered by Groq"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "khadar", email = "khadarbashajilan001@gmail.com" }]
+requires-python = ">=3.12"
+keywords = ["prompt", "prompt-engineering", "llm", "groq", "langchain", "cli"]
+classifiers = [
+    "Environment :: Console",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development",
+]
+dependencies = [
+    "langchain-groq>=1.1.0",
+    "langchain-core>=0.3.0",
+    "rich>=13.0.0",
+    "click>=8.0.0",
+    "python-dotenv>=1.0.0",
+    "pydantic>=2.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/khadarbashajilan/prompt-optimizer-tool"
+Issues = "https://github.com/khadarbashajilan/prompt-optimizer-tool/issues"
+
+[project.scripts]
+prompt-optimizer = "prompt_optimizer_tool.cli:cli"
+
+[dependency-groups]
+dev = ["pytest>=8.0.0", "pytest-cov>=6.0.0"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["tests"]
+addopts = "-ra --strict-markers --strict-config"
+

prompt_optimizer_tool-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

prompt_optimizer_tool-0.1.0/src/prompt_optimizer_tool/__init__.py

@@ -0,0 +1,17 @@
+"""Analyze and rewrite prompts against ten prompt engineering principles.
+
+Import layering, which the module structure mirrors:
+
+    cli  ->  analyzer, optimizer  ->  llm  ->  config
+                  |
+                  +-> principles, schemas   (no internal dependencies)
+
+Dependencies point one way only. `principles` and `schemas` sit at the
+bottom and import nothing from the rest of the package, so either pipeline
+step can be swapped, retried, or tested without touching the other.
+
+This module deliberately has no side effects: it must stay importable
+without a configured API key, and importing it must not load .env.
+"""
+
+__version__ = "0.1.0"