local-deep-research 0.1.25__tar.gz → 0.2.0__tar.gz

{local_deep_research-0.1.25/src/local_deep_research.egg-info → local_deep_research-0.2.0}/PKG-INFO

@@ -1,38 +1,36 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: local-deep-research
-Version: 0.1.25
+Version: 0.2.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>
+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.
-        
-Project-URL: Homepage, https://github.com/LearningCircuit/local-deep-research
-Project-URL: Bug Tracker, https://github.com/LearningCircuit/local-deep-research/issues
+         
+         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
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
+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
@@ -45,7 +43,7 @@ Requires-Dist: typing_extensions>=4.12.2
 Requires-Dist: justext
 Requires-Dist: playwright
 Requires-Dist: beautifulsoup4
-Requires-Dist: flask>=2.0.1
+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
@@ -66,10 +64,52 @@ Requires-Dist: lxml>=4.9.2
 Requires-Dist: pdfplumber>=0.9.0
 Requires-Dist: unstructured>=0.10.0
 Requires-Dist: google-search-results
-Dynamic: license-file
+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
 
+## Features
+
+- 🔍 **Advanced Research Capabilities**
+  - Automated deep research with intelligent follow-up questions
+  - Proper inline citation and source verification
+  - Multi-iteration analysis for comprehensive coverage
+  - Full webpage content analysis (not just snippets)
+
+- 🤖 **Flexible LLM Support**
+  - Local AI processing with Ollama models
+  - Cloud LLM support (Claude, GPT)
+  - Supports all Langchain models
+  - Configurable model selection based on needs
+
+- 📊 **Rich Output Options**
+  - Detailed research findings with proper citations
+  - Well-structured comprehensive research reports
+  - Quick summaries for rapid insights
+  - Source tracking and verification
+
+- 🔒 **Privacy-Focused**
+  - Runs entirely on your machine when using local models
+  - Configurable search settings
+  - Transparent data handling
+
+- 🌐 **Enhanced Search Integration**
+  - **Auto-selection of search sources**: The "auto" search engine intelligently analyzes your query and selects the most appropriate search engine
+  - Multiple search engines including Wikipedia, arXiv, PubMed, Semantic Scholar, and more
+  - **Local RAG search for private documents** - search your own documents with vector embeddings
+  - Full webpage content retrieval and intelligent filtering
+
+- 🎓 **Academic & Scientific Integration**
+  - Direct integration with PubMed, arXiv, Wikipedia, Semantic Scholar
+  - Properly formatted citations from academic sources
+  - Report structure suitable for literature reviews
+  - Cross-disciplinary synthesis of information
+
+| [Reddit](https://www.reddit.com/r/LocalDeepResearch/) | [Discord](https://discord.gg/ttcqQeFcJ3) |
+
 A powerful AI-powered research assistant that performs deep, iterative analysis using multiple LLMs and web searches. The system can be run locally for privacy or configured to use cloud-based LLMs for enhanced capabilities.
 
 <div align="center">
@@ -80,13 +120,15 @@ A powerful AI-powered research assistant that performs deep, iterative analysis
   </a>
 </div>
 
+**Important for non-academic searches:** For normal web searches you will need SearXNG or an API key to a search provider like brave search or SerpAPI. The free searches are mostly academic search engines and will not help you for most normal searches.
+
 ## Windows Installation
 
-Download the [Windows Installer](https://github.com/LearningCircuit/local-deep-research/releases/download/v0.1.0/LocalDeepResearch_Setup.exe) for easy one-click installation. 
+ Download the [Windows Installer](https://github.com/LearningCircuit/local-deep-research/releases/download/v0.2.0/LocalDeepResearch_Setup.exe) for easy one-click installation.
 
-**Requires Ollama or other model preinstalled.**
-Download from https://ollama.ai and then pull a model
-ollama pull gemma3:12b
+ **Requires Ollama (or other model provider configured in .env).**
+ Download from https://ollama.ai and then pull a model
+ ollama pull gemma3:12b
 
 ## Quick Start (not required if installed with windows installer)
 
@@ -135,6 +177,16 @@ For comprehensive Docker setup information, see:
 - [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)
 
+## Migrating from Version 0.1.0
+
+If you just upgraded from 0.1.0, and you want to preserve your configuration,
+you will need to manually migrate from the old config files to the new settings
+database:
+
+```bash
+python -m local_deep_research.migrate_db
+```
+
 ## Programmatic Access
 
 Local Deep Research now provides a simple API for programmatic access to its research capabilities:
@@ -144,7 +196,7 @@ import os
 # Set environment variables to control the LLM
 os.environ["LDR_LLM__MODEL"] = "mistral"     # Specify model name
 
-from local_deep_research import quick_summary, generate_report, analyze_documents
+from local_deep_research import quick_summary, generate_report
 
 # Generate a quick research summary with custom parameters
 results = quick_summary(
@@ -160,44 +212,6 @@ print(results["summary"])
 
 These functions provide flexible options for customizing the search parameters, iterations, and output formats. For more examples, see the [programmatic access tutorial](https://github.com/LearningCircuit/local-deep-research/blob/main/examples/programmatic_access.ipynb).
 
-
-## Features
-
-- 🔍 **Advanced Research Capabilities**
-  - Automated deep research with intelligent follow-up questions
-  - Proper inline citation and source verification
-  - Multi-iteration analysis for comprehensive coverage
-  - Full webpage content analysis (not just snippets)
-
-- 🤖 **Flexible LLM Support**
-  - Local AI processing with Ollama models
-  - Cloud LLM support (Claude, GPT)
-  - Supports all Langchain models
-  - Configurable model selection based on needs
-
-- 📊 **Rich Output Options**
-  - Detailed research findings with proper citations
-  - Well-structured comprehensive research reports
-  - Quick summaries for rapid insights
-  - Source tracking and verification
-
-- 🔒 **Privacy-Focused**
-  - Runs entirely on your machine when using local models
-  - Configurable search settings
-  - Transparent data handling
-
-- 🌐 **Enhanced Search Integration**
-  - **Auto-selection of search sources**: The "auto" search engine intelligently analyzes your query and selects the most appropriate search engine
-  - Multiple search engines including Wikipedia, arXiv, PubMed, Semantic Scholar, and more
-  - **Local RAG search for private documents** - search your own documents with vector embeddings
-  - Full webpage content retrieval and intelligent filtering
-
-- 🎓 **Academic & Scientific Integration**
-  - Direct integration with PubMed, arXiv, Wikipedia, Semantic Scholar
-  - Properly formatted citations from academic sources
-  - Report structure suitable for literature reviews
-  - Cross-disciplinary synthesis of information
-
 ## Configuration System
 
 The package automatically creates and manages configuration files in your user directory:
@@ -212,7 +226,6 @@ When you first run the tool, it creates these configuration files:
 | File | Purpose |
 |------|---------|
 | `settings.toml` | General settings for research, web interface, and search |
-| `llm_config.py` | Advanced LLM configuration (rarely needs modification) |
 | `search_engines.toml` | Define and configure search engines |
 | `local_collections.toml` | Configure local document collections for RAG |
 | `.env` | Environment variables for configuration (recommended for API keys) |
@@ -225,7 +238,7 @@ The system supports multiple LLM providers:
 
 ### Local Models (via Ollama)
 
-1. [Install Ollama](https://ollama.ai) 
+1. [Install Ollama](https://ollama.ai)
 2. Pull a model: `ollama pull gemma3:12b` (recommended model)
 3. Ollama runs on port 11434 by default
 
@@ -239,13 +252,11 @@ ANTHROPIC_API_KEY=your-api-key-here      # For Claude models
 OPENAI_API_KEY=your-openai-key-here      # For GPT models
 OPENAI_ENDPOINT_API_KEY=your-key-here    # For OpenRouter or similar services
 
-# Set your preferred LLM provider and model (no need to edit llm_config.py)
+# Set your preferred LLM provider and model
 LDR_LLM__PROVIDER=ollama                 # Options: ollama, openai, anthropic, etc.
 LDR_LLM__MODEL=gemma3:12b                # Model name to use
 ```
 
-> **Important:** In most cases, you don't need to modify the `llm_config.py` file. Simply set the `LDR_LLM__PROVIDER` and `LDR_LLM__MODEL` environment variables to use your preferred model.
-
 ### Supported LLM Providers
 
 The system supports multiple LLM providers:
@@ -379,10 +390,11 @@ LDR_SEARCH__QUESTIONS_PER_ITERATION=2
 The web interface offers several features:
 
 - **Dashboard**: Start and manage research queries
-- **Real-time Updates**: Track research progress
+- **Real-time Updates**: Track research progress with improved logging
 - **Research History**: Access past queries
 - **PDF Export**: Download reports
 - **Research Management**: Terminate processes or delete records
+- **Enhanced Settings Panel**: New unified settings UI with improved organization
 
 ## Command Line Interface
 
@@ -393,17 +405,19 @@ The CLI version allows you to:
 3. View results directly in the terminal
 4. Save reports automatically to the configured output directory
 
-## Development Setup
+## Development Environment
 
-If you want to develop or modify the package, you can install it in development mode:
+This project now uses PDM for dependency management. To set up a development environment:
 
 ```bash
-# Clone the repository
-git clone https://github.com/LearningCircuit/local-deep-research.git
-cd local-deep-research
+# Install PDM if you don't have it
+pip install pdm
+
+# Install dependencies
+pdm install --no-self
 
-# Install in development mode
-pip install -e .
+# Activate the environment
+pdm venv activate
 ```
 
 You can run the application directly using Python module syntax:
@@ -416,9 +430,82 @@ python -m local_deep_research.web.app
 python -m local_deep_research.main
 ```
 
+For more information, see the [development documentation](docs/developing.md).
+
+## Unified Database
+
+The application now uses a single unified database (`ldr.db`) for all settings and history, making configuration management simpler and more reliable.
+
+### Migration from v0.1.x
+
+If you have existing data in legacy databases from v0.1.x, the application will automatically migrate your data when you first run v0.2.0.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+### Development Setup with PDM
+
+This project uses PDM for dependency management. Here's how to set up your development environment:
+
+```bash
+# Install PDM if you don't have it
+pip install pdm
+
+# Clone the repository
+git clone https://github.com/LearningCircuit/local-deep-research.git
+cd local-deep-research
+
+# Install dependencies including dev dependencies
+pdm install --no-self
+
+# Set up pre-commit hooks
+pdm run pre-commit install
+pdm run pre-commit install-hooks
+
+# Activate the virtual environment
+pdm venv activate
+```
+
+#### Common PDM Commands
+
+```bash
+# Run linting checks
+pdm run flake8
+pdm run black .
+
+# Run tests (when available)
+pdm run pytest
+
+# Add a new dependency
+pdm add package-name
+
+# Add a development dependency
+pdm add -dG dev package-name
+```
+
+### Contributing Process
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Make your changes
+4. Run linting checks to ensure code quality
+5. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+6. Push to the branch (`git push origin feature/AmazingFeature`)
+7. **Important:** Open a Pull Request against the `dev` branch, not the `main` branch
+
+We prefer all pull requests to be submitted against the `dev` branch for easier testing and integration before releasing to the main branch.
+
+### Getting Help
+
+Join our [Discord server](https://discord.gg/ttcqQeFcJ3) if you're planning to contribute. Let us know about your plans - we're always happy to guide new contributors and discuss feature ideas!
+
 ## Community & Support
 
-Join our [Discord server](https://discord.gg/2E6gYU2Z) to exchange ideas, discuss usage patterns, and share research approaches.
+Join our [Discord server](https://discord.gg/ttcqQeFcJ3) to exchange ideas, discuss usage patterns, and
+share research approaches.
+
+Follow our [Subreddit](https://www.reddit.com/r/LocalDeepResearch/) for announcements, updates, and feature highlights.
 
 ## License
 
@@ -445,16 +532,3 @@ This project is licensed under the MIT License.
 > - [Support arXiv](https://arxiv.org/about/give)
 > - [Donate to DuckDuckGo](https://duckduckgo.com/donations)
 > - [Support PubMed/NCBI](https://www.nlm.nih.gov/pubs/donations/donations.html)
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
-3. Make your changes
-4. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
-5. Push to the branch (`git push origin feature/AmazingFeature`)
-6. **Important:** Open a Pull Request against the `dev` branch, not the `main` branch
-
-We prefer all pull requests to be submitted against the `dev` branch for easier testing and integration before releasing to the main branch.