local-deep-research 0.3.1__tar.gz → 0.3.3__tar.gz

local_deep_research-0.3.3/PKG-INFO

@@ -0,0 +1,349 @@
+Metadata-Version: 2.1
+Name: local-deep-research
+Version: 0.3.3
+Summary: AI-powered research assistant with deep, iterative analysis using LLMs and web searches
+Author-Email: LearningCircuit <185559241+LearningCircuit@users.noreply.github.com>, HashedViking <6432677+HashedViking@users.noreply.github.com>
+License: MIT License
+         
+         Copyright (c) 2025 LearningCircuit
+         
+         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.
+         
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Project-URL: Homepage, https://github.com/LearningCircuit/local-deep-research
+Project-URL: Bug Tracker, https://github.com/LearningCircuit/local-deep-research/issues
+Requires-Python: >=3.10
+Requires-Dist: langchain>=0.3.18
+Requires-Dist: langchain-community>=0.3.17
+Requires-Dist: langchain-core>=0.3.34
+Requires-Dist: langchain-ollama>=0.2.3
+Requires-Dist: langchain-openai>=0.3.5
+Requires-Dist: langchain_anthropic>=0.3.7
+Requires-Dist: duckduckgo_search>=7.3.2
+Requires-Dist: python-dateutil>=2.9.0
+Requires-Dist: typing_extensions>=4.12.2
+Requires-Dist: justext
+Requires-Dist: playwright
+Requires-Dist: beautifulsoup4
+Requires-Dist: flask>=3.1.0
+Requires-Dist: flask-cors>=3.0.10
+Requires-Dist: flask-socketio>=5.1.1
+Requires-Dist: sqlalchemy>=1.4.23
+Requires-Dist: wikipedia
+Requires-Dist: arxiv>=1.4.3
+Requires-Dist: pypdf
+Requires-Dist: sentence-transformers
+Requires-Dist: faiss-cpu
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: toml>=0.10.2
+Requires-Dist: platformdirs>=3.0.0
+Requires-Dist: dynaconf
+Requires-Dist: requests>=2.28.0
+Requires-Dist: tiktoken>=0.4.0
+Requires-Dist: xmltodict>=0.13.0
+Requires-Dist: lxml>=4.9.2
+Requires-Dist: pdfplumber>=0.9.0
+Requires-Dist: unstructured>=0.10.0
+Requires-Dist: google-search-results
+Requires-Dist: importlib-resources>=6.5.2
+Requires-Dist: setuptools>=78.1.0
+Requires-Dist: flask-wtf>=1.2.2
+Description-Content-Type: text/markdown
+
+# Local Deep Research
+
+<div align="center">
+
+[![GitHub stars](https://img.shields.io/github/stars/LearningCircuit/local-deep-research?style=for-the-badge)](https://github.com/LearningCircuit/local-deep-research/stargazers)
+[![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](LICENSE)
+[![Discord](https://img.shields.io/discord/1352043059562680370?style=for-the-badge&logo=discord)](https://discord.gg/ttcqQeFcJ3)
+[![Reddit](https://img.shields.io/badge/Reddit-r/LocalDeepResearch-FF4500?style=for-the-badge&logo=reddit)](https://www.reddit.com/r/LocalDeepResearch/)
+
+*AI-powered research assistant that performs deep, iterative analysis using multiple LLMs and web searches*
+
+<a href="https://www.youtube.com/watch?v=0ISreg9q0p0">
+  <img src="https://img.youtube.com/vi/0ISreg9q0p0/0.jpg" alt="Local Deep Research Demo" width="500">
+</a>
+
+</div>
+
+## 📋 Overview
+
+Local Deep Research is a powerful AI research assistant that:
+
+1. **Performs iterative, multi-source research** on any topic
+2. **Creates comprehensive reports or quick summaries** with proper citations
+3. **Runs locally** for complete privacy when using local LLMs
+4. **Searches across multiple sources** including academic databases & the web
+5. **Processes your own documents** with vector search (RAG)
+6. **Optimized for speed** with parallel search processing
+
+Local Deep Research combines the power of large language models with intelligent search strategies to provide well-researched, properly cited answers to complex questions. It can process queries in just seconds with the Quick Summary option, or create detailed reports with proper section organization for more comprehensive analysis.
+
+## ⚡ Quick Start (Recommended)
+
+```bash
+# 1. Install
+pip install local-deep-research
+
+# 2. Setup SearXNG for best results
+docker pull searxng/searxng
+docker run -d -p 8080:8080 --name searxng searxng/searxng
+docker start searxng (required after every reboot)
+
+# 3. Install Ollama and pull a model
+# Download from https://ollama.ai and run:
+ollama pull gemma3:12b
+
+# 4. Start the web interface
+python -m local_deep_research.web.app
+```
+
+Then visit `http://127.0.0.1:5000` to start researching!
+
+### Alternative Installation Options
+
+**Windows Installer**: Download the [Windows Installer](https://github.com/LearningCircuit/local-deep-research/releases/download/v0.1.0/LocalDeepResearch_Setup.exe) for one-click setup.
+
+**Docker**: Run with Docker using:
+```bash
+docker run --network=host \
+  local-deep-research
+```
+
+**Command Line**: Alternatively, use the CLI version with:
+```bash
+python -m local_deep_research.main
+```
+
+## 🔍 Research Capabilities
+
+### Two Research Modes
+
+- **Quick Summary**: Fast results (30s-3min) with key information and proper citations
+  - Perfect for rapid exploration and answering straightforward questions
+  - Supports multiple search engines in parallel for maximum efficiency
+  - Tables and structured information can be included when relevant
+
+- **Detailed Report**: Comprehensive analysis with structured sections, table of contents, and in-depth exploration
+  - Creates professional-grade reports with proper organization
+  - Conducts separate research for each section to ensure comprehensive coverage
+  - Integrates information across sections for a cohesive analysis
+  - Includes proper citations and reference tracking
+
+### Performance Optimization
+
+- **Use Direct SearXNG**: For maximum speed (bypasses LLM calls needed for engine selection)
+- **Adjust Iteration Depth**:
+  - 1 iteration: Quick factual questions (~30 seconds)
+  - 2-3 iterations: Complex topics requiring deeper exploration (2-3 minutes)
+  - 3-5 iterations: Comprehensive research with follow-up investigation (5+ minutes)
+- **Choose Appropriate Models**:
+  - 12B-30B parameter models offer good balance of quality and speed
+  - For complex research, larger models may provide better synthesis
+- **For Detailed Reports**: Expect multiple research cycles (one per section) and longer processing times
+
+### Multi-Source Integration
+
+- **Auto-Engine Selection**: The system intelligently selects the most appropriate search engines for your query
+- **Academic Sources**: Direct access to Wikipedia, arXiv, PubMed, Semantic Scholar, and more
+- **Web Search**: Via SearXNG, Brave Search, SerpAPI (for Google results), and more
+- **Local Document Search**: Search through your private document collections with vector embeddings
+- **Cross-Engine Filtering**: Smart result ranking across search engines for better information quality
+
+## 🤖 LLM Support
+
+Local Deep Research works with both local and cloud LLMs:
+
+### Local Models (via Ollama)
+
+Local models provide complete privacy and don't require API keys or internet connection for the LLM component (only search queries go online).
+
+```bash
+# Install Ollama from https://ollama.ai
+ollama pull gemma3:12b  # Recommended model
+```
+
+Recommended local models:
+- **Gemma 3 (12B)** - Great balance of quality and speed
+- **Mistral (7B/8x7B)** - Fast performance on most hardware
+- **Llama 3 (8B/70B)** - Good performance across various tasks
+
+### Cloud Models
+
+Cloud models can provide higher quality results for complex research tasks:
+
+API keys can be configured directly through the web interface in the settings panel or via environment variables:
+
+```bash
+# Cloud LLM providers - add to your .env file if not using the web UI
+LDR_LLM_ANTHROPIC_API_KEY=your-api-key-here      # For Claude models
+LDR_LLM_OPENAI_API_KEY=your-openai-key-here      # For GPT models
+LDR_LLM_OPENAI_ENDPOINT_API_KEY=your-key-here    # For OpenRouter or similar services
+
+# Set your preferred provider and model
+LDR_LLM_PROVIDER=ollama                 # Options: ollama, openai, anthropic, etc.
+LDR_LLM_MODEL=gemma3:12b                # Model name to use
+```
+
+### Supported Providers
+
+| Provider | Type | Setup | Models |
+|----------|------|---------|--------|
+| `OLLAMA` | Local | Install from [ollama.ai](https://ollama.ai) | Mistral, Llama, Gemma, etc. |
+| `OPENAI` | Cloud | API key required | GPT-3.5, GPT-4, GPT-4o |
+| `ANTHROPIC` | Cloud | API key required | Claude 3 Opus, Sonnet, Haiku |
+| `OPENAI_ENDPOINT` | Cloud | API key required | Any OpenAI-compatible API |
+| `VLLM` | Local | Requires GPU setup | Any supported by vLLM |
+| `LMSTUDIO` | Local | Use LM Studio server | Models from LM Studio |
+| `LLAMACPP` | Local | Configure model path | GGUF model formats |
+
+You can easily switch between models in the web interface or via environment variables without reinstalling.
+
+## 🌐 Search Engines
+
+The system leverages multiple search engines to find the most relevant information for your queries.
+
+### Core Free Engines (No API Key Required)
+
+- **`auto`**: Intelligently selects the best engines based on your query (recommended)
+- **`wikipedia`**: General knowledge, facts, and encyclopedic information
+- **`arxiv`**: Scientific papers and academic research
+- **`pubmed`**: Medical and biomedical research and journals
+- **`semantic_scholar`**: Academic literature across all fields
+- **`github`**: Code repositories, documentation, and technical discussions
+- **`searxng`**: Comprehensive web search via local SearXNG instance
+- **`wayback`**: Historical web content from Internet Archive
+
+### Paid Engines (API Key Required)
+
+For enhanced web search capabilities, you can configure these additional engines through the settings interface or via environment variables:
+
+```bash
+# Search API keys (if not using the web UI)
+SERP_API_KEY=your-key-here               # Google results via SerpAPI
+GOOGLE_PSE_API_KEY=your-key-here         # Google Programmable Search
+BRAVE_API_KEY=your-key-here              # Brave Search
+```
+
+### Search Engine Comparison
+
+| Engine | Specialization | Privacy | Speed | Results Quality |
+|--------|----------------|---------|-------|-----------------|
+| SearXNG | General web | ★★★★★ | ★★★★★ | ★★★★½ |
+| Wikipedia | Facts & concepts | ★★★★★ | ★★★★☆ | ★★★★☆ |
+| arXiv | Scientific research | ★★★★★ | ★★★★☆ | ★★★★★ |
+| PubMed | Medical research | ★★★★★ | ★★★★☆ | ★★★★★ |
+| GitHub | Code & tech | ★★★★★ | ★★★☆☆ | ★★★★☆ |
+| SerpAPI | Web (Google) | ★★☆☆☆ | ★★★★☆ | ★★★★★ |
+| Brave | Web (privacy-focused) | ★★★★☆ | ★★★★☆ | ★★★★☆ |
+
+## 📚 Local Document Search (RAG)
+
+Local Deep Research includes powerful Retrieval Augmented Generation (RAG) capabilities, allowing you to search and analyze your own private documents using vector embeddings:
+
+### Supported Document Types
+
+- PDF files
+- Markdown (.md)
+- Plain text (.txt)
+- Microsoft Word (.docx, .doc)
+- Excel spreadsheets (.xlsx, .xls)
+- CSV files
+- And more
+
+### Using Document Collections
+
+You can use your documents in research via:
+- Auto-selection (when relevant to query)
+- Direct collection selection: `tool = "project_docs"`
+- All collections: `tool = "local_all"`
+- Query syntax: `collection:project_docs your query`
+
+This allows you to integrate your private knowledge base with web search results for comprehensive research that includes your own documents and data.
+
+## 🛠️ Advanced Configuration
+
+### Web Interface
+
+The easiest way to configure Local Deep Research is through the web interface, which provides:
+- Complete settings management
+- Model selection
+- Search engine configuration
+- Research parameter adjustment
+- Local document collection setup
+
+### Configuration Documentation
+
+For detailed configuration options, see our guides:
+- [Environment Variables Guide](https://github.com/LearningCircuit/local-deep-research/blob/main/docs/env_configuration.md)
+- [SearXNG Setup Guide](https://github.com/LearningCircuit/local-deep-research/blob/main/docs/SearXNG-Setup.md)
+- [Docker Usage Guide](https://github.com/LearningCircuit/local-deep-research/blob/main/docs/docker-usage-readme.md)
+- [Docker Compose Guide](https://github.com/LearningCircuit/local-deep-research/blob/main/docs/docker-compose-guide.md)
+
+### Programmatic Access
+
+Use the Python API for integration with other tools or scripts:
+
+```python
+from local_deep_research import quick_summary, generate_report
+
+# Quick research with custom parameters
+results = quick_summary(
+    query="advances in fusion energy",
+    search_tool="auto",
+    iterations=1,
+    questions_per_iteration=2,
+    max_results=30,
+    temperature=0.7
+)
+print(results["summary"])
+```
+
+For more examples, see the [programmatic access tutorial](https://github.com/LearningCircuit/local-deep-research/blob/main/examples/programmatic_access.ipynb).
+
+## 📊 Examples & Documentation
+
+For more information and examples of what Local Deep Research can produce:
+
+- [Example Outputs](https://github.com/LearningCircuit/local-deep-research/tree/main/examples)
+- [Documentation](https://github.com/LearningCircuit/local-deep-research/tree/main/docs)
+- [Wiki](https://github.com/LearningCircuit/local-deep-research/wiki)
+
+## 🤝 Community & Support
+
+- [Discord](https://discord.gg/ttcqQeFcJ3): Discuss features, get help, and share research techniques
+- [Reddit](https://www.reddit.com/r/LocalDeepResearch/): Announcements, updates, and community showcase
+- [GitHub Issues](https://github.com/LearningCircuit/local-deep-research/issues): Bug reports and feature requests
+
+## 📄 License & Acknowledgments
+
+This project is licensed under the MIT License.
+
+Built with powerful open-source tools:
+- [LangChain](https://github.com/hwchase17/langchain) framework for LLM integration
+- [Ollama](https://ollama.ai) for local AI model management
+- [SearXNG](https://searxng.org/) for privacy-focused web search
+- [FAISS](https://github.com/facebookresearch/faiss) for vector similarity search
+- [justext](https://github.com/miso-belica/justext) and [Playwright](https://playwright.dev) for web content analysis
+
+> **Support Free Knowledge:** If you frequently use the search engines in this tool, please consider making a donation to organizations like [Wikipedia](https://donate.wikimedia.org), [arXiv](https://arxiv.org/about/give), or [PubMed](https://www.nlm.nih.gov/pubs/donations/donations.html).

local_deep_research-0.3.3/README.md

@@ -0,0 +1,278 @@
+# Local Deep Research
+
+<div align="center">
+
+[![GitHub stars](https://img.shields.io/github/stars/LearningCircuit/local-deep-research?style=for-the-badge)](https://github.com/LearningCircuit/local-deep-research/stargazers)
+[![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](LICENSE)
+[![Discord](https://img.shields.io/discord/1352043059562680370?style=for-the-badge&logo=discord)](https://discord.gg/ttcqQeFcJ3)
+[![Reddit](https://img.shields.io/badge/Reddit-r/LocalDeepResearch-FF4500?style=for-the-badge&logo=reddit)](https://www.reddit.com/r/LocalDeepResearch/)
+
+*AI-powered research assistant that performs deep, iterative analysis using multiple LLMs and web searches*
+
+<a href="https://www.youtube.com/watch?v=0ISreg9q0p0">
+  <img src="https://img.youtube.com/vi/0ISreg9q0p0/0.jpg" alt="Local Deep Research Demo" width="500">
+</a>
+
+</div>
+
+## 📋 Overview
+
+Local Deep Research is a powerful AI research assistant that:
+
+1. **Performs iterative, multi-source research** on any topic
+2. **Creates comprehensive reports or quick summaries** with proper citations
+3. **Runs locally** for complete privacy when using local LLMs
+4. **Searches across multiple sources** including academic databases & the web
+5. **Processes your own documents** with vector search (RAG)
+6. **Optimized for speed** with parallel search processing
+
+Local Deep Research combines the power of large language models with intelligent search strategies to provide well-researched, properly cited answers to complex questions. It can process queries in just seconds with the Quick Summary option, or create detailed reports with proper section organization for more comprehensive analysis.
+
+## ⚡ Quick Start (Recommended)
+
+```bash
+# 1. Install
+pip install local-deep-research
+
+# 2. Setup SearXNG for best results
+docker pull searxng/searxng
+docker run -d -p 8080:8080 --name searxng searxng/searxng
+docker start searxng (required after every reboot)
+
+# 3. Install Ollama and pull a model
+# Download from https://ollama.ai and run:
+ollama pull gemma3:12b
+
+# 4. Start the web interface
+python -m local_deep_research.web.app
+```
+
+Then visit `http://127.0.0.1:5000` to start researching!
+
+### Alternative Installation Options
+
+**Windows Installer**: Download the [Windows Installer](https://github.com/LearningCircuit/local-deep-research/releases/download/v0.1.0/LocalDeepResearch_Setup.exe) for one-click setup.
+
+**Docker**: Run with Docker using:
+```bash
+docker run --network=host \
+  local-deep-research
+```
+
+**Command Line**: Alternatively, use the CLI version with:
+```bash
+python -m local_deep_research.main
+```
+
+## 🔍 Research Capabilities
+
+### Two Research Modes
+
+- **Quick Summary**: Fast results (30s-3min) with key information and proper citations
+  - Perfect for rapid exploration and answering straightforward questions
+  - Supports multiple search engines in parallel for maximum efficiency
+  - Tables and structured information can be included when relevant
+
+- **Detailed Report**: Comprehensive analysis with structured sections, table of contents, and in-depth exploration
+  - Creates professional-grade reports with proper organization
+  - Conducts separate research for each section to ensure comprehensive coverage
+  - Integrates information across sections for a cohesive analysis
+  - Includes proper citations and reference tracking
+
+### Performance Optimization
+
+- **Use Direct SearXNG**: For maximum speed (bypasses LLM calls needed for engine selection)
+- **Adjust Iteration Depth**:
+  - 1 iteration: Quick factual questions (~30 seconds)
+  - 2-3 iterations: Complex topics requiring deeper exploration (2-3 minutes)
+  - 3-5 iterations: Comprehensive research with follow-up investigation (5+ minutes)
+- **Choose Appropriate Models**:
+  - 12B-30B parameter models offer good balance of quality and speed
+  - For complex research, larger models may provide better synthesis
+- **For Detailed Reports**: Expect multiple research cycles (one per section) and longer processing times
+
+### Multi-Source Integration
+
+- **Auto-Engine Selection**: The system intelligently selects the most appropriate search engines for your query
+- **Academic Sources**: Direct access to Wikipedia, arXiv, PubMed, Semantic Scholar, and more
+- **Web Search**: Via SearXNG, Brave Search, SerpAPI (for Google results), and more
+- **Local Document Search**: Search through your private document collections with vector embeddings
+- **Cross-Engine Filtering**: Smart result ranking across search engines for better information quality
+
+## 🤖 LLM Support
+
+Local Deep Research works with both local and cloud LLMs:
+
+### Local Models (via Ollama)
+
+Local models provide complete privacy and don't require API keys or internet connection for the LLM component (only search queries go online).
+
+```bash
+# Install Ollama from https://ollama.ai
+ollama pull gemma3:12b  # Recommended model
+```
+
+Recommended local models:
+- **Gemma 3 (12B)** - Great balance of quality and speed
+- **Mistral (7B/8x7B)** - Fast performance on most hardware
+- **Llama 3 (8B/70B)** - Good performance across various tasks
+
+### Cloud Models
+
+Cloud models can provide higher quality results for complex research tasks:
+
+API keys can be configured directly through the web interface in the settings panel or via environment variables:
+
+```bash
+# Cloud LLM providers - add to your .env file if not using the web UI
+LDR_LLM_ANTHROPIC_API_KEY=your-api-key-here      # For Claude models
+LDR_LLM_OPENAI_API_KEY=your-openai-key-here      # For GPT models
+LDR_LLM_OPENAI_ENDPOINT_API_KEY=your-key-here    # For OpenRouter or similar services
+
+# Set your preferred provider and model
+LDR_LLM_PROVIDER=ollama                 # Options: ollama, openai, anthropic, etc.
+LDR_LLM_MODEL=gemma3:12b                # Model name to use
+```
+
+### Supported Providers
+
+| Provider | Type | Setup | Models |
+|----------|------|---------|--------|
+| `OLLAMA` | Local | Install from [ollama.ai](https://ollama.ai) | Mistral, Llama, Gemma, etc. |
+| `OPENAI` | Cloud | API key required | GPT-3.5, GPT-4, GPT-4o |
+| `ANTHROPIC` | Cloud | API key required | Claude 3 Opus, Sonnet, Haiku |
+| `OPENAI_ENDPOINT` | Cloud | API key required | Any OpenAI-compatible API |
+| `VLLM` | Local | Requires GPU setup | Any supported by vLLM |
+| `LMSTUDIO` | Local | Use LM Studio server | Models from LM Studio |
+| `LLAMACPP` | Local | Configure model path | GGUF model formats |
+
+You can easily switch between models in the web interface or via environment variables without reinstalling.
+
+## 🌐 Search Engines
+
+The system leverages multiple search engines to find the most relevant information for your queries.
+
+### Core Free Engines (No API Key Required)
+
+- **`auto`**: Intelligently selects the best engines based on your query (recommended)
+- **`wikipedia`**: General knowledge, facts, and encyclopedic information
+- **`arxiv`**: Scientific papers and academic research
+- **`pubmed`**: Medical and biomedical research and journals
+- **`semantic_scholar`**: Academic literature across all fields
+- **`github`**: Code repositories, documentation, and technical discussions
+- **`searxng`**: Comprehensive web search via local SearXNG instance
+- **`wayback`**: Historical web content from Internet Archive
+
+### Paid Engines (API Key Required)
+
+For enhanced web search capabilities, you can configure these additional engines through the settings interface or via environment variables:
+
+```bash
+# Search API keys (if not using the web UI)
+SERP_API_KEY=your-key-here               # Google results via SerpAPI
+GOOGLE_PSE_API_KEY=your-key-here         # Google Programmable Search
+BRAVE_API_KEY=your-key-here              # Brave Search
+```
+
+### Search Engine Comparison
+
+| Engine | Specialization | Privacy | Speed | Results Quality |
+|--------|----------------|---------|-------|-----------------|
+| SearXNG | General web | ★★★★★ | ★★★★★ | ★★★★½ |
+| Wikipedia | Facts & concepts | ★★★★★ | ★★★★☆ | ★★★★☆ |
+| arXiv | Scientific research | ★★★★★ | ★★★★☆ | ★★★★★ |
+| PubMed | Medical research | ★★★★★ | ★★★★☆ | ★★★★★ |
+| GitHub | Code & tech | ★★★★★ | ★★★☆☆ | ★★★★☆ |
+| SerpAPI | Web (Google) | ★★☆☆☆ | ★★★★☆ | ★★★★★ |
+| Brave | Web (privacy-focused) | ★★★★☆ | ★★★★☆ | ★★★★☆ |
+
+## 📚 Local Document Search (RAG)
+
+Local Deep Research includes powerful Retrieval Augmented Generation (RAG) capabilities, allowing you to search and analyze your own private documents using vector embeddings:
+
+### Supported Document Types
+
+- PDF files
+- Markdown (.md)
+- Plain text (.txt)
+- Microsoft Word (.docx, .doc)
+- Excel spreadsheets (.xlsx, .xls)
+- CSV files
+- And more
+
+### Using Document Collections
+
+You can use your documents in research via:
+- Auto-selection (when relevant to query)
+- Direct collection selection: `tool = "project_docs"`
+- All collections: `tool = "local_all"`
+- Query syntax: `collection:project_docs your query`
+
+This allows you to integrate your private knowledge base with web search results for comprehensive research that includes your own documents and data.
+
+## 🛠️ Advanced Configuration
+
+### Web Interface
+
+The easiest way to configure Local Deep Research is through the web interface, which provides:
+- Complete settings management
+- Model selection
+- Search engine configuration
+- Research parameter adjustment
+- Local document collection setup
+
+### Configuration Documentation
+
+For detailed configuration options, see our guides:
+- [Environment Variables Guide](https://github.com/LearningCircuit/local-deep-research/blob/main/docs/env_configuration.md)
+- [SearXNG Setup Guide](https://github.com/LearningCircuit/local-deep-research/blob/main/docs/SearXNG-Setup.md)
+- [Docker Usage Guide](https://github.com/LearningCircuit/local-deep-research/blob/main/docs/docker-usage-readme.md)
+- [Docker Compose Guide](https://github.com/LearningCircuit/local-deep-research/blob/main/docs/docker-compose-guide.md)
+
+### Programmatic Access
+
+Use the Python API for integration with other tools or scripts:
+
+```python
+from local_deep_research import quick_summary, generate_report
+
+# Quick research with custom parameters
+results = quick_summary(
+    query="advances in fusion energy",
+    search_tool="auto",
+    iterations=1,
+    questions_per_iteration=2,
+    max_results=30,
+    temperature=0.7
+)
+print(results["summary"])
+```
+
+For more examples, see the [programmatic access tutorial](https://github.com/LearningCircuit/local-deep-research/blob/main/examples/programmatic_access.ipynb).
+
+## 📊 Examples & Documentation
+
+For more information and examples of what Local Deep Research can produce:
+
+- [Example Outputs](https://github.com/LearningCircuit/local-deep-research/tree/main/examples)
+- [Documentation](https://github.com/LearningCircuit/local-deep-research/tree/main/docs)
+- [Wiki](https://github.com/LearningCircuit/local-deep-research/wiki)
+
+## 🤝 Community & Support
+
+- [Discord](https://discord.gg/ttcqQeFcJ3): Discuss features, get help, and share research techniques
+- [Reddit](https://www.reddit.com/r/LocalDeepResearch/): Announcements, updates, and community showcase
+- [GitHub Issues](https://github.com/LearningCircuit/local-deep-research/issues): Bug reports and feature requests
+
+## 📄 License & Acknowledgments
+
+This project is licensed under the MIT License.
+
+Built with powerful open-source tools:
+- [LangChain](https://github.com/hwchase17/langchain) framework for LLM integration
+- [Ollama](https://ollama.ai) for local AI model management
+- [SearXNG](https://searxng.org/) for privacy-focused web search
+- [FAISS](https://github.com/facebookresearch/faiss) for vector similarity search
+- [justext](https://github.com/miso-belica/justext) and [Playwright](https://playwright.dev) for web content analysis
+
+> **Support Free Knowledge:** If you frequently use the search engines in this tool, please consider making a donation to organizations like [Wikipedia](https://donate.wikimedia.org), [arXiv](https://arxiv.org/about/give), or [PubMed](https://www.nlm.nih.gov/pubs/donations/donations.html).

{local_deep_research-0.3.1 → local_deep_research-0.3.3}/pyproject.toml

@@ -57,7 +57,7 @@ dependencies = [
     "setuptools>=78.1.0",
     "flask-wtf>=1.2.2",
 ]
-version = "0.3.1"
+version = "0.3.3"
 
 [project.license]
 file = "LICENSE"

local_deep_research-0.3.3/src/local_deep_research/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.3.3"

{local_deep_research-0.3.1 → local_deep_research-0.3.3}/src/local_deep_research/advanced_search_system/filters/cross_engine_filter.py

@@ -31,7 +31,7 @@ class CrossEngineFilter(BaseFilter):
         super().__init__(model)
         # Get max_results from database settings if not provided
         if max_results is None:
-            max_results = get_db_setting("search.cross_engine_max_results", 100)
+            max_results = int(get_db_setting("search.cross_engine_max_results", 100))
         self.max_results = max_results
         self.default_reorder = default_reorder
         self.default_reindex = default_reindex

{local_deep_research-0.3.1 → local_deep_research-0.3.3}/src/local_deep_research/config/llm_config.py

@@ -3,6 +3,7 @@ import os
 
 from langchain_anthropic import ChatAnthropic
 from langchain_community.llms import VLLM
+from langchain_core.language_models import FakeListChatModel
 from langchain_ollama import ChatOllama
 from langchain_openai import ChatOpenAI
 
@@ -248,9 +249,7 @@ def get_llm(model_name=None, temperature=None, provider=None, openai_endpoint_ur
 
 def get_fallback_model(temperature=None):
     """Create a dummy model for when no providers are available"""
-    from langchain_community.llms.fake import FakeListLLM
-
-    return FakeListLLM(
+    return FakeListChatModel(
         responses=[
             "No language models are available. Please install Ollama or set up API keys."
         ]

{local_deep_research-0.3.1 → local_deep_research-0.3.3}/src/local_deep_research/defaults/default_settings.json

@@ -10,7 +10,7 @@
         "step": null,
         "type": "APP",
         "ui_element": "text",
-        "value": "0.3.0",
+        "value": "0.3.3",
         "visible": false
     },
     "app.debug": {