Compare commits

..

No commits in common. "main" and "feat/colbert-retriever" have entirely different histories.

6 changed files with 5 additions and 9 deletions

View file

@ -4,7 +4,7 @@
[![Status](https://img.shields.io/badge/status-beta-blue)](https://git.opensourcesolarpunk.com/Circuit-Forge/pagepiper) [![Status](https://img.shields.io/badge/status-beta-blue)](https://git.opensourcesolarpunk.com/Circuit-Forge/pagepiper)
[![License: MIT / BSL 1.1](https://img.shields.io/badge/license-MIT%20%2F%20BSL%201.1-blue)](LICENSE) [![License: MIT / BSL 1.1](https://img.shields.io/badge/license-MIT%20%2F%20BSL%201.1-blue)](LICENSE)
[![Version](https://img.shields.io/badge/version-v0.2.0-orange)](https://git.opensourcesolarpunk.com/Circuit-Forge/pagepiper/releases) [![Version](https://img.shields.io/badge/version-v0.1.0-orange)](https://git.opensourcesolarpunk.com/Circuit-Forge/pagepiper/releases)
Self-hosted document and spreadsheet search — PDF, EPUB, DOCX, ODT, Apple Pages, XLSX, ODS, and Apple Numbers — with BM25 (Best Match 25) full-text indexing and LLM (large language model) synthesis. Drop your documents in, ask a question, get an answer that tells you exactly which page to turn to. Self-hosted document and spreadsheet search — PDF, EPUB, DOCX, ODT, Apple Pages, XLSX, ODS, and Apple Numbers — with BM25 (Best Match 25) full-text indexing and LLM (large language model) synthesis. Drop your documents in, ask a question, get an answer that tells you exactly which page to turn to.

View file

@ -10,15 +10,13 @@ Try it: [pagepiper.circuitforge.tech](https://pagepiper.circuitforge.tech)
### Library ### Library
![Library view](screenshots/01-library.png){ .only-light } ![Library view](screenshots/01-library.png)
![Library view](screenshots/01-library-dark.png){ .only-dark }
Scan your PDF directory to index documents, or upload individual PDFs directly. Each document shows page count and shelving status. Scan your PDF directory to index documents, or upload individual PDFs directly. Each document shows page count and shelving status.
### Chat ### Chat
![Chat view](screenshots/02-chat.png){ .only-light } ![Chat view](screenshots/02-chat.png)
![Chat view](screenshots/02-chat-dark.png){ .only-dark }
Ask questions across your indexed documents. Results cite the source document and page number. Ask questions across your indexed documents. Results cite the source document and page number.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

View file

@ -31,7 +31,6 @@ theme:
markdown_extensions: markdown_extensions:
- admonition - admonition
- attr_list
- pymdownx.details - pymdownx.details
- pymdownx.superfences: - pymdownx.superfences:
custom_fences: custom_fences:
@ -60,7 +59,6 @@ nav:
- Architecture: reference/architecture.md - Architecture: reference/architecture.md
- Tier System: reference/tier-system.md - Tier System: reference/tier-system.md
- Environment Variables: reference/environment-variables.md - Environment Variables: reference/environment-variables.md
- All CF Docs: https://docs.circuitforge.tech
extra_css: extra_css:
- stylesheets/theme.css - stylesheets/theme.css

View file

@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "pagepiper" name = "pagepiper"
version = "0.2.0" version = "0.1.0"
description = "Self-hosted document and spreadsheet library manager with RAG chat and page-level citations" description = "Self-hosted PDF library manager with RAG chat and page-level citations"
readme = "README.md" readme = "README.md"
requires-python = ">=3.11" requires-python = ">=3.11"
dependencies = [ dependencies = [