Local semantic PDF search with embedding-based retrieval, page navigation, and highlighted answers.
Status: Document-search prototype
Built with: Python, local embeddings, browser UI
Project guide · Every file explained · Licenses and dependencies
- requirements.txt — Python dependency requirements and optional dependency groups; install with the project’s documented interpreter and environment.
- src/main.py — QuickGuide (QG) — FastAPI Application Defines
lifespan,serve_frontend,upload_document,list_documents,get_document,get_document_statusand 8 more top-level symbols. - qg.sh — Command-line automation for qg; review prerequisites and side effects before executing.
- qg.bat — Command-line automation for qg; review prerequisites and side effects before executing.
Detailed setup, usage, and development notes preserve the previous project documentation.
| Path | Role |
|---|---|
| .github/ | GitHub workflow and contributor configuration (1 tracked entries). |
| docs/ | Project documentation, decisions, and reference material (13 tracked entries). |
| src/ | Application source and platform integration (16 tracked entries). |
| tests/ | Automated checks and test fixtures (3 tracked entries). |
Models and source PDFs are separate downloads or local inputs. PyMuPDF and other PDF/ML dependencies retain their own licensing terms.
Original project code retains MIT terms in LICENSE. Third-party libraries, media, data, models, and tools retain their own terms. See the license review and dependency inventory.