openrag 0.1.8__tar.gz

openrag-0.1.8/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/tui/_assets *

openrag-0.1.8/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: openrag
+Version: 0.1.8
+Summary: Add your description here
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: agentd>=0.2.2
+Requires-Dist: aiofiles>=24.1.0
+Requires-Dist: cryptography>=45.0.6
+Requires-Dist: docling[vlm]>=2.41.0; sys_platform != "darwin"
+Requires-Dist: docling[ocrmac,vlm]>=2.41.0; sys_platform == "darwin"
+Requires-Dist: google-api-python-client>=2.143.0
+Requires-Dist: google-auth-httplib2>=0.2.0
+Requires-Dist: google-auth-oauthlib>=1.2.0
+Requires-Dist: msal>=1.29.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: opensearch-py[async]>=3.0.0
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: python-multipart>=0.0.20
+Requires-Dist: starlette>=0.47.1
+Requires-Dist: torch>=2.7.1
+Requires-Dist: uvicorn>=0.35.0
+Requires-Dist: boto3>=1.35.0
+Requires-Dist: psutil>=7.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: textual>=0.45.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: textual-fspicker>=0.6.0
+Requires-Dist: structlog>=25.4.0
+Requires-Dist: docling-serve>=1.4.1
+
+<div align="center">
+
+# OpenRAG
+
+</div>
+<div align="center">
+  <a href="#quick-start" style="color: #0366d6;">🚀 Quick Start</a> &nbsp;&nbsp;|&nbsp;&nbsp;
+  <a href="#tui-interface" style="color: #0366d6;">💻 TUI Interface</a> &nbsp;&nbsp;|&nbsp;&nbsp;
+  <a href="#docker-deployment" style="color: #0366d6;">🐳 Docker Deployment</a> &nbsp;&nbsp;|&nbsp;&nbsp;
+  <a href="#development" style="color: #0366d6;">⚙️ Development</a> &nbsp;&nbsp;|&nbsp;&nbsp;
+  <a href="#troubleshooting" style="color: #0366d6;">🔧 Troubleshooting</a>
+</div>
+
+
+
+OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables intelligent document search and AI-powered conversations. Users can upload, process, and query documents through a chat interface backed by large language models and semantic search capabilities. The system utilizes Langflow for document ingestion, retrieval workflows, and intelligent nudges, providing a seamless RAG experience. Built with Starlette, Next.js, OpenSearch, and Langflow integration. [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/phact/openrag)
+
+
+<div align="center">
+  <a href="https://github.com/langflow-ai/langflow"><img src="https://img.shields.io/badge/Langflow-1C1C1E?style=flat&logo=langflow" alt="Langflow"></a>
+  &nbsp;&nbsp;
+  <a href="https://github.com/opensearch-project/OpenSearch"><img src="https://img.shields.io/badge/OpenSearch-005EB8?style=flat&logo=opensearch&logoColor=white" alt="OpenSearch"></a>
+  &nbsp;&nbsp;
+  <a href="https://github.com/encode/starlette"><img src="https://img.shields.io/badge/Starlette-009639?style=flat&logo=fastapi&logoColor=white" alt="Starlette"></a>
+  &nbsp;&nbsp;
+  <a href="https://github.com/vercel/next.js"><img src="https://img.shields.io/badge/Next.js-000000?style=flat&logo=next.js&logoColor=white" alt="Next.js"></a>
+
+</div>
+
+
+
+
+
+
+## 🚀 Quick Start
+
+### Prerequisites
+
+- Docker or Podman with Compose installed
+- Make (for development commands)
+
+### 1. Environment Setup
+
+```bash
+# Clone and setup environment
+git clone https://github.com/langflow-ai/openrag.git
+cd openrag
+make setup  # Creates .env and installs dependencies
+```
+
+### 2. Configure Environment
+
+Edit `.env` with your API keys and credentials:
+
+```bash
+# Required
+OPENAI_API_KEY=your_openai_api_key
+OPENSEARCH_PASSWORD=your_secure_password
+LANGFLOW_SUPERUSER=admin
+LANGFLOW_SUPERUSER_PASSWORD=your_secure_password
+LANGFLOW_CHAT_FLOW_ID=your_chat_flow_id
+LANGFLOW_INGEST_FLOW_ID=your_ingest_flow_id
+NUDGES_FLOW_ID=your_nudges_flow_id
+```
+ee extended configuration, including ingestion and optional variables: [docs/configuration.md](docs/
+configuration.md)
+### 3. Start OpenRAG
+
+```bash
+# Full stack with GPU support
+make dev
+
+# Or CPU only
+make dev-cpu
+```
+
+Access the services:
+- **Frontend**: http://localhost:3000
+- **Backend API**: http://localhost:8000
+- **Langflow**: http://localhost:7860
+- **OpenSearch**: http://localhost:9200
+- **OpenSearch Dashboards**: http://localhost:5601
+
+## 🖥️ TUI Interface
+
+OpenRAG includes a powerful Terminal User Interface (TUI) for easy setup, configuration, and monitoring. The TUI provides a user-friendly way to manage your OpenRAG installation without complex command-line operations.
+
+![OpenRAG TUI Interface](assets/OpenRAG_TUI_2025-09-10T13_04_11_757637.svg)
+
+### Launching the TUI
+
+```bash
+# Install dependencies first
+uv sync
+
+# Launch the TUI
+uv run openrag
+```
+
+### TUI Features
+
+See the full TUI guide for features, navigation, and benefits: [docs/tui.md](docs/tui.md)
+
+
+
+
+## 🐳 Docker Deployment
+
+### Standard Deployment
+
+```bash
+# Build and start all services
+docker compose build
+docker compose up -d
+```
+
+### CPU-Only Deployment
+
+For environments without GPU support:
+
+```bash
+docker compose -f docker-compose-cpu.yml up -d
+```
+
+More deployment commands and tips: [docs/docker.md](docs/docker.md)
+
+## 🔧 Troubleshooting
+
+### Podman on macOS
+
+If using Podman on macOS, you may need to increase VM memory:
+
+```bash
+podman machine stop
+podman machine rm
+podman machine init --memory 8192   # 8 GB example
+podman machine start
+```
+
+### Common Issues
+
+See common issues and fixes: [docs/troubleshooting.md](docs/troubleshooting.md)
+
+
+
+## 🛠️ Development
+
+For developers wanting to contribute to OpenRAG or set up a development environment, please see our comprehensive development guide:
+
+**[📚 See CONTRIBUTING.md for detailed development instructions](CONTRIBUTING.md)**
+
+The contributing guide includes:
+- Complete development environment setup
+- Local development workflows  
+- Testing and debugging procedures
+- Code style guidelines
+- Architecture overview
+- Pull request guidelines
+
+### Quick Development Commands
+
+```bash
+make help                    # See all available commands
+make setup                   # Initial development setup
+make infra                   # Start infrastructure services
+make backend                 # Run backend locally
+make frontend                # Run frontend locally
+```

openrag-0.1.8/README.md

@@ -0,0 +1,168 @@
+<div align="center">
+
+# OpenRAG
+
+</div>
+<div align="center">
+  <a href="#quick-start" style="color: #0366d6;">🚀 Quick Start</a> &nbsp;&nbsp;|&nbsp;&nbsp;
+  <a href="#tui-interface" style="color: #0366d6;">💻 TUI Interface</a> &nbsp;&nbsp;|&nbsp;&nbsp;
+  <a href="#docker-deployment" style="color: #0366d6;">🐳 Docker Deployment</a> &nbsp;&nbsp;|&nbsp;&nbsp;
+  <a href="#development" style="color: #0366d6;">⚙️ Development</a> &nbsp;&nbsp;|&nbsp;&nbsp;
+  <a href="#troubleshooting" style="color: #0366d6;">🔧 Troubleshooting</a>
+</div>
+
+
+
+OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables intelligent document search and AI-powered conversations. Users can upload, process, and query documents through a chat interface backed by large language models and semantic search capabilities. The system utilizes Langflow for document ingestion, retrieval workflows, and intelligent nudges, providing a seamless RAG experience. Built with Starlette, Next.js, OpenSearch, and Langflow integration. [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/phact/openrag)
+
+
+<div align="center">
+  <a href="https://github.com/langflow-ai/langflow"><img src="https://img.shields.io/badge/Langflow-1C1C1E?style=flat&logo=langflow" alt="Langflow"></a>
+  &nbsp;&nbsp;
+  <a href="https://github.com/opensearch-project/OpenSearch"><img src="https://img.shields.io/badge/OpenSearch-005EB8?style=flat&logo=opensearch&logoColor=white" alt="OpenSearch"></a>
+  &nbsp;&nbsp;
+  <a href="https://github.com/encode/starlette"><img src="https://img.shields.io/badge/Starlette-009639?style=flat&logo=fastapi&logoColor=white" alt="Starlette"></a>
+  &nbsp;&nbsp;
+  <a href="https://github.com/vercel/next.js"><img src="https://img.shields.io/badge/Next.js-000000?style=flat&logo=next.js&logoColor=white" alt="Next.js"></a>
+
+</div>
+
+
+
+
+
+
+## 🚀 Quick Start
+
+### Prerequisites
+
+- Docker or Podman with Compose installed
+- Make (for development commands)
+
+### 1. Environment Setup
+
+```bash
+# Clone and setup environment
+git clone https://github.com/langflow-ai/openrag.git
+cd openrag
+make setup  # Creates .env and installs dependencies
+```
+
+### 2. Configure Environment
+
+Edit `.env` with your API keys and credentials:
+
+```bash
+# Required
+OPENAI_API_KEY=your_openai_api_key
+OPENSEARCH_PASSWORD=your_secure_password
+LANGFLOW_SUPERUSER=admin
+LANGFLOW_SUPERUSER_PASSWORD=your_secure_password
+LANGFLOW_CHAT_FLOW_ID=your_chat_flow_id
+LANGFLOW_INGEST_FLOW_ID=your_ingest_flow_id
+NUDGES_FLOW_ID=your_nudges_flow_id
+```
+ee extended configuration, including ingestion and optional variables: [docs/configuration.md](docs/
+configuration.md)
+### 3. Start OpenRAG
+
+```bash
+# Full stack with GPU support
+make dev
+
+# Or CPU only
+make dev-cpu
+```
+
+Access the services:
+- **Frontend**: http://localhost:3000
+- **Backend API**: http://localhost:8000
+- **Langflow**: http://localhost:7860
+- **OpenSearch**: http://localhost:9200
+- **OpenSearch Dashboards**: http://localhost:5601
+
+## 🖥️ TUI Interface
+
+OpenRAG includes a powerful Terminal User Interface (TUI) for easy setup, configuration, and monitoring. The TUI provides a user-friendly way to manage your OpenRAG installation without complex command-line operations.
+
+![OpenRAG TUI Interface](assets/OpenRAG_TUI_2025-09-10T13_04_11_757637.svg)
+
+### Launching the TUI
+
+```bash
+# Install dependencies first
+uv sync
+
+# Launch the TUI
+uv run openrag
+```
+
+### TUI Features
+
+See the full TUI guide for features, navigation, and benefits: [docs/tui.md](docs/tui.md)
+
+
+
+
+## 🐳 Docker Deployment
+
+### Standard Deployment
+
+```bash
+# Build and start all services
+docker compose build
+docker compose up -d
+```
+
+### CPU-Only Deployment
+
+For environments without GPU support:
+
+```bash
+docker compose -f docker-compose-cpu.yml up -d
+```
+
+More deployment commands and tips: [docs/docker.md](docs/docker.md)
+
+## 🔧 Troubleshooting
+
+### Podman on macOS
+
+If using Podman on macOS, you may need to increase VM memory:
+
+```bash
+podman machine stop
+podman machine rm
+podman machine init --memory 8192   # 8 GB example
+podman machine start
+```
+
+### Common Issues
+
+See common issues and fixes: [docs/troubleshooting.md](docs/troubleshooting.md)
+
+
+
+## 🛠️ Development
+
+For developers wanting to contribute to OpenRAG or set up a development environment, please see our comprehensive development guide:
+
+**[📚 See CONTRIBUTING.md for detailed development instructions](CONTRIBUTING.md)**
+
+The contributing guide includes:
+- Complete development environment setup
+- Local development workflows  
+- Testing and debugging procedures
+- Code style guidelines
+- Architecture overview
+- Pull request guidelines
+
+### Quick Development Commands
+
+```bash
+make help                    # See all available commands
+make setup                   # Initial development setup
+make infra                   # Start infrastructure services
+make backend                 # Run backend locally
+make frontend                # Run frontend locally
+```

openrag-0.1.8/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+name = "openrag"
+version = "0.1.8"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "agentd>=0.2.2",
+    "aiofiles>=24.1.0",
+    "cryptography>=45.0.6",
+    "docling[vlm]>=2.41.0; sys_platform != 'darwin'",
+    "docling[ocrmac,vlm]>=2.41.0; sys_platform == 'darwin'",
+    "google-api-python-client>=2.143.0",
+    "google-auth-httplib2>=0.2.0",
+    "google-auth-oauthlib>=1.2.0",
+    "msal>=1.29.0",
+    "httpx>=0.27.0",
+    "opensearch-py[async]>=3.0.0",
+    "pyjwt>=2.8.0",
+    "python-multipart>=0.0.20",
+    "starlette>=0.47.1",
+    "torch>=2.7.1",
+    "uvicorn>=0.35.0",
+    "boto3>=1.35.0",
+    "psutil>=7.0.0",
+    "rich>=13.0.0",
+    "textual>=0.45.0",
+    "python-dotenv>=1.0.0",
+    "textual-fspicker>=0.6.0",
+    "structlog>=25.4.0",
+    "docling-serve>=1.4.1",
+]
+
+[project.scripts]
+openrag = "tui.main:run_tui"
+
+[tool.uv]
+package = true
+
+
+[tool.uv.sources]
+torch = [
+  { index = "pytorch-cu128", marker = "sys_platform == 'linux' and platform_machine == 'x86_64'" },
+]
+torchvision = [
+  { index = "pytorch-cu128", marker = "sys_platform == 'linux' and platform_machine == 'x86_64'" },
+]
+
+[[tool.uv.index]]
+name     = "pytorch-cu128"
+url      = "https://download.pytorch.org/whl/cu128"
+explicit = true

openrag-0.1.8/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+