paperpipe 0.8.2__py3-none-any.whl

AGENT_INTEGRATION.md

@@ -0,0 +1,37 @@
+# Agent Integration Snippet (PaperPipe)
+
+Copy/paste this into your repo’s agent instructions file (`AGENTS.md`, or `CLAUDE.md` / `GEMINI.md` / etc):
+
+```markdown
+## Paper References (PaperPipe)
+
+This repo implements methods from scientific papers. Papers are managed via `papi` (PaperPipe).
+
+- Paper DB root: run `papi path` (default `~/.paperpipe/`; override via `PAPER_DB_PATH`).
+- Inspect a paper (prints to stdout):
+  - Equations (verification): `papi show <paper> -l eq`
+  - Definitions (LaTeX): `papi show <paper> -l tex`
+  - Overview: `papi show <paper> -l summary`
+- Direct files (if needed): `<paper_db>/papers/{paper}/equations.md`, `source.tex`, `summary.md`
+
+Rules:
+- For “does this match the paper?”, use `papi show <paper> -l eq` / `-l tex` and compare symbols step-by-step.
+- For “which paper mentions X?”:
+  - Exact string hits (fast): `papi search --grep --fixed-strings "X"`
+  - Ranked search (BM25): `papi search-index --rebuild` then `papi search --fts "X"`
+  - Hybrid (ranked + exact boost): `papi search --hybrid "X"`
+- If the agent can’t read `~/.paperpipe/`, export context into the repo: `papi export <papers...> --level equations --to ./paper-context/`.
+- Use `papi ask "..."` only when you explicitly want RAG synthesis (PaperQA2 default if installed; optional `--backend leann`).
+  - For cheaper/deterministic queries: `papi ask "..." --pqa-agent-type fake`
+  - For machine-readable evidence: `papi ask "..." --format evidence-blocks`
+  - For debugging PaperQA2 output: `papi ask "..." --pqa-raw`
+```
+
+<details>
+<summary>Glossary (optional)</summary>
+
+- **RAG** = retrieval‑augmented generation: retrieve passages first, then generate an answer grounded in those passages.
+- **Embeddings** = vector representations used for semantic retrieval; changing the embedding model implies a new index.
+- **MCP** = Model Context Protocol: agent/tool integration for retrieval without pasting PDFs into chat.
+
+</details>

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Matthias Humt
+
+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.