Metadata-Version: 2.5
Name: gpt-researcher-autom
Version: 0.1.0
Summary: GPT Researcher retriever plugin for Autom: live Google, Bing, Brave, DuckDuckGo and Yahoo results.
Project-URL: Homepage, https://www.autom.dev
Project-URL: Documentation, https://github.com/automdev/gpt-researcher-autom#readme
Project-URL: Repository, https://github.com/automdev/gpt-researcher-autom
Project-URL: Issues, https://github.com/automdev/gpt-researcher-autom/issues
Author-email: Autom <contact@autom.dev>
License-Expression: MIT
License-File: LICENSE
Keywords: agents,autom,gpt-researcher,research,retriever,web-search
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: httpx<1,>=0.27
Provides-Extra: test
Requires-Dist: pytest>=8.3; extra == 'test'
Requires-Dist: ruff<1,>=0.8; extra == 'test'
Description-Content-Type: text/markdown

# gpt-researcher-autom

[GPT Researcher](https://github.com/assafelovic/gpt-researcher) retriever plugin for [Autom](https://www.autom.dev).

It registers the `autom` retriever under GPT Researcher's `gpt_researcher.retrievers` entry point, so it works without any change to GPT Researcher.

## Installation

Install the plugin in the same Python environment as GPT Researcher:

```bash
pip install gpt-researcher-autom
```

Get an API key at [app.autom.dev](https://app.autom.dev), then select the retriever:

```bash
export RETRIEVER=autom
export AUTOM_API_KEY="your-api-key"
```

You can combine it with other retrievers, such as `RETRIEVER=autom,duckduckgo`.

## Configuration

- `AUTOM_API_KEY`: your Autom API key (required).
- `AUTOM_ENGINE`: google (default), bing, brave, duckduckgo or yahoo.

The retriever returns links with their title and snippet, and GPT Researcher scrapes each page (`requires_scraping = True`). The domains in `query_domains` are added to the query as `site:` filters.

On a missing key or a failed request, the retriever logs a warning and returns no results, so one failing provider does not stop a research run. The key never appears in the logs.

## Development

```bash
pip install -e ".[test]"
pytest
```

## License

MIT
