Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 978 Bytes

README.md

File metadata and controls

34 lines (23 loc) · 978 Bytes
Raw

sopel-search

Search plugin for Sopel IRC bots

Installing

Releases are hosted on PyPI, so after installing Sopel, all you need is pip:

$ pip install sopel-search

Google query suggestions

If you want users to be able to fetch query suggestions from Google using the .gsuggest command, you will need the gsuggest extra:

$ pip install sopel-search[gsuggest]

Configuring

The easiest way to configure sopel-search is via Sopel's configuration wizard—simply run sopel-plugins configure search and enter the values for which it prompts you. Available settings are:

  • region: Set this to the primary geographical region of your bot's users, using one of the values from https://duckduckgo.com/params

    Setting this correctly may improve the relevance of both search results and query suggestions using .suggest.

  • safesearch: Controls SafeSearch filtering of .search results; one of 'on', 'moderate', and 'off'.