local-deep-research 0.5.7__tar.gz → 0.6.0__tar.gz

local_deep_research-0.6.0/PKG-INFO

@@ -0,0 +1,374 @@
+Metadata-Version: 2.1
+Name: local-deep-research
+Version: 0.6.0
+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>, djpetti <djpetti@gmail.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.13
+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
+Requires-Dist: optuna>=4.3.0
+Requires-Dist: elasticsearch==8.14.0
+Requires-Dist: methodtools>=0.4.7
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: cachetools>=5.5.2
+Requires-Dist: matplotlib>=3.10.3
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: plotly>=6.0.1
+Requires-Dist: kaleido==0.2.1
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: tenacity>=8.0.0
+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)
+[![Docker Pulls](https://img.shields.io/docker/pulls/localdeepresearch/local-deep-research?style=for-the-badge)](https://hub.docker.com/r/localdeepresearch/local-deep-research)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/local-deep-research?style=for-the-badge)](https://pypi.org/project/local-deep-research/)
+
+[![Tests](https://img.shields.io/github/actions/workflow/status/LearningCircuit/local-deep-research/tests.yml?branch=main&style=for-the-badge&label=Tests)](https://github.com/LearningCircuit/local-deep-research/actions/workflows/tests.yml)
+[![CodeQL](https://img.shields.io/github/actions/workflow/status/LearningCircuit/local-deep-research/codeql.yml?branch=main&style=for-the-badge&label=CodeQL)](https://github.com/LearningCircuit/local-deep-research/security/code-scanning)
+
+[![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 for deep, iterative research**
+
+*Performs deep, iterative research using multiple LLMs and search engines with proper citations*
+</div>
+## 🚀 What is Local Deep Research?
+
+LDR is an AI research assistant that performs systematic research by:
+
+- **Breaking down complex questions** into focused sub-queries
+- **Searching multiple sources** in parallel (web, academic papers, local documents)
+- **Verifying information** across sources for accuracy
+- **Creating comprehensive reports** with proper citations
+
+It aims to help researchers, students, and professionals find accurate information quickly while maintaining transparency about sources.
+
+## 🎯 Why Choose LDR?
+
+- **Privacy-Focused**: Run entirely locally with Ollama + SearXNG
+- **Flexible**: Use any LLM, any search engine, any vector store
+- **Comprehensive**: Multiple research modes from quick summaries to detailed reports
+- **Transparent**: Track costs and performance with built-in analytics
+- **Open Source**: MIT licensed with an active community
+
+## ✨ Key Features
+
+### 🔍 Research Modes
+- **Quick Summary** - Get answers in 30 seconds to 3 minutes with citations
+- **Detailed Research** - Comprehensive analysis with structured findings
+- **Report Generation** - Professional reports with sections and table of contents
+- **Document Analysis** - Search your private documents with AI
+
+### 🛠️ Advanced Capabilities
+- **[LangChain Integration](docs/LANGCHAIN_RETRIEVER_INTEGRATION.md)** - Use any vector store as a search engine
+- **[REST API](docs/api-quickstart.md)** - Language-agnostic HTTP access
+- **[Benchmarking](docs/BENCHMARKING.md)** - Test and optimize your configuration
+- **[Analytics Dashboard](docs/analytics-dashboard.md)** - Track costs, performance, and usage metrics
+- **Real-time Updates** - WebSocket support for live research progress
+- **Export Options** - Download results as PDF or Markdown
+- **Research History** - Save, search, and revisit past research
+- **Adaptive Rate Limiting** - Intelligent retry system that learns optimal wait times
+- **Keyboard Shortcuts** - Navigate efficiently (ESC, Ctrl+Shift+1-5)
+
+### 🌐 Search Sources
+
+#### Free Search Engines
+- **Academic**: arXiv, PubMed, Semantic Scholar
+- **General**: Wikipedia, SearXNG, DuckDuckGo
+- **Technical**: GitHub, Elasticsearch
+- **Historical**: Wayback Machine
+- **News**: The Guardian
+
+#### Premium Search Engines
+- **Tavily** - AI-powered search
+- **Google** - Via SerpAPI or Programmable Search Engine
+- **Brave Search** - Privacy-focused web search
+
+#### Custom Sources
+- **Local Documents** - Search your files with AI
+- **LangChain Retrievers** - Any vector store or database
+- **Meta Search** - Combine multiple engines intelligently
+
+[Full Search Engines Guide →](docs/search-engines.md)
+
+## ⚡ Quick Start
+
+### Option 1: Docker (Quickstart no MAC/ARM)
+
+```bash
+# Step 1: Pull and run SearXNG for optimal search results
+docker run -d -p 8080:8080 --name searxng searxng/searxng
+
+# Step 2: Pull and run Local Deep Research (Please build your own docker on ARM)
+docker run -d -p 5000:5000 --name local-deep-research --volume 'deep-research:/install/.venv/lib/python3.13/site-packages/data/' localdeepresearch/local-deep-research
+```
+
+### Option 2: Docker Compose (Recommended)
+
+LDR uses Docker compose to bundle the web app and all it's dependencies so
+you can get up and running quickly.
+
+#### Option 2a: DIY docker-compose
+See [docker-compose.yml](./docker-compose.yml) for a docker-compose file with reasonable defaults to get up and running with ollama, searxng, and local deep research all running locally.
+
+Things you may want/need to configure:
+* Ollama GPU driver
+* Ollama context length (depends on available VRAM)
+* Ollama keep alive (duration model will stay loaded into VRAM and idle before getting unloaded automatically)
+* Deep Research model (depends on available VRAM and preference)
+
+#### Option 2b: Use Cookie Cutter to tailor a docker-compose to your needs:
+
+##### Prerequisites
+
+- [Docker](https://docs.docker.com/engine/install/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+- `cookiecutter`: Run `pip install --user cookiecutter`
+
+Clone the repository:
+
+```bash
+git clone https://github.com/LearningCircuit/local-deep-research.git
+cd local-deep-research
+```
+
+### Configuring with Docker Compose
+
+Cookiecutter will interactively guide you through the process of creating a
+`docker-compose` configuration that meets your specific needs. This is the
+recommended approach if you are not very familiar with Docker.
+
+In the LDR repository, run the following command
+to generate the compose file:
+
+```bash
+cookiecutter cookiecutter-docker/
+docker compose -f docker-compose.default.yml up
+```
+
+[Docker Compose Guide →](docs/docker-compose-guide.md)
+
+### Option 3: Python Package
+
+```bash
+# Step 1: Install the package
+pip install local-deep-research
+
+# Step 2: Setup SearXNG for best results
+docker pull searxng/searxng
+docker run -d -p 8080:8080 --name searxng searxng/searxng
+
+# Step 3: Install Ollama from https://ollama.ai
+
+# Step 4: Download a model
+ollama pull gemma3:12b
+
+# Step 5: Start the web interface
+python -m local_deep_research.web.app
+```
+
+[Full Installation Guide →](https://github.com/LearningCircuit/local-deep-research/wiki/Installation)
+
+## 💻 Usage Examples
+
+### Python API
+```python
+from local_deep_research.api import quick_summary
+
+# Simple usage
+result = quick_summary("What are the latest advances in quantum computing?")
+print(result["summary"])
+
+# Advanced usage with custom configuration
+result = quick_summary(
+    query="Impact of AI on healthcare",
+    search_tool="searxng",
+    search_strategy="focused-iteration",
+    iterations=2
+)
+```
+
+### HTTP API
+```bash
+curl -X POST http://localhost:5000/api/v1/quick_summary \
+  -H "Content-Type: application/json" \
+  -d '{"query": "Explain CRISPR gene editing"}'
+```
+
+[More Examples →](examples/api_usage/)
+
+### Command Line Tools
+
+```bash
+# Run benchmarks from CLI
+python -m local_deep_research.benchmarks --dataset simpleqa --examples 50
+
+# Manage rate limiting
+python -m local_deep_research.web_search_engines.rate_limiting status
+python -m local_deep_research.web_search_engines.rate_limiting reset
+```
+
+## 🔗 Enterprise Integration
+
+Connect LDR to your existing knowledge base:
+
+```python
+from local_deep_research.api import quick_summary
+
+# Use your existing LangChain retriever
+result = quick_summary(
+    query="What are our deployment procedures?",
+    retrievers={"company_kb": your_retriever},
+    search_tool="company_kb"
+)
+```
+
+Works with: FAISS, Chroma, Pinecone, Weaviate, Elasticsearch, and any LangChain-compatible retriever.
+
+[Integration Guide →](docs/LANGCHAIN_RETRIEVER_INTEGRATION.md)
+
+## 📊 Performance & Analytics
+
+### Benchmark Results
+Early experiments on small SimpleQA dataset samples:
+
+| Configuration | Accuracy | Notes |
+|--------------|----------|--------|
+| gpt-4.1-mini + SearXNG + focused_iteration | 90-95% | Limited sample size |
+| gpt-4.1-mini + Tavily | Up to 95% | Limited sample size |
+| gemini-2.0-flash-001 + SearXNG | 82% | Single test run |
+
+Note: These are preliminary results from initial testing. Performance varies significantly based on query types, model versions, and configurations. [Run your own benchmarks →](docs/BENCHMARKING.md)
+
+### Built-in Analytics Dashboard
+Track costs, performance, and usage with detailed metrics. [Learn more →](docs/analytics-dashboard.md)
+
+## 🤖 Supported LLMs
+
+### Local Models (via Ollama)
+- Llama 3, Mistral, Gemma, DeepSeek
+- LLM processing stays local (search queries still go to web)
+- No API costs
+
+### Cloud Models
+- OpenAI (GPT-4, GPT-3.5)
+- Anthropic (Claude 3)
+- Google (Gemini)
+- 100+ models via OpenRouter
+
+[Model Setup →](docs/env_configuration.md)
+
+## 📚 Documentation
+
+### Getting Started
+- [Installation Guide](https://github.com/LearningCircuit/local-deep-research/wiki/Installation)
+- [Frequently Asked Questions](docs/faq.md)
+- [API Quickstart](docs/api-quickstart.md)
+- [Configuration Guide](docs/env_configuration.md)
+
+### Core Features
+- [All Features Guide](docs/features.md)
+- [Search Engines Guide](docs/search-engines.md)
+- [Analytics Dashboard](docs/analytics-dashboard.md)
+
+### Advanced Features
+- [LangChain Integration](docs/LANGCHAIN_RETRIEVER_INTEGRATION.md)
+- [Benchmarking System](docs/BENCHMARKING.md)
+- [Elasticsearch Setup](docs/elasticsearch_search_engine.md)
+- [SearXNG Setup](docs/SearXNG-Setup.md)
+
+### Development
+- [Docker Compose Guide](docs/docker-compose-guide.md)
+- [Development Guide](docs/developing.md)
+- [Security Guide](docs/security/CODEQL_GUIDE.md)
+- [Release Guide](docs/RELEASE_GUIDE.md)
+
+### Examples & Tutorials
+- [API Examples](examples/api_usage/)
+- [Benchmark Examples](examples/benchmarks/)
+- [Optimization Examples](examples/optimization/)
+
+## 🤝 Community & Support
+
+- [Discord](https://discord.gg/ttcqQeFcJ3) - Get help and share research techniques
+- [Reddit](https://www.reddit.com/r/LocalDeepResearch/) - Updates and showcases
+- [GitHub Issues](https://github.com/LearningCircuit/local-deep-research/issues) - Bug reports
+
+## 🚀 Contributing
+
+We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) to get started.
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file.
+
+Built with: [LangChain](https://github.com/hwchase17/langchain), [Ollama](https://ollama.ai), [SearXNG](https://searxng.org/), [FAISS](https://github.com/facebookresearch/faiss)
+
+> **Support Free Knowledge:** Consider donating to [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.6.0/README.md

@@ -0,0 +1,292 @@
+# 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)
+[![Docker Pulls](https://img.shields.io/docker/pulls/localdeepresearch/local-deep-research?style=for-the-badge)](https://hub.docker.com/r/localdeepresearch/local-deep-research)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/local-deep-research?style=for-the-badge)](https://pypi.org/project/local-deep-research/)
+
+[![Tests](https://img.shields.io/github/actions/workflow/status/LearningCircuit/local-deep-research/tests.yml?branch=main&style=for-the-badge&label=Tests)](https://github.com/LearningCircuit/local-deep-research/actions/workflows/tests.yml)
+[![CodeQL](https://img.shields.io/github/actions/workflow/status/LearningCircuit/local-deep-research/codeql.yml?branch=main&style=for-the-badge&label=CodeQL)](https://github.com/LearningCircuit/local-deep-research/security/code-scanning)
+
+[![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 for deep, iterative research**
+
+*Performs deep, iterative research using multiple LLMs and search engines with proper citations*
+</div>
+## 🚀 What is Local Deep Research?
+
+LDR is an AI research assistant that performs systematic research by:
+
+- **Breaking down complex questions** into focused sub-queries
+- **Searching multiple sources** in parallel (web, academic papers, local documents)
+- **Verifying information** across sources for accuracy
+- **Creating comprehensive reports** with proper citations
+
+It aims to help researchers, students, and professionals find accurate information quickly while maintaining transparency about sources.
+
+## 🎯 Why Choose LDR?
+
+- **Privacy-Focused**: Run entirely locally with Ollama + SearXNG
+- **Flexible**: Use any LLM, any search engine, any vector store
+- **Comprehensive**: Multiple research modes from quick summaries to detailed reports
+- **Transparent**: Track costs and performance with built-in analytics
+- **Open Source**: MIT licensed with an active community
+
+## ✨ Key Features
+
+### 🔍 Research Modes
+- **Quick Summary** - Get answers in 30 seconds to 3 minutes with citations
+- **Detailed Research** - Comprehensive analysis with structured findings
+- **Report Generation** - Professional reports with sections and table of contents
+- **Document Analysis** - Search your private documents with AI
+
+### 🛠️ Advanced Capabilities
+- **[LangChain Integration](docs/LANGCHAIN_RETRIEVER_INTEGRATION.md)** - Use any vector store as a search engine
+- **[REST API](docs/api-quickstart.md)** - Language-agnostic HTTP access
+- **[Benchmarking](docs/BENCHMARKING.md)** - Test and optimize your configuration
+- **[Analytics Dashboard](docs/analytics-dashboard.md)** - Track costs, performance, and usage metrics
+- **Real-time Updates** - WebSocket support for live research progress
+- **Export Options** - Download results as PDF or Markdown
+- **Research History** - Save, search, and revisit past research
+- **Adaptive Rate Limiting** - Intelligent retry system that learns optimal wait times
+- **Keyboard Shortcuts** - Navigate efficiently (ESC, Ctrl+Shift+1-5)
+
+### 🌐 Search Sources
+
+#### Free Search Engines
+- **Academic**: arXiv, PubMed, Semantic Scholar
+- **General**: Wikipedia, SearXNG, DuckDuckGo
+- **Technical**: GitHub, Elasticsearch
+- **Historical**: Wayback Machine
+- **News**: The Guardian
+
+#### Premium Search Engines
+- **Tavily** - AI-powered search
+- **Google** - Via SerpAPI or Programmable Search Engine
+- **Brave Search** - Privacy-focused web search
+
+#### Custom Sources
+- **Local Documents** - Search your files with AI
+- **LangChain Retrievers** - Any vector store or database
+- **Meta Search** - Combine multiple engines intelligently
+
+[Full Search Engines Guide →](docs/search-engines.md)
+
+## ⚡ Quick Start
+
+### Option 1: Docker (Quickstart no MAC/ARM)
+
+```bash
+# Step 1: Pull and run SearXNG for optimal search results
+docker run -d -p 8080:8080 --name searxng searxng/searxng
+
+# Step 2: Pull and run Local Deep Research (Please build your own docker on ARM)
+docker run -d -p 5000:5000 --name local-deep-research --volume 'deep-research:/install/.venv/lib/python3.13/site-packages/data/' localdeepresearch/local-deep-research
+```
+
+### Option 2: Docker Compose (Recommended)
+
+LDR uses Docker compose to bundle the web app and all it's dependencies so
+you can get up and running quickly.
+
+#### Option 2a: DIY docker-compose
+See [docker-compose.yml](./docker-compose.yml) for a docker-compose file with reasonable defaults to get up and running with ollama, searxng, and local deep research all running locally.
+
+Things you may want/need to configure:
+* Ollama GPU driver
+* Ollama context length (depends on available VRAM)
+* Ollama keep alive (duration model will stay loaded into VRAM and idle before getting unloaded automatically)
+* Deep Research model (depends on available VRAM and preference)
+
+#### Option 2b: Use Cookie Cutter to tailor a docker-compose to your needs:
+
+##### Prerequisites
+
+- [Docker](https://docs.docker.com/engine/install/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+- `cookiecutter`: Run `pip install --user cookiecutter`
+
+Clone the repository:
+
+```bash
+git clone https://github.com/LearningCircuit/local-deep-research.git
+cd local-deep-research
+```
+
+### Configuring with Docker Compose
+
+Cookiecutter will interactively guide you through the process of creating a
+`docker-compose` configuration that meets your specific needs. This is the
+recommended approach if you are not very familiar with Docker.
+
+In the LDR repository, run the following command
+to generate the compose file:
+
+```bash
+cookiecutter cookiecutter-docker/
+docker compose -f docker-compose.default.yml up
+```
+
+[Docker Compose Guide →](docs/docker-compose-guide.md)
+
+### Option 3: Python Package
+
+```bash
+# Step 1: Install the package
+pip install local-deep-research
+
+# Step 2: Setup SearXNG for best results
+docker pull searxng/searxng
+docker run -d -p 8080:8080 --name searxng searxng/searxng
+
+# Step 3: Install Ollama from https://ollama.ai
+
+# Step 4: Download a model
+ollama pull gemma3:12b
+
+# Step 5: Start the web interface
+python -m local_deep_research.web.app
+```
+
+[Full Installation Guide →](https://github.com/LearningCircuit/local-deep-research/wiki/Installation)
+
+## 💻 Usage Examples
+
+### Python API
+```python
+from local_deep_research.api import quick_summary
+
+# Simple usage
+result = quick_summary("What are the latest advances in quantum computing?")
+print(result["summary"])
+
+# Advanced usage with custom configuration
+result = quick_summary(
+    query="Impact of AI on healthcare",
+    search_tool="searxng",
+    search_strategy="focused-iteration",
+    iterations=2
+)
+```
+
+### HTTP API
+```bash
+curl -X POST http://localhost:5000/api/v1/quick_summary \
+  -H "Content-Type: application/json" \
+  -d '{"query": "Explain CRISPR gene editing"}'
+```
+
+[More Examples →](examples/api_usage/)
+
+### Command Line Tools
+
+```bash
+# Run benchmarks from CLI
+python -m local_deep_research.benchmarks --dataset simpleqa --examples 50
+
+# Manage rate limiting
+python -m local_deep_research.web_search_engines.rate_limiting status
+python -m local_deep_research.web_search_engines.rate_limiting reset
+```
+
+## 🔗 Enterprise Integration
+
+Connect LDR to your existing knowledge base:
+
+```python
+from local_deep_research.api import quick_summary
+
+# Use your existing LangChain retriever
+result = quick_summary(
+    query="What are our deployment procedures?",
+    retrievers={"company_kb": your_retriever},
+    search_tool="company_kb"
+)
+```
+
+Works with: FAISS, Chroma, Pinecone, Weaviate, Elasticsearch, and any LangChain-compatible retriever.
+
+[Integration Guide →](docs/LANGCHAIN_RETRIEVER_INTEGRATION.md)
+
+## 📊 Performance & Analytics
+
+### Benchmark Results
+Early experiments on small SimpleQA dataset samples:
+
+| Configuration | Accuracy | Notes |
+|--------------|----------|--------|
+| gpt-4.1-mini + SearXNG + focused_iteration | 90-95% | Limited sample size |
+| gpt-4.1-mini + Tavily | Up to 95% | Limited sample size |
+| gemini-2.0-flash-001 + SearXNG | 82% | Single test run |
+
+Note: These are preliminary results from initial testing. Performance varies significantly based on query types, model versions, and configurations. [Run your own benchmarks →](docs/BENCHMARKING.md)
+
+### Built-in Analytics Dashboard
+Track costs, performance, and usage with detailed metrics. [Learn more →](docs/analytics-dashboard.md)
+
+## 🤖 Supported LLMs
+
+### Local Models (via Ollama)
+- Llama 3, Mistral, Gemma, DeepSeek
+- LLM processing stays local (search queries still go to web)
+- No API costs
+
+### Cloud Models
+- OpenAI (GPT-4, GPT-3.5)
+- Anthropic (Claude 3)
+- Google (Gemini)
+- 100+ models via OpenRouter
+
+[Model Setup →](docs/env_configuration.md)
+
+## 📚 Documentation
+
+### Getting Started
+- [Installation Guide](https://github.com/LearningCircuit/local-deep-research/wiki/Installation)
+- [Frequently Asked Questions](docs/faq.md)
+- [API Quickstart](docs/api-quickstart.md)
+- [Configuration Guide](docs/env_configuration.md)
+
+### Core Features
+- [All Features Guide](docs/features.md)
+- [Search Engines Guide](docs/search-engines.md)
+- [Analytics Dashboard](docs/analytics-dashboard.md)
+
+### Advanced Features
+- [LangChain Integration](docs/LANGCHAIN_RETRIEVER_INTEGRATION.md)
+- [Benchmarking System](docs/BENCHMARKING.md)
+- [Elasticsearch Setup](docs/elasticsearch_search_engine.md)
+- [SearXNG Setup](docs/SearXNG-Setup.md)
+
+### Development
+- [Docker Compose Guide](docs/docker-compose-guide.md)
+- [Development Guide](docs/developing.md)
+- [Security Guide](docs/security/CODEQL_GUIDE.md)
+- [Release Guide](docs/RELEASE_GUIDE.md)
+
+### Examples & Tutorials
+- [API Examples](examples/api_usage/)
+- [Benchmark Examples](examples/benchmarks/)
+- [Optimization Examples](examples/optimization/)
+
+## 🤝 Community & Support
+
+- [Discord](https://discord.gg/ttcqQeFcJ3) - Get help and share research techniques
+- [Reddit](https://www.reddit.com/r/LocalDeepResearch/) - Updates and showcases
+- [GitHub Issues](https://github.com/LearningCircuit/local-deep-research/issues) - Bug reports
+
+## 🚀 Contributing
+
+We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) to get started.
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file.
+
+Built with: [LangChain](https://github.com/hwchase17/langchain), [Ollama](https://ollama.ai), [SearXNG](https://searxng.org/), [FAISS](https://github.com/facebookresearch/faiss)
+
+> **Support Free Knowledge:** Consider donating to [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.5.7 → local_deep_research-0.6.0}/pyproject.toml

@@ -13,6 +13,7 @@ requires-python = ">=3.10"
 authors = [
     { name = "LearningCircuit", email = "185559241+LearningCircuit@users.noreply.github.com" },
     { name = "HashedViking", email = "6432677+HashedViking@users.noreply.github.com" },
+    { name = "djpetti", email = "djpetti@gmail.com" },
 ]
 classifiers = [
     "Programming Language :: Python :: 3",
@@ -66,8 +67,9 @@ dependencies = [
     "plotly>=6.0.1",
     "kaleido==0.2.1",
     "aiohttp>=3.9.0",
+    "tenacity>=8.0.0",
 ]
-version = "0.5.7"
+version = "0.6.0"
 
 [project.license]
 file = "LICENSE"
@@ -116,6 +118,7 @@ markers = [
     "requires_llm: marks tests that require a real LLM (not fallback)",
     "integration: marks integration tests",
     "slow: marks slow tests",
+    "asyncio: marks async tests that use asyncio",
 ]
 
 [tool.ruff]
@@ -183,5 +186,6 @@ dev = [
     "pytest>=8.3.5",
     "pytest-cov>=6.1.1",
     "pytest-timeout>=2.3.1",
+    "pytest-asyncio>=0.23.0",
     "ruff>=0.11.12",
 ]