oneport-context 0.1.0__tar.gz

oneport_context-0.1.0/.gitignore

@@ -0,0 +1,42 @@
+# Secrets — NEVER commit
+.env
+.env.*
+*.pem
+audit.jsonl
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+*.whl
+*.tar.gz
+
+# Virtual envs
+.venv/
+venv/
+env/
+
+# Test / tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Editor / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db
+
+# Generated caches & outputs
+.context/
+*.mp4
+.history/
+
+# Heap dumps & scratch (generated by demos / testing)
+*.hprof
+*.heapsnapshot

oneport_context-0.1.0/LICENSE

@@ -0,0 +1,179 @@
+                                 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.
+
+      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
+
+   Copyright 2024 OnePort 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.

oneport_context-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: oneport-context
+Version: 0.1.0
+Summary: Code Contextualizer — point it at any repo (no upload) and get a narrated architecture walkthrough, a handbook, and hover-to-explain in your editor. Runs locally on your own key.
+Project-URL: Homepage, https://github.com/oneport-debug/oneport-context
+Project-URL: Repository, https://github.com/oneport-debug/oneport-context
+Author: OnePort Contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: code-explanation,codebase,developer-tools,documentation,lsp,notebooklm,onboarding,walkthrough
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1.7
+Requires-Dist: oneport-debug-core>=0.1.0
+Requires-Dist: pydantic>=2.9.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=13.8.0
+Provides-Extra: lsp
+Requires-Dist: pygls>=1.3.0; extra == 'lsp'
+Provides-Extra: pdf
+Requires-Dist: reportlab>=4.0.0; extra == 'pdf'
+Provides-Extra: video
+Requires-Dist: gtts>=2.5.0; extra == 'video'
+Requires-Dist: moviepy>=2.0.0; extra == 'video'
+Requires-Dist: pillow>=10.0.0; extra == 'video'
+Requires-Dist: pyttsx3>=2.90; extra == 'video'
+Description-Content-Type: text/markdown
+
+# oneport-context
+
+**Code Contextualizer — NotebookLM for your codebase, that never leaves your machine.**
+
+Point it at any repo (however large — no upload) and it builds a hierarchical
+understanding locally, then turns it into a **narrated architecture walkthrough**, a
+**narrated MP4 video**, a **PDF handbook**, a **chat** that knows your code, and
+**hover-to-explain** in your editor. Runs on your own model key (Google Gemini free
+tier) or fully local — your code never leaves the machine.
+
+## Try it in 60 seconds (no setup)
+
+```bash
+pip install oneport-context
+oneport-context demo
+```
+
+Opens a narrated, animated walkthrough of a bundled sample repo in your browser — no
+API key needed.
+
+## Use it on your own repo
+
+```bash
+export GEMINI_API_KEY=…            # free key at aistudio.google.com/apikey
+
+oneport-context index ./my-repo    # build the understanding (cached in .context/)
+oneport-context show  ./my-repo    # narrated walkthrough in the browser
+oneport-context video ./my-repo    # narrated MP4 (>= 8 min)   -> needs [video]
+oneport-context pdf   ./my-repo    # PDF handbook, opens in browser -> needs [pdf]
+oneport-context chat  ./my-repo    # ask questions in the terminal
+oneport-context lsp   ./my-repo    # editor hover-to-explain -> needs [lsp]
+```
+
+Without a key it still works in **heuristic mode** (structure + docstrings) — free and
+offline, just less prose.
+
+## Commands
+
+| Command | What it does | Extra |
+|---|---|---|
+| `demo` | Zero-config narrated walkthrough of a bundled repo | — |
+| `index ./repo` | Build the hierarchical understanding (cached) | — |
+| `show ./repo` | Localhost narrated architecture walkthrough | — |
+| `video ./repo` | Narrated MP4 (`--minutes`, `--voice`) | `[video]` |
+| `pdf ./repo` | Styled PDF handbook, served in the browser | `[pdf]` |
+| `chat ./repo` | Terminal Q&A grounded in your code | — |
+| `lsp ./repo` | Hover-to-explain Language Server (VS Code / Neovim / JetBrains) | `[lsp]` |
+
+## Install with the features you want
+
+```bash
+pip install 'oneport-context[video,pdf,lsp]'
+```
+- `[video]` — pillow, moviepy (ffmpeg), gTTS voice
+- `[pdf]` — reportlab
+- `[lsp]` — pygls
+
+## Why CLI, not upload
+
+Big repos don't fit an upload box. The CLI walks the tree locally and builds a
+**file -> module -> repo** summary (module summaries are batched, so a large repo
+costs only a handful of model calls). Everything is cached in `.context/`; your code
+never leaves the machine.
+
+## Notes
+
+- `video`/`pdf`/`chat` produce their best output with `GEMINI_API_KEY` set; heuristic
+  mode works without it.
+- Prefer local/air-gapped? Set `ONEPORT_MODE=local` and run against Ollama.
+- Have an Anthropic key? Set `ANTHROPIC_API_KEY` and it takes priority automatically.
+
+## License
+
+Apache-2.0

oneport_context-0.1.0/README.md

@@ -0,0 +1,74 @@
+# oneport-context
+
+**Code Contextualizer — NotebookLM for your codebase, that never leaves your machine.**
+
+Point it at any repo (however large — no upload) and it builds a hierarchical
+understanding locally, then turns it into a **narrated architecture walkthrough**, a
+**narrated MP4 video**, a **PDF handbook**, a **chat** that knows your code, and
+**hover-to-explain** in your editor. Runs on your own model key (Google Gemini free
+tier) or fully local — your code never leaves the machine.
+
+## Try it in 60 seconds (no setup)
+
+```bash
+pip install oneport-context
+oneport-context demo
+```
+
+Opens a narrated, animated walkthrough of a bundled sample repo in your browser — no
+API key needed.
+
+## Use it on your own repo
+
+```bash
+export GEMINI_API_KEY=…            # free key at aistudio.google.com/apikey
+
+oneport-context index ./my-repo    # build the understanding (cached in .context/)
+oneport-context show  ./my-repo    # narrated walkthrough in the browser
+oneport-context video ./my-repo    # narrated MP4 (>= 8 min)   -> needs [video]
+oneport-context pdf   ./my-repo    # PDF handbook, opens in browser -> needs [pdf]
+oneport-context chat  ./my-repo    # ask questions in the terminal
+oneport-context lsp   ./my-repo    # editor hover-to-explain -> needs [lsp]
+```
+
+Without a key it still works in **heuristic mode** (structure + docstrings) — free and
+offline, just less prose.
+
+## Commands
+
+| Command | What it does | Extra |
+|---|---|---|
+| `demo` | Zero-config narrated walkthrough of a bundled repo | — |
+| `index ./repo` | Build the hierarchical understanding (cached) | — |
+| `show ./repo` | Localhost narrated architecture walkthrough | — |
+| `video ./repo` | Narrated MP4 (`--minutes`, `--voice`) | `[video]` |
+| `pdf ./repo` | Styled PDF handbook, served in the browser | `[pdf]` |
+| `chat ./repo` | Terminal Q&A grounded in your code | — |
+| `lsp ./repo` | Hover-to-explain Language Server (VS Code / Neovim / JetBrains) | `[lsp]` |
+
+## Install with the features you want
+
+```bash
+pip install 'oneport-context[video,pdf,lsp]'
+```
+- `[video]` — pillow, moviepy (ffmpeg), gTTS voice
+- `[pdf]` — reportlab
+- `[lsp]` — pygls
+
+## Why CLI, not upload
+
+Big repos don't fit an upload box. The CLI walks the tree locally and builds a
+**file -> module -> repo** summary (module summaries are batched, so a large repo
+costs only a handful of model calls). Everything is cached in `.context/`; your code
+never leaves the machine.
+
+## Notes
+
+- `video`/`pdf`/`chat` produce their best output with `GEMINI_API_KEY` set; heuristic
+  mode works without it.
+- Prefer local/air-gapped? Set `ONEPORT_MODE=local` and run against Ollama.
+- Have an Anthropic key? Set `ANTHROPIC_API_KEY` and it takes priority automatically.
+
+## License
+
+Apache-2.0

oneport_context-0.1.0/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "oneport-context"
+version = "0.1.0"
+description = "Code Contextualizer — point it at any repo (no upload) and get a narrated architecture walkthrough, a handbook, and hover-to-explain in your editor. Runs locally on your own key."
+readme = "README.md"
+license = { text = "Apache-2.0" }
+requires-python = ">=3.11"
+authors = [{ name = "OnePort Contributors" }]
+keywords = ["code-explanation", "onboarding", "documentation", "codebase", "walkthrough", "lsp", "notebooklm", "developer-tools"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Documentation",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "oneport-debug-core>=0.1.0",
+    "click>=8.1.7",
+    "rich>=13.8.0",
+    "pydantic>=2.9.0",
+    "PyYAML>=6.0.2",
+]
+
+[project.optional-dependencies]
+# Editor hover-to-explain via the Language Server Protocol.
+lsp = ["pygls>=1.3.0"]
+# Render a narrated MP4 walkthrough (slides + Gemini voice + video stitch).
+video = ["pillow>=10.0.0", "moviepy>=2.0.0", "gTTS>=2.5.0", "pyttsx3>=2.90"]
+# Generate a styled PDF handbook.
+pdf = ["reportlab>=4.0.0"]
+
+[project.urls]
+Homepage = "https://github.com/oneport-debug/oneport-context"
+Repository = "https://github.com/oneport-debug/oneport-context"
+
+[project.scripts]
+oneport-context = "oneport_context.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/oneport_context"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/oneport_context", "README.md"]

oneport_context-0.1.0/src/oneport_context/__init__.py

@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 OnePort Contributors
+"""
+oneport-context — Code Contextualizer.
+
+Point it at any repo (however large, no upload) and it builds a hierarchical
+understanding on your machine, then turns it into a narrated architecture
+walkthrough, a handbook, editor hover-to-explain (LSP), and a chat that knows
+your code. Runs on your own model key (Gemini free tier / local Ollama).
+"""
+
+__version__ = "0.1.0"

oneport_context-0.1.0/src/oneport_context/chat/__init__.py

@@ -0,0 +1,6 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 OnePort Contributors
+"""Chat over a codebase — retrieval grounded in the local index."""
+from oneport_context.chat.engine import answer, retrieve
+
+__all__ = ["answer", "retrieve"]

oneport_context-0.1.0/src/oneport_context/chat/engine.py

@@ -0,0 +1,69 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2024 OnePort Contributors
+"""
+Chat retrieval + answer.
+
+Keeps it grounded: rank the indexed files against the question, read the top ones
+from disk (nothing was uploaded — the code is right there), stuff them into the
+prompt, and let the model answer citing real paths. No embeddings needed for a
+first cut; keyword scoring over path + summary + symbols is fast and works.
+"""
+from __future__ import annotations
+
+import re
+from pathlib import Path
+
+from oneport_context.models import RepoIndex
+
+_FILE_CAP = 8000            # chars per file in the prompt
+_CTX_BUDGET = 60_000        # total chars of code context
+
+
+def retrieve(index: RepoIndex, question: str, k: int = 15) -> tuple[str, list[str]]:
+    """Return (code_context, cited_paths) for the files most relevant to `question`."""
+    tokens = set(re.findall(r"\w+", question.lower()))
+    root = Path(index.root)
+
+    scored = []
+    for f in index.all_files():
+        blob = f"{f.path} {f.summary} {' '.join(s.name for s in f.symbols)}".lower()
+        score = sum(3 if t in f.path.lower() else 1 for t in tokens if t in blob)
+        scored.append((score, f))
+    scored.sort(key=lambda x: -x[0])
+
+    picks = [f for s, f in scored[:k] if s > 0] or [f for _, f in scored[:5]]
+    parts, cited, used = [], [], 0
+    for f in picks:
+        content = _read(root / f.path)
+        if not content:
+            continue
+        block = f"\n### {f.path}  [{f.language}]\n{content[:_FILE_CAP]}\n"
+        if used + len(block) > _CTX_BUDGET:
+            break
+        parts.append(block)
+        cited.append(f.path)
+        used += len(block)
+    return "".join(parts), cited
+
+
+async def answer(index: RepoIndex, llm, history: list[tuple[str, str]], question: str) -> tuple[str, list[str]]:
+    """Answer `question` about the repo, grounded in retrieved files. Returns (answer, cited)."""
+    from oneport_debug_core.llm.base import LLMCompletionOptions
+    context, cited = retrieve(index, question)
+    convo = "\n".join(f"Q: {q}\nA: {a}" for q, a in history[-4:])
+    prompt = (
+        f"You are an expert on the codebase '{index.name}'. Answer the question using the "
+        f"actual source files below. Be precise and technical, and cite specific file paths.\n\n"
+        f"=== Relevant files ===\n{context}\n\n"
+        + (f"=== Conversation so far ===\n{convo}\n\n" if convo else "")
+        + f"=== Question ===\n{question}\n\nAnswer:"
+    )
+    text = await llm.complete(prompt, LLMCompletionOptions(temperature=0.2, max_tokens=1500))
+    return text.strip(), cited
+
+
+def _read(path: Path) -> str:
+    try:
+        return path.read_text(encoding="utf-8", errors="replace")
+    except OSError:
+        return ""