https://github.com/sopel-irc/sopel-search
Search plugin for Sopel IRC bots
https://github.com/sopel-irc/sopel-search
hacktoberfest irc-bot-plugin sopel-plugin
Last synced: 7 months ago
JSON representation
Search plugin for Sopel IRC bots
- Host: GitHub
- URL: https://github.com/sopel-irc/sopel-search
- Owner: sopel-irc
- License: other
- Created: 2024-08-10T09:08:55.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-10-17T20:46:35.000Z (8 months ago)
- Last Synced: 2024-10-20T07:21:43.548Z (8 months ago)
- Topics: hacktoberfest, irc-bot-plugin, sopel-plugin
- Language: Python
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- License: COPYING
Awesome Lists containing this project
README
# 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'.