Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-25 20:22:45 +01:00
Code Issues Projects Releases Wiki Activity
833af36b08
Limnoria/plugins/DDG
History
Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs 
Starting with this commit, there should be no "original" text
in READMEs.
Instead, the entire text should be in docstrings, and READMEs
should be automatically generated from these docstrings.

Motivation:

* The same help is available both via IRC and in the README
  (although the README can be more detailed, as only the first
  paragraph will be shown on IRC)
* This will allow auto-generating plugin help on docs.limnoria.net
  using the same content as the README, as it's sourced from the
  docstrings

Additionally, this converts all READMEs from Markdown to ReST,
because the documentation already uses ReST, and other docstrings
in the codebase are in ReST for this reason.
2021-04-05 17:42:31 +02:00
..
local Merge DDG plugin from my repository 2020-05-15 11:32:43 -07:00
__init__.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
config.py DDG: Add region and safeSearch configs. 2020-07-06 22:34:29 +02:00
parser.py DDG: better document the transitions in the parser. 2020-07-01 20:06:29 +02:00
plugin.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py DDG: Add region test. 2020-07-06 22:34:29 +02:00

README.rst

Documentation for the DDG plugin for Supybot

Purpose

Searches for results on DuckDuckGo's web search.

Usage

Searches for results on DuckDuckGo.

Example:

<+GLolol> %ddg search eiffel tower
<@Atlas> The Eiffel Tower is an iron lattice tower located on the Champ de Mars in Paris. It was named after the engineer Gustave Eiffel, whose company designed and built the tower. - <https://en.wikipedia.org/wiki/Eiffel_Tower>

Commands

search <text>

Searches for <text> on DuckDuckGo's web search.

Configuration

supybot.plugins.DDG.maxResults

This config variable defaults to "4", is network-specific, and is channel-specific.

Determines the maximum number of results the bot will respond with.

supybot.plugins.DDG.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.

supybot.plugins.DDG.region

This config variable defaults to "", is network-specific, and is channel-specific.

Set the DDG search region to return results for the language/country of your choice. E.g. 'us-en' for United States. https://duckduckgo.com/params

supybot.plugins.DDG.searchFilter

This config variable defaults to "moderate", is network-specific, and is channel-specific.

Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering Valid strings: active, moderate, and off.

supybot.plugins.DDG.showSnippet

This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the bot will show a snippet of each resulting link. If False, it will show the title of the link instead.