contextforllm 0.1.0__tar.gz

contextforllm-0.1.0/LICENSE

@@ -0,0 +1,20 @@
+
+Copyright (c) 2025 Desai
+
+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.

contextforllm-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: contextforllm
+Version: 0.1.0
+Summary: Local web UI for generating LLM-ready context from any codebase
+License: 
+        Copyright (c) 2025 Desai
+        
+        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.
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flask
+Requires-Dist: tiktoken
+Requires-Dist: groq
+Dynamic: license-file
+
+# ContextForLLM
+
+A local web UI that scans any project folder on your machine, lets you select and annotate files, and generates a structured prompt you can paste directly into any LLM chat — Claude, ChatGPT, Gemini, or any other.
+
+---
+
+
+## Why this exists
+
+Every other tool in this space is a CLI that dumps your entire repo into one file. ContextForLLM gives you a browser UI where you can:
+
+- Toggle individual files in or out
+- Add a note to any file that gets embedded into the prompt
+- Generate an AI summary of your project using Groq
+- Automatically split large projects into sequenced prompt parts
+- Set your task so the LLM knows exactly what to do
+
+---
+
+## Demo
+
+> Screenshot / GIF coming soon
+
+---
+
+## Installation
+
+You need Python 3.8 or higher installed.
+
+**Step 1 — Clone the repo**
+```bash
+git clone https://github.com/Desai-23/ContextForLLM.git
+cd ContextForLLM
+```
+
+**Step 2 — Install dependencies**
+```bash
+pip install -r requirements.txt
+```
+
+**Step 3 — Run the app**
+```bash
+python app.py
+```
+
+Then open your browser at:
+```
+http://localhost:5000
+```
+
+---
+
+## How to use it
+
+1. Paste the path to any project folder on your machine
+2. Click Scan
+3. Review the files — toggle any file off to exclude it from the prompt
+4. Add annotations to files if needed (the LLM will see these notes)
+5. Optionally generate an AI summary of your project using Groq
+6. Set your task — what you want the LLM to do
+7. Click Generate Context Prompt
+8. Copy the prompt and paste it into any LLM chat
+
+---
+
+## Features
+
+- Local — your code never leaves your machine
+- Browser UI — no terminal required after launch
+- Per-file exclusion — toggle files in or out with a switch
+- Per-file annotations — add notes that get embedded into the prompt
+- Token counter — live token count with a visual usage bar
+- Prompt splitting — large projects automatically split into sequenced parts with handoff instructions
+- AI project summary — uses Groq to generate a project summary injected at the top of every prompt
+- .contextignore support — create a .contextignore file in any project to permanently exclude files
+
+---
+
+## .contextignore
+
+Create a `.contextignore` file in any project folder to exclude files automatically on scan. Uses the same pattern syntax as `.gitignore`.
+
+Example:
+```
+*.test.js
+migrations/
+old_auth.py
+```
+
+---
+
+## Groq API key
+
+The AI summary feature requires a free Groq API key.
+
+1. Get a free key at console.groq.com
+2. Click "Add Groq Key" in the top right of the UI
+3. Paste your key — it is held in memory only and never saved to disk
+
+---
+
+## Tech stack
+
+- Python / Flask — backend server
+- Vanilla HTML, CSS, JS — frontend UI
+- tiktoken — token counting
+- Groq — AI project summary (optional)
+
+---
+
+## License
+
+MIT

contextforllm-0.1.0/README.md

@@ -0,0 +1,113 @@
+# ContextForLLM
+
+A local web UI that scans any project folder on your machine, lets you select and annotate files, and generates a structured prompt you can paste directly into any LLM chat — Claude, ChatGPT, Gemini, or any other.
+
+---
+
+
+## Why this exists
+
+Every other tool in this space is a CLI that dumps your entire repo into one file. ContextForLLM gives you a browser UI where you can:
+
+- Toggle individual files in or out
+- Add a note to any file that gets embedded into the prompt
+- Generate an AI summary of your project using Groq
+- Automatically split large projects into sequenced prompt parts
+- Set your task so the LLM knows exactly what to do
+
+---
+
+## Demo
+
+> Screenshot / GIF coming soon
+
+---
+
+## Installation
+
+You need Python 3.8 or higher installed.
+
+**Step 1 — Clone the repo**
+```bash
+git clone https://github.com/Desai-23/ContextForLLM.git
+cd ContextForLLM
+```
+
+**Step 2 — Install dependencies**
+```bash
+pip install -r requirements.txt
+```
+
+**Step 3 — Run the app**
+```bash
+python app.py
+```
+
+Then open your browser at:
+```
+http://localhost:5000
+```
+
+---
+
+## How to use it
+
+1. Paste the path to any project folder on your machine
+2. Click Scan
+3. Review the files — toggle any file off to exclude it from the prompt
+4. Add annotations to files if needed (the LLM will see these notes)
+5. Optionally generate an AI summary of your project using Groq
+6. Set your task — what you want the LLM to do
+7. Click Generate Context Prompt
+8. Copy the prompt and paste it into any LLM chat
+
+---
+
+## Features
+
+- Local — your code never leaves your machine
+- Browser UI — no terminal required after launch
+- Per-file exclusion — toggle files in or out with a switch
+- Per-file annotations — add notes that get embedded into the prompt
+- Token counter — live token count with a visual usage bar
+- Prompt splitting — large projects automatically split into sequenced parts with handoff instructions
+- AI project summary — uses Groq to generate a project summary injected at the top of every prompt
+- .contextignore support — create a .contextignore file in any project to permanently exclude files
+
+---
+
+## .contextignore
+
+Create a `.contextignore` file in any project folder to exclude files automatically on scan. Uses the same pattern syntax as `.gitignore`.
+
+Example:
+```
+*.test.js
+migrations/
+old_auth.py
+```
+
+---
+
+## Groq API key
+
+The AI summary feature requires a free Groq API key.
+
+1. Get a free key at console.groq.com
+2. Click "Add Groq Key" in the top right of the UI
+3. Paste your key — it is held in memory only and never saved to disk
+
+---
+
+## Tech stack
+
+- Python / Flask — backend server
+- Vanilla HTML, CSS, JS — frontend UI
+- tiktoken — token counting
+- Groq — AI project summary (optional)
+
+---
+
+## License
+
+MIT

contextforllm-0.1.0/contextforllm/__main__.py

@@ -0,0 +1,34 @@
+import os
+import sys
+import subprocess
+import webbrowser
+import time
+
+def main():
+    app_dir = os.path.dirname(os.path.abspath(__file__))
+    app_path = os.path.join(app_dir, "app.py")
+
+    print("")
+    print("Starting ContextForLLM...")
+    print("")
+
+    process = subprocess.Popen(
+        [sys.executable, app_path],
+        cwd=app_dir
+    )
+
+    time.sleep(2)
+    webbrowser.open("http://127.0.0.1:5000")
+
+    try:
+        process.wait()
+    except KeyboardInterrupt:
+        process.terminate()
+        print("")
+        print("ContextForLLM stopped.")
+        print("")
+
+if __name__ == "__main__":
+    main()
+
+    

contextforllm-0.1.0/contextforllm/app.py

@@ -0,0 +1,225 @@
+import os
+import json
+from flask import Flask, request, jsonify, send_from_directory
+from context_builder import (
+    build_folder_tree,
+    collect_files,
+    build_file_block,
+    build_header,
+    split_into_prompts,
+    save_prompts,
+    count_tokens,
+    load_contextignore,
+)
+from project_summary import (
+    generate_project_summary,
+    save_summary,
+    load_summary,
+    delete_summary,
+)
+
+app = Flask(__name__, static_folder=os.path.join(os.path.dirname(__file__), "ui"))
+
+TOOL_DIR = os.path.dirname(os.path.abspath(__file__))
+RECENT_FILE = os.path.join(TOOL_DIR, "recent_projects.json")
+MAX_RECENT = 8
+
+# Session-only Groq key (not saved to disk)
+session_groq_key = ""
+
+# ── Recent projects ────────────────────────────────────────────
+def load_recent():
+    if os.path.isfile(RECENT_FILE):
+        try:
+            with open(RECENT_FILE, "r") as f:
+                return json.load(f)
+        except Exception:
+            return []
+    return []
+
+def save_recent(project_path, project_name):
+    recent = load_recent()
+    recent = [r for r in recent if r["path"] != project_path]
+    recent.insert(0, {"path": project_path, "name": project_name})
+    recent = recent[:MAX_RECENT]
+    with open(RECENT_FILE, "w") as f:
+        json.dump(recent, f, indent=2)
+
+# ── Routes ─────────────────────────────────────────────────────
+@app.route("/")
+def index():
+    return send_from_directory("ui", "index.html")
+
+@app.route("/api/recent", methods=["GET"])
+def get_recent():
+    recent = load_recent()
+    recent = [r for r in recent if os.path.isdir(r["path"])]
+    return jsonify({"recent": recent})
+
+@app.route("/api/recent/remove", methods=["POST"])
+def remove_recent():
+    data = request.json
+    path = data.get("path", "")
+    recent = load_recent()
+    recent = [r for r in recent if r["path"] != path]
+    with open(RECENT_FILE, "w") as f:
+        json.dump(recent, f, indent=2)
+    delete_summary(TOOL_DIR, path)
+    return jsonify({"ok": True})
+
+@app.route("/api/groq-key", methods=["POST"])
+def set_groq_key():
+    global session_groq_key
+    data = request.json
+    key = data.get("key", "").strip()
+    if not key:
+        return jsonify({"error": "Key is empty"}), 400
+    if not key.startswith("gsk_"):
+        return jsonify({"error": "Invalid key — Groq keys start with gsk_"}), 400
+    session_groq_key = key
+    return jsonify({"ok": True})
+
+@app.route("/api/groq-key/status", methods=["GET"])
+def groq_key_status():
+    return jsonify({"has_key": bool(session_groq_key)})
+
+@app.route("/api/scan", methods=["POST"])
+def scan():
+    data = request.json
+    project_path = data.get("project_path", "").strip()
+    project_path = os.path.expanduser(project_path)
+    project_path = os.path.abspath(project_path)
+
+    if not os.path.isdir(project_path):
+        return jsonify({"error": f"Folder not found: {project_path}"}), 400
+
+    project_name = os.path.basename(project_path)
+    tree_lines = build_folder_tree(project_path)
+    files = collect_files(project_path)
+    patterns = load_contextignore(project_path)
+    save_recent(project_path, project_name)
+
+    file_blocks = [build_file_block(path, content) for path, content in files]
+    header = build_header(project_name, project_path, "\n".join(tree_lines), 1)
+    full_text = header + "\n".join(file_blocks)
+    total_tokens = count_tokens(full_text)
+
+    existing_summary = load_summary(TOOL_DIR, project_path)
+
+    return jsonify({
+        "project_name": project_name,
+        "project_path": project_path,
+        "tree": tree_lines,
+        "files": [{"path": p, "tokens": count_tokens(c)} for p, c in files],
+        "total_tokens": total_tokens,
+        "file_count": len(files),
+        "contextignore_rules": patterns,
+        "existing_summary": existing_summary,
+        "groq_key_set": bool(session_groq_key)
+    })
+
+@app.route("/api/summary/generate", methods=["POST"])
+def generate_summary():
+    global session_groq_key
+    data = request.json
+    project_path = os.path.abspath(
+        os.path.expanduser(data.get("project_path", "")))
+
+    if not session_groq_key:
+        return jsonify({"error": "No Groq API key set for this session"}), 400
+
+    if not os.path.isdir(project_path):
+        return jsonify({"error": "Folder not found"}), 400
+
+    project_name = os.path.basename(project_path)
+    files = collect_files(project_path)
+
+    try:
+        summary = generate_project_summary(project_name, files, session_groq_key)
+        save_summary(TOOL_DIR, project_path, summary)
+        return jsonify({"summary": summary})
+    except Exception as e:
+        return jsonify({"error": str(e)}), 500
+
+@app.route("/api/summary/save", methods=["POST"])
+def save_summary_route():
+    data = request.json
+    project_path = os.path.abspath(
+        os.path.expanduser(data.get("project_path", "")))
+    summary = data.get("summary", "").strip()
+    if not summary:
+        return jsonify({"error": "Summary is empty"}), 400
+    save_summary(TOOL_DIR, project_path, summary)
+    return jsonify({"ok": True})
+
+@app.route("/api/summary/delete", methods=["POST"])
+def delete_summary_route():
+    data = request.json
+    project_path = os.path.abspath(
+        os.path.expanduser(data.get("project_path", "")))
+    delete_summary(TOOL_DIR, project_path)
+    return jsonify({"ok": True})
+
+@app.route("/api/generate", methods=["POST"])
+def generate():
+    data = request.json
+    project_path = os.path.abspath(
+        os.path.expanduser(data.get("project_path", "")))
+    task = data.get("task", "").strip()
+    excluded = set(data.get("excluded", []))
+    annotations = data.get("annotations", {})
+    include_summary = data.get("include_summary", True)
+
+    if not os.path.isdir(project_path):
+        return jsonify({"error": "Folder not found"}), 400
+
+    project_name = os.path.basename(project_path)
+    tree_lines = build_folder_tree(project_path)
+    all_files = collect_files(project_path)
+    files = [(p, c) for p, c in all_files if p not in excluded]
+
+    summary_text = ""
+    if include_summary:
+        summary_text = load_summary(TOOL_DIR, project_path) or ""
+
+    output_dir = os.path.join(TOOL_DIR, "output")
+    os.makedirs(output_dir, exist_ok=True)
+
+    file_blocks = [
+        build_file_block(path, content, annotations.get(path, ""))
+        for path, content in files
+    ]
+    header = build_header(project_name, project_path, "\n".join(tree_lines), 1)
+
+    if summary_text:
+        header = f"## PROJECT SUMMARY\n\n{summary_text}\n\n{header}"
+
+    prompts = split_into_prompts(header, file_blocks, task, project_name)
+    saved_files = save_prompts(prompts, output_dir)
+
+    parts = []
+    for i, filepath in enumerate(saved_files):
+        with open(filepath, "r") as f:
+            content = f.read()
+        parts.append({
+            "part": i + 1,
+            "filename": os.path.basename(filepath),
+            "tokens": count_tokens(content),
+            "content": content
+        })
+
+    return jsonify({
+        "total_parts": len(parts),
+        "output_dir": output_dir,
+        "parts": parts
+    })
+
+if __name__ == "__main__":
+    print("\nContextForLLM is running.")
+    print("Open this in your browser: http://localhost:5000\n")
+    app.run(debug=False, port=5000)
+
+
+
+
+