Metadata-Version: 2.4
Name: deepworm
Version: 1.5.0
Summary: AI-powered deep research agent. Open-source alternative to OpenAI Deep Research.
Author-email: Kadir Can Ozden <101993364+bysiber@users.noreply.github.com>
License: MIT
Project-URL: Homepage, https://github.com/bysiber/deepworm
Project-URL: Repository, https://github.com/bysiber/deepworm
Project-URL: Issues, https://github.com/bysiber/deepworm/issues
Keywords: ai,research,deep-research,llm,agent,web-search
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx>=0.24.0
Requires-Dist: rich>=13.0.0
Requires-Dist: openai>=1.0.0
Provides-Extra: anthropic
Requires-Dist: anthropic>=0.20.0; extra == "anthropic"
Provides-Extra: google
Requires-Dist: google-generativeai>=0.5.0; extra == "google"
Provides-Extra: yaml
Requires-Dist: pyyaml>=6.0; extra == "yaml"
Provides-Extra: all
Requires-Dist: anthropic>=0.20.0; extra == "all"
Requires-Dist: google-generativeai>=0.5.0; extra == "all"
Requires-Dist: pyyaml>=6.0; extra == "all"
Dynamic: license-file

# DeepWorm 🐁

AI deep research tool that searches the web, reads sources, and synthesizes findings into comprehensive reports.

## Quick Start

```bash
pip install deepworm
```

### Set up an API key (choose one)

```bash
# Option 1: OpenAI
export OPENAI_API_KEY="sk-..."

# Option 2: Google Gemini
export GOOGLE_API_KEY="AIza..."

# Option 3: Anthropic Claude
export ANTHROPIC_API_KEY="sk-ant..."
```

### Run a research

```bash
deepworm "what are the latest advances in quantum computing?"
```

That's it. DeepWorm will:
1. Search the web for relevant sources
2. Read and analyze each source
3. Generate followup questions
4. Go deeper recursively
5. Produce a final report with citations

## Command Line Options

```bash
# Control research depth
deepworm "topic" --depth 3 --breadth 5

# Save report to file
deepworm "topic" --output report.md

# Choose provider
deepworm "topic" --provider google

# Compare topics
deepworm compare "Python" "Rust"

# Interactive mode
deepworm interactive

# See all options
deepworm --help
```

## Python API

```python
from deepworm import Researcher

researcher = Researcher(provider="openai")
result = researcher.research("your topic")
print(result.report)
```

## Supported Providers

| Provider | Env Variable | Models |
|---|---|---|
| OpenAI | `OPENAI_API_KEY` | gpt-4o, gpt-4o-mini |
| Google | `GOOGLE_API_KEY` | gemini-pro, gemini-flash |
| Anthropic | `ANTHROPIC_API_KEY` | claude-3.5, claude-3 haiku |
| Ollama | (none, local) | llama3, mistral |

## Configuration

Create `deepworm.yaml` in your project root:

```yaml
provider: google
model: gemini-pro
depth: 3
breadth: 5
output_dir: ./reports
```

## Key Features

- Multi-provider LLM support (OpenAI, Google, Anthropic, Ollama)
- Recursive deep research with configurable depth and breadth
- Markdown reports with citations and source links
- Comparison mode for side-by-side analysis
- Research chains for multi-step investigations
- Built-in retry and rate limiting
- DuckDuckGo search (no API key needed for search)
- Interactive mode for exploratory research
- Research history and caching
- Template system for repeatable research
- Rich terminal output with progress tracking
- Extensible plugin system

## License

MIT
