# RAG Document Viewer  
**RAG Document Viewer** is an open-source library that generates high-fidelity file previews for seamless integration into your applications. It provides desktop-level file viewing capabilities for a wide range of document formats, including:
- PDF documents
- Microsoft Office files (Word, PowerPoint, Excel)
- OpenOffice documents (ODS, ODT, ODP)
The library converts these files into interactive HTML-based previews that can be easily embedded into web applications, desktop applications, or any system that supports HTML rendering.
*Developed by [Preprocess Team](https://preprocess.co)*
## How it works
- Pass in a file and specify the destination path.
- An HTML bundle is created.
- You can now embed the viewer in your application with just an `<iframe>`.
**Viewer capabilities:**
1. **High-Fidelity Rendering**: Preserve the exact look-and-feel of PDFs, DOCX, PPTX & XLSX documents.
2. **Embed in Seconds**: Generate a self-contained HTML bundle and drop it into an `<iframe>`.
3. **Precise Highlights**: Pass bounding-box coordinates from your RAG chunks; the viewer auto-scrolls and spotlights them.
4. **Lightweight & Secure** - Runs 100 % in-browser. Files are served directly from *your* backend under *your* auth logic, no external servers.
**Viewer features:**
1. **Chunk Navigator**: Navigate between highlighted chunks with next/previous controls.
2. **Zoom Controls**: Renders the document at the optimal zoom level, and users can zoom in/out as needed.
3. **Scrollbar Navigator**: Visual indicators on the scrollbar show highlighted chunk positions; click to jump to a specific chunk.
4. **Chunks Highlighting** - Visual emphasis of the important content part you select.
---
## 🚀 Quick Start
**1. Install Dependencies**
```bash
wget "https://raw.githubusercontent.com/preprocess-co/rag-document-viewer/refs/heads/main/install.sh"
chmod +x install.sh && ./install.sh
```
**2. Install the Library**
```bash
pip install rag-document-viewer
```
**3. Create the bundle**
```python
from rag_document_viewer import RAG_DV
# Generate an HTML viewer
RAG_DV("document.pdf", "/static/viewers/document")
```
**4. Serve in your application**
```html
<iframe
src="/static/viewers/document/"
width="100%"
height="800"
style="border:0"
></iframe>
```
---
## Prerequisites
> **TL;DR** – *You only need system tools when **building** viewers on your server. Pre-built viewers are pure HTML/JS and have no dependencies.*
Before you start, make sure the required system dependencies are installed. An `install.sh` convenience script is included for Ubuntu; support for additional operating systems is coming soon.
### 1. System Dependencies
> For macOS, Windows, and other OSes, please refer to [this guide](./standard.md).
Install the required libraries:
```bash
wget "https://raw.githubusercontent.com/preprocess-co/rag-document-viewer/refs/heads/main/install.sh"
chmod +x install.sh && ./install.sh
```
### 2. Python Library
Install the package from PyPI:
```bash
pip install rag-document-viewer
# or with Poetry:
# poetry add rag-document-viewer
```
### 3. Verify Installations
Confirm both system tools are properly installed:
```bash
libreoffice --version
# Expected output:
# LibreOffice 24.2.7.2 420(Build:2)
pdf2htmlEX --version
# Expected output:
# pdf2htmlEX version 0.18.8.rc1
# ...
```
---
## Usage
### Generate a standard viewer
```python
from rag_document_viewer import RAG_DV
# Generate an HTML viewer
RAG_DV(file_path="document.pdf", store_path="/path/to/viewers/doc1")
```
> **Note**: We suggest setting `store_path` to a non-public, internal path and serving the content through a dedicated view. This way, you remain in full control of the authentication logic. See [Handling Authentication](#handling-authentication) for more details.
### Generate a viewer with chunk highlighting
You can get chunk coordinates from chunking providers like [Preprocess.co](https://preprocess.co/rag-document-viewer) (which supports paragraphs, layout items, multi-column layouts, slides, and more) or Unstructured.io (which offers PDF-only item-level support).
> **Note**: Chunks' coordinates should be stored in a list. When storing and then accessing a chunk, you should use the list index to reference the correct chunk.
**With the [Preprocess SDK](https://github.com/preprocess-co/pypreprocess)**
```python
from pypreprocess import Preprocess
from rag_document_viewer import RAG_DV
# Preprocess a file
preprocess = Preprocess(api_key=YOUR_API_KEY, filepath="path/to/file", boundary_boxes=True)
preprocess.chunk()
preprocess.wait()
result = preprocess.result()
# result is a PreprocessResponse object
# Generate an HTML viewer with highlighting capabilities
RAG_DV(
file_path="path/to/file",
store_path="/path/to/viewers/doc1",
chunks=result.data['boundary_boxes']["boxes"]
)
```
**With other providers**
```python
from rag_document_viewer import RAG_DV
# Define boxes for highlighting specific content areas.
# Each chunk is a list of one or more boxes.
# Each box has coordinates relative to the page dimensions (0.0 to 1.0).
# page: is a 0 based index for identifying the document page.
# top: position of the chunk between 0 and 1 relative to the page height
# left: position of the chunk between 0 and 1 relative to the page width
# height: vertical length of the chunk between 0 and 1 relative to the page height
# width: horizontal length of the chunk between 0 and 1 relative to the page width
boxes = [
[ # First chunk
{"page": 1, "top": 0.02, "left": 0.1, "height": 0.1, "width": 0.5},
# A chunk can be composed of multiple boxes (e.g., for multi-column text)
],
[ # Second chunk
{"page": 2, "top": 0.5, "left": 0.2, "height": 0.2, "width": 0.6},
],
# ... more chunks
]
# Generate an HTML viewer with highlighting capabilities
RAG_DV(
file_path="path/to/file",
store_path="/path/to/viewers/doc1",
chunks=boxes
)
```
> **Important**: If no chunk information is provided when generating the viewer, the following features will be disabled:
> - Chunk highlighting and navigation
> - Scrollbar chunk indicators
> - The `goto_chunk` URL parameter
>
> Ensure you include chunk coordinates if you plan to use these interactive features.
> **Tip: Page Highlighting**
> If you prefer to highlight entire pages instead of precise portions, create a chunk that covers the full page:
> `[{"page": 3, "top": 0, "left": 0, "height": 1, "width": 1}]`
### Viewer Options
Customize the viewer's appearance and behavior with these parameters during generation:
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `chunks` | `list` | `[]` | List of box coordinates for content chunks to highlight. |
| `page_number` | `bool` | `True` | Display page numbers at the bottom. |
| `chunks_navigator` | `bool` | `True` | Show chunk navigation controls (requires `chunks`). |
| `scrollbar_navigator` | `bool` | `True` | Display chunk indicators on the scrollbar (requires `chunks`). |
| `show_chunks_if_single` | `bool` | `False` | Show chunks navigator even with only one chunk (requires `chunks`). |
| `chunk_navigator_text` | `str` | `"Chunk %d of %d"` | Text template for chunk counter (use `%d` placeholders, requires `chunks`). |
**Example**
```python
from rag_document_viewer import RAG_DV
# `boxes` defined earlier in the code
RAG_DV(
file_path="path/to/file",
store_path="/path/to/viewer",
chunks=boxes,
chunk_navigator_text="Suggestion %d of %d",
scrollbar_navigator=False
)
```
### Color Customization
Customize the viewer's colors to match your branding.
> If `main_color` and `background_color` are set, all other colors are automatically derived. You can still override any specific color individually.
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `main_color` | `str` | `#ff8000` | Primary color for interactive elements |
| `background_color` | `str` | `#dddddd` | Viewer background color |
| `page_shadow` | `str` | `None` | CSS `box-shadow` for pages (auto-calculated if not set) |
| `text_selection_color` | `str` | `None` | Browser text selection color for the viewer (auto-calculated if not set) |
| `controls_text_color` | `str` | `None` | Text color of viewer controls, like zoom and page number (auto-calculated if not set) |
| `controls_bg_color` | `str` | `None` | Background color of viewer controls, like zoom and page number (auto-calculated if not set) |
| `scrollbar_color` | `str` | `None` | Scrollbar background color (auto-calculated if not set) |
| `scroller_color` | `str` | `None` | Scrollbar thumb color (auto-calculated if not set) |
| `bookmark_color` | `str` | `None` | Color for relevant chunk indicators in the scrollbar (defaults to main_color) |
| `highlight_chunk_color` | `str` | `None` | CSS `background-image` for chunk highlight (auto-calculated if not set) |
| `highlight_page_color` | `str` | `None` | CSS `background-image` for page highlight (auto-calculated if not set) |
| `highlight_page_outline` | `str` | `None` | Page border color for highlighted pages (auto-calculated if not set) |
**Example**
```python
from rag_document_viewer import RAG_DV
RAG_DV(
file_path="path/to/file",
store_path="/path/to/viewer",
main_color="#0969da",
background_color="#f6f8fa"
)
```
### Displaying the Viewer
Add an `<iframe>` to your application to show the document.
> ### **⚠️ Important**: The content must be served via HTTP/S. Opening the `index.html` directly from the local filesystem (`file://`) is not fully supported and may cause issues.
```html
<iframe
src="/path/to/viewers/my_document"
width="100%"
height="800"
style="border:0"
></iframe>
```
> **Note**: Please see the [Handling Authentication](#handling-authentication) section for best practices on securely integrating the viewer.
### Viewer Display Parameters
Control the viewer's initial state by passing parameters in the `<iframe>` URL:
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `chunks` | `string` | `[]` | An ordered JSON array of chunk indices to highlight and navigate. |
| `goto_chunk`| `int` | `None` | Automatically scroll to this chunk index on load. |
| `goto_page` | `int` | `None` | Automatically scroll to this page number on load. |
> **Note**: The `chunks` and `goto_chunk` parameters only work if chunk data was provided when the viewer was generated. The order of indices in the `chunks` URL parameter determines the "Next/Previous" navigation order.
> chunks and pages are 0-based inndexes
**Behavior Priority:**
The viewer determines the initial scroll position based on the following priority:
1. If `goto_chunk` is set, it scrolls to that chunk.
2. Else, if `chunks` is set, it scrolls to the first chunk in the list.
3. Else, if `goto_page` is set, it scrolls to that page.
4. Otherwise, it defaults to the beginning of the document.
**Examples:**
Highlight chunks `0`, `2`, and `3`, and jump directly to chunk `2` on load. Navigation will follow the `[0, 2, 3]` order.
```html
<iframe src="/viewer/doc1?chunks=[0,2,3]&goto_chunk=2"></iframe>
```
Highlight chunks `2`, `0`, and `3`. The "Next/Previous" buttons will navigate in this specific order (`2` -> `0` -> `3`). The view will initially scroll to chunk `2`.
```html
<iframe src="/viewer/doc1?chunks=[2,0,3]"></iframe>
```
Go to a specific page on load.
```html
<iframe src="/viewer/doc1?goto_page=4"></iframe>
```
### Handling Authentication
**We strongly recommend storing viewer bundles in a non-public path. Here is a guide on how to manage authentication to prevent unwanted access to your documents.**
When generating a viewer, you should store the resulting bundle in a directory that is not publicly accessible via HTTP. You can use your web server (Apache, Nginx, etc.) to block direct access to this folder. When a user requests to see a document, your application backend should first verify their permissions and then serve the viewer bundle from the disk.
Depending on your stack, this can be implemented in many ways. Using a route handler is a common approach.
**Flask Example**
This example shows how to serve a viewer only after checking user permissions.
```python
from flask import Flask, send_from_directory, abort
from pathlib import Path
# Path where viewer bundles are stored securely, outside the public web root
BASE_DIR = Path("/var/secure_viewers").resolve()
@app.route("/view/<doc_id>/")
@app.route("/view/<doc_id>/<path:asset>")
def serve_my_document(doc_id, asset="index.html"):
# 1. Add your authentication and authorization logic here
# Example: check_user_can_view(current_user, doc_id)
if not user_is_allowed:
abort(403) # Forbidden
# 2. Securely resolve the path to the viewer
viewer_dir = (BASE_DIR / doc_id).resolve()
# Security check: ensure the resolved path is still within the base directory
# This prevents path traversal attacks (e.g., doc_id = "../../../etc/passwd")
if viewer_dir.parent != BASE_DIR:
abort(404) # Not Found
# 3. Serve the requested asset (index.html, CSS, JS, etc.)
return send_from_directory(viewer_dir, asset)
```
> **Note**: Remember to include a wildcard in your route (e.g. `<path:asset>`) to handle requests for all assets inside the bundle (CSS, JS, fonts, images), otherwise the viewer will not render correctly.
---
## Support
Contact the Preprocess team at `support@preprocess.co` or join our [Discord channel](https://discord.gg/7G5xqsZmGu).
## License
This project is licensed under the MIT License.
## Credits
RAG Document Viewer would not be possible without the following open-source projects:
| Project | License |
|---------|---------|
| **LibreOffice** <https://www.libreoffice.org/> | **MPL 2.0 / LGPL v3** |
| **pdf2htmlEX** <https://github.com/pdf2htmlEX/pdf2htmlEX> | **GPL v3** |
These tools are **not** bundled with the `rag-document-viewer` package; they must be installed on the host system where viewers are generated. Please consult the upstream repositories for full license texts and source code.
Raw data
{
"_id": null,
"home_page": "https://github.com/preprocess-co/rag-document-viewer",
"name": "rag-document-viewer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "python, python3, preprocess, chunks, paragraphs, chunk, paragraph, llama, llamaondex, langchain, chunking, llm, rag, document, view, viewer, preview, previewer, file",
"author": "Preprocess",
"author_email": "<support@preprocess.co>",
"download_url": "https://files.pythonhosted.org/packages/13/49/8265dd4c0a8f989e221c4cc9920dca8b277e49242b82d0ebf9f63da1f063/rag_document_viewer-1.1.1.tar.gz",
"platform": null,
"description": "# RAG Document Viewer  \n\n**RAG Document Viewer** is an open-source library that generates high-fidelity file previews for seamless integration into your applications. It provides desktop-level file viewing capabilities for a wide range of document formats, including:\n\n- PDF documents\n- Microsoft Office files (Word, PowerPoint, Excel)\n- OpenOffice documents (ODS, ODT, ODP)\n\nThe library converts these files into interactive HTML-based previews that can be easily embedded into web applications, desktop applications, or any system that supports HTML rendering.\n\n*Developed by [Preprocess Team](https://preprocess.co)*\n\n## How it works\n- Pass in a file and specify the destination path.\n- An HTML bundle is created.\n- You can now embed the viewer in your application with just an `<iframe>`.\n\n**Viewer capabilities:**\n\n1. **High-Fidelity Rendering**: Preserve the exact look-and-feel of PDFs, DOCX, PPTX & XLSX documents.\n2. **Embed in Seconds**: Generate a self-contained HTML bundle and drop it into an `<iframe>`.\n3. **Precise Highlights**: Pass bounding-box coordinates from your RAG chunks; the viewer auto-scrolls and spotlights them.\n4. **Lightweight & Secure** - Runs 100 % in-browser. Files are served directly from *your* backend under *your* auth logic, no external servers.\n\n\n**Viewer features:**\n\n1. **Chunk Navigator**: Navigate between highlighted chunks with next/previous controls.\n2. **Zoom Controls**: Renders the document at the optimal zoom level, and users can zoom in/out as needed.\n3. **Scrollbar Navigator**: Visual indicators on the scrollbar show highlighted chunk positions; click to jump to a specific chunk.\n4. **Chunks Highlighting** - Visual emphasis of the important content part you select.\n\n\n\n---\n\n## \ud83d\ude80 Quick Start\n\n**1. Install Dependencies**\n```bash\nwget \"https://raw.githubusercontent.com/preprocess-co/rag-document-viewer/refs/heads/main/install.sh\"\nchmod +x install.sh && ./install.sh\n```\n\n**2. Install the Library**\n```bash\npip install rag-document-viewer\n```\n\n**3. Create the bundle**\n```python\nfrom rag_document_viewer import RAG_DV\n\n# Generate an HTML viewer\nRAG_DV(\"document.pdf\", \"/static/viewers/document\")\n```\n\n**4. Serve in your application**\n```html\n<iframe\n src=\"/static/viewers/document/\"\n width=\"100%\"\n height=\"800\"\n style=\"border:0\"\n></iframe>\n```\n\n---\n\n## Prerequisites\n> **TL;DR** \u2013 *You only need system tools when **building** viewers on your server. Pre-built viewers are pure HTML/JS and have no dependencies.*\n\nBefore you start, make sure the required system dependencies are installed. An `install.sh` convenience script is included for Ubuntu; support for additional operating systems is coming soon.\n\n### 1. System Dependencies\n> For macOS, Windows, and other OSes, please refer to [this guide](./standard.md).\n\nInstall the required libraries:\n```bash\nwget \"https://raw.githubusercontent.com/preprocess-co/rag-document-viewer/refs/heads/main/install.sh\"\nchmod +x install.sh && ./install.sh\n```\n\n### 2. Python Library\nInstall the package from PyPI:\n```bash\npip install rag-document-viewer\n# or with Poetry:\n# poetry add rag-document-viewer\n```\n\n### 3. Verify Installations\n\nConfirm both system tools are properly installed:\n\n```bash\nlibreoffice --version\n# Expected output:\n# LibreOffice 24.2.7.2 420(Build:2)\n\npdf2htmlEX --version\n# Expected output:\n# pdf2htmlEX version 0.18.8.rc1\n# ...\n```\n\n---\n\n## Usage\n\n### Generate a standard viewer\n\n```python\nfrom rag_document_viewer import RAG_DV\n\n# Generate an HTML viewer\nRAG_DV(file_path=\"document.pdf\", store_path=\"/path/to/viewers/doc1\")\n```\n\n> **Note**: We suggest setting `store_path` to a non-public, internal path and serving the content through a dedicated view. This way, you remain in full control of the authentication logic. See [Handling Authentication](#handling-authentication) for more details.\n\n### Generate a viewer with chunk highlighting\nYou can get chunk coordinates from chunking providers like [Preprocess.co](https://preprocess.co/rag-document-viewer) (which supports paragraphs, layout items, multi-column layouts, slides, and more) or Unstructured.io (which offers PDF-only item-level support).\n\n> **Note**: Chunks' coordinates should be stored in a list. When storing and then accessing a chunk, you should use the list index to reference the correct chunk.\n\n**With the [Preprocess SDK](https://github.com/preprocess-co/pypreprocess)**\n```python\nfrom pypreprocess import Preprocess\nfrom rag_document_viewer import RAG_DV\n\n# Preprocess a file\npreprocess = Preprocess(api_key=YOUR_API_KEY, filepath=\"path/to/file\", boundary_boxes=True)\npreprocess.chunk()\npreprocess.wait()\n\nresult = preprocess.result() \n# result is a PreprocessResponse object\n\n# Generate an HTML viewer with highlighting capabilities\nRAG_DV(\n file_path=\"path/to/file\",\n store_path=\"/path/to/viewers/doc1\",\n chunks=result.data['boundary_boxes'][\"boxes\"]\n)\n```\n\n**With other providers**\n```python\nfrom rag_document_viewer import RAG_DV\n\n# Define boxes for highlighting specific content areas.\n# Each chunk is a list of one or more boxes.\n# Each box has coordinates relative to the page dimensions (0.0 to 1.0).\n# page: is a 0 based index for identifying the document page.\n# top: position of the chunk between 0 and 1 relative to the page height\n# left: position of the chunk between 0 and 1 relative to the page width\n# height: vertical length of the chunk between 0 and 1 relative to the page height\n# width: horizontal length of the chunk between 0 and 1 relative to the page width\n\nboxes = [\n [ # First chunk\n {\"page\": 1, \"top\": 0.02, \"left\": 0.1, \"height\": 0.1, \"width\": 0.5},\n # A chunk can be composed of multiple boxes (e.g., for multi-column text)\n ],\n [ # Second chunk\n {\"page\": 2, \"top\": 0.5, \"left\": 0.2, \"height\": 0.2, \"width\": 0.6},\n ],\n # ... more chunks\n]\n\n# Generate an HTML viewer with highlighting capabilities\nRAG_DV(\n file_path=\"path/to/file\",\n store_path=\"/path/to/viewers/doc1\",\n chunks=boxes\n)\n```\n\n> **Important**: If no chunk information is provided when generating the viewer, the following features will be disabled:\n> - Chunk highlighting and navigation\n> - Scrollbar chunk indicators\n> - The `goto_chunk` URL parameter\n>\n> Ensure you include chunk coordinates if you plan to use these interactive features.\n\n\n> **Tip: Page Highlighting**\n> If you prefer to highlight entire pages instead of precise portions, create a chunk that covers the full page:\n> `[{\"page\": 3, \"top\": 0, \"left\": 0, \"height\": 1, \"width\": 1}]`\n\n\n### Viewer Options\nCustomize the viewer's appearance and behavior with these parameters during generation:\n\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `chunks` | `list` | `[]` | List of box coordinates for content chunks to highlight. |\n| `page_number` | `bool` | `True` | Display page numbers at the bottom. |\n| `chunks_navigator` | `bool` | `True` | Show chunk navigation controls (requires `chunks`). |\n| `scrollbar_navigator` | `bool` | `True` | Display chunk indicators on the scrollbar (requires `chunks`). |\n| `show_chunks_if_single` | `bool` | `False` | Show chunks navigator even with only one chunk (requires `chunks`). |\n| `chunk_navigator_text` | `str` | `\"Chunk %d of %d\"` | Text template for chunk counter (use `%d` placeholders, requires `chunks`). |\n\n\n**Example**\n```python\nfrom rag_document_viewer import RAG_DV\n\n# `boxes` defined earlier in the code\nRAG_DV(\n file_path=\"path/to/file\",\n store_path=\"/path/to/viewer\",\n chunks=boxes,\n chunk_navigator_text=\"Suggestion %d of %d\",\n scrollbar_navigator=False\n)\n```\n\n\n### Color Customization\nCustomize the viewer's colors to match your branding.\n\n> If `main_color` and `background_color` are set, all other colors are automatically derived. You can still override any specific color individually.\n\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `main_color` | `str` | `#ff8000` | Primary color for interactive elements |\n| `background_color` | `str` | `#dddddd` | Viewer background color |\n| `page_shadow` | `str` | `None` | CSS `box-shadow` for pages (auto-calculated if not set) |\n| `text_selection_color` | `str` | `None` | Browser text selection color for the viewer (auto-calculated if not set) |\n| `controls_text_color` | `str` | `None` | Text color of viewer controls, like zoom and page number (auto-calculated if not set) |\n| `controls_bg_color` | `str` | `None` | Background color of viewer controls, like zoom and page number (auto-calculated if not set) |\n| `scrollbar_color` | `str` | `None` | Scrollbar background color (auto-calculated if not set) |\n| `scroller_color` | `str` | `None` | Scrollbar thumb color (auto-calculated if not set) |\n| `bookmark_color` | `str` | `None` | Color for relevant chunk indicators in the scrollbar (defaults to main_color) |\n| `highlight_chunk_color` | `str` | `None` | CSS `background-image` for chunk highlight (auto-calculated if not set) |\n| `highlight_page_color` | `str` | `None` | CSS `background-image` for page highlight (auto-calculated if not set) |\n| `highlight_page_outline` | `str` | `None` | Page border color for highlighted pages (auto-calculated if not set) |\n\n**Example**\n```python\nfrom rag_document_viewer import RAG_DV\n\nRAG_DV(\n file_path=\"path/to/file\",\n store_path=\"/path/to/viewer\",\n main_color=\"#0969da\",\n background_color=\"#f6f8fa\"\n)\n```\n\n\n### Displaying the Viewer\nAdd an `<iframe>` to your application to show the document.\n\n> ### **\u26a0\ufe0f Important**: The content must be served via HTTP/S. Opening the `index.html` directly from the local filesystem (`file://`) is not fully supported and may cause issues.\n\n```html\n<iframe\n src=\"/path/to/viewers/my_document\"\n width=\"100%\"\n height=\"800\"\n style=\"border:0\"\n></iframe>\n```\n\n> **Note**: Please see the [Handling Authentication](#handling-authentication) section for best practices on securely integrating the viewer.\n\n\n### Viewer Display Parameters\n\nControl the viewer's initial state by passing parameters in the `<iframe>` URL:\n\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `chunks` | `string` | `[]` | An ordered JSON array of chunk indices to highlight and navigate. |\n| `goto_chunk`| `int` | `None` | Automatically scroll to this chunk index on load. |\n| `goto_page` | `int` | `None` | Automatically scroll to this page number on load. |\n\n> **Note**: The `chunks` and `goto_chunk` parameters only work if chunk data was provided when the viewer was generated. The order of indices in the `chunks` URL parameter determines the \"Next/Previous\" navigation order.\n> chunks and pages are 0-based inndexes\n\n**Behavior Priority:**\nThe viewer determines the initial scroll position based on the following priority:\n1. If `goto_chunk` is set, it scrolls to that chunk.\n2. Else, if `chunks` is set, it scrolls to the first chunk in the list.\n3. Else, if `goto_page` is set, it scrolls to that page.\n4. Otherwise, it defaults to the beginning of the document.\n\n**Examples:**\n\nHighlight chunks `0`, `2`, and `3`, and jump directly to chunk `2` on load. Navigation will follow the `[0, 2, 3]` order.\n```html\n<iframe src=\"/viewer/doc1?chunks=[0,2,3]&goto_chunk=2\"></iframe>\n```\n\nHighlight chunks `2`, `0`, and `3`. The \"Next/Previous\" buttons will navigate in this specific order (`2` -> `0` -> `3`). The view will initially scroll to chunk `2`.\n```html\n<iframe src=\"/viewer/doc1?chunks=[2,0,3]\"></iframe>\n```\n\nGo to a specific page on load.\n```html\n<iframe src=\"/viewer/doc1?goto_page=4\"></iframe>\n```\n\n\n### Handling Authentication\n**We strongly recommend storing viewer bundles in a non-public path. Here is a guide on how to manage authentication to prevent unwanted access to your documents.**\n\nWhen generating a viewer, you should store the resulting bundle in a directory that is not publicly accessible via HTTP. You can use your web server (Apache, Nginx, etc.) to block direct access to this folder. When a user requests to see a document, your application backend should first verify their permissions and then serve the viewer bundle from the disk.\n\nDepending on your stack, this can be implemented in many ways. Using a route handler is a common approach.\n\n**Flask Example**\nThis example shows how to serve a viewer only after checking user permissions.\n\n```python\nfrom flask import Flask, send_from_directory, abort\nfrom pathlib import Path\n\n# Path where viewer bundles are stored securely, outside the public web root\nBASE_DIR = Path(\"/var/secure_viewers\").resolve()\n\n@app.route(\"/view/<doc_id>/\")\n@app.route(\"/view/<doc_id>/<path:asset>\")\ndef serve_my_document(doc_id, asset=\"index.html\"):\n # 1. Add your authentication and authorization logic here\n # Example: check_user_can_view(current_user, doc_id)\n if not user_is_allowed:\n abort(403) # Forbidden\n \n # 2. Securely resolve the path to the viewer\n viewer_dir = (BASE_DIR / doc_id).resolve()\n \n # Security check: ensure the resolved path is still within the base directory\n # This prevents path traversal attacks (e.g., doc_id = \"../../../etc/passwd\")\n if viewer_dir.parent != BASE_DIR:\n abort(404) # Not Found\n \n # 3. Serve the requested asset (index.html, CSS, JS, etc.)\n return send_from_directory(viewer_dir, asset)\n```\n\n> **Note**: Remember to include a wildcard in your route (e.g. `<path:asset>`) to handle requests for all assets inside the bundle (CSS, JS, fonts, images), otherwise the viewer will not render correctly.\n\n---\n\n## Support\nContact the Preprocess team at `support@preprocess.co` or join our [Discord channel](https://discord.gg/7G5xqsZmGu).\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Credits\nRAG Document Viewer would not be possible without the following open-source projects:\n\n| Project | License |\n|---------|---------|\n| **LibreOffice** <https://www.libreoffice.org/> | **MPL 2.0 / LGPL v3** |\n| **pdf2htmlEX** <https://github.com/pdf2htmlEX/pdf2htmlEX> | **GPL v3** |\n\nThese tools are **not** bundled with the `rag-document-viewer` package; they must be installed on the host system where viewers are generated. Please consult the upstream repositories for full license texts and source code.\n",
"bugtrack_url": null,
"license": null,
"summary": "RAG Document Viewer",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/preprocess-co/rag-document-viewer"
},
"split_keywords": [
"python",
" python3",
" preprocess",
" chunks",
" paragraphs",
" chunk",
" paragraph",
" llama",
" llamaondex",
" langchain",
" chunking",
" llm",
" rag",
" document",
" view",
" viewer",
" preview",
" previewer",
" file"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e780888004bad959fbd8b41470548cd26ea6282dcc27129e54c97f4749aaf1b4",
"md5": "ae91bc22c9a648a91491ec64670c1f01",
"sha256": "d4825270120f6fcca509459904a56bc161c5ae90666b3dcfbb28e1b100aee368"
},
"downloads": -1,
"filename": "rag_document_viewer-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae91bc22c9a648a91491ec64670c1f01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 24692,
"upload_time": "2025-08-11T16:21:24",
"upload_time_iso_8601": "2025-08-11T16:21:24.122322Z",
"url": "https://files.pythonhosted.org/packages/e7/80/888004bad959fbd8b41470548cd26ea6282dcc27129e54c97f4749aaf1b4/rag_document_viewer-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13498265dd4c0a8f989e221c4cc9920dca8b277e49242b82d0ebf9f63da1f063",
"md5": "8095ef484197781755dac1b563f67e85",
"sha256": "bfe23f3f5bed13edf063017394f1bb2374c979c5c4575367b3273a0ef992472f"
},
"downloads": -1,
"filename": "rag_document_viewer-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "8095ef484197781755dac1b563f67e85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 510298,
"upload_time": "2025-08-11T16:21:26",
"upload_time_iso_8601": "2025-08-11T16:21:26.269857Z",
"url": "https://files.pythonhosted.org/packages/13/49/8265dd4c0a8f989e221c4cc9920dca8b277e49242b82d0ebf9f63da1f063/rag_document_viewer-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 16:21:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "preprocess-co",
"github_project": "rag-document-viewer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rag-document-viewer"
}
JSON
