Ponysearch/docs/dev/plugins.rst

46 lines
1.2 KiB
ReStructuredText
Raw Normal View History

2015-11-17 23:13:30 +01:00
Plugins
-------
Plugins can extend or replace functionality of various components of
2015-11-17 23:13:30 +01:00
searx.
Example plugin
~~~~~~~~~~~~~~
2015-11-17 23:13:30 +01:00
.. code:: python
name = 'Example plugin'
description = 'This plugin extends the suggestions with the word "example"'
2016-11-04 18:38:07 +01:00
default_on = False # disabled by default
2015-11-17 23:13:30 +01:00
js_dependencies = tuple() # optional, list of static js files
css_dependencies = tuple() # optional, list of static css files
# attach callback to the post search hook
# request: flask request object
# ctx: the whole local context of the post search hook
def post_search(request, ctx):
ctx['search'].suggestions.add('example')
return True
Plugin entry points
~~~~~~~~~~~~~~~~~~~
2015-11-17 23:13:30 +01:00
Entry points (hooks) define when a plugin runs. Right now only three hooks are implemented. So feel free to implement a hook if it fits the behaviour of your plugin.
2015-11-17 23:13:30 +01:00
Pre search hook
```````````````
2015-11-17 23:13:30 +01:00
Runs BEFORE the search request. Function to implement: ``pre_search``
2015-11-17 23:13:30 +01:00
Post search hook
````````````````
2015-11-17 23:13:30 +01:00
Runs AFTER the search request. Function to implement: ``post_search``
Result hook
```````````
Runs when a new result is added to the result list. Function to implement: ``on_result``