Metadata-Version: 2.1
Name: sopel-search
Version: 1.0.0
Summary: Search plugin for Sopel IRC bots
Author-email: dgw <dgw@technobabbl.es>
License: EFL-2.0
Project-URL: Homepage, https://github.com/sopel-irc/sopel-search
Project-URL: Bug Tracker, https://github.com/sopel-irc/sopel-search/issues
Keywords: sopel,plugin,bot,irc
Platform: Linux x86, x86-64
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: Eiffel Forum License (EFL)
Classifier: License :: OSI Approved :: Eiffel Forum License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: <4,>=3.8
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: sopel>=8.0
Requires-Dist: duckduckgo-search~=6.2
Provides-Extra: gsuggest
Requires-Dist: xmltodict~=0.13.0; extra == "gsuggest"
Requires-Dist: requests; extra == "gsuggest"

# sopel-search

Search plugin for Sopel IRC bots

## Installing

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

```shell
$ 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:

```shell
$ 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'.

## Changelog

### 1.0.0

First release of `sopel-search`.

This new search plugin apes a lot of behaviors from Sopel's built-in `search`,
with the following notable changes:

* `.bing` is no longer available
* `.search` is an alias to `.ddg`, as `.g` was already
* Search `region` and `safesearch` level are now configurable
* `.suggest` uses DuckDuckGo; Google suggestions are still available via the
  new `.gsuggest` command (if optional extra dependencies are installed)
