diff options
| author | Noémi Ványi <kvch@users.noreply.github.com> | 2020-07-28 21:28:55 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-28 21:28:55 +0200 |
| commit | cdc2f33972cedd953c93cff5e78da4455352cd84 (patch) | |
| tree | f8a0ee99aa4d11e7e0617448d4b35db337de37a4 /docs/dev/plugins.rst | |
| parent | 1185c06a8732101ad16bb3a8926ff0797ff2c6b9 (diff) | |
| parent | 93ac4db312f0ec04bc631714a8fbc2054fe7578b (diff) | |
Merge pull request #2074 from asciimoo/external-plugins
This is a second proposal to accomplish plugin decoupling. I think #1938 is highly complicated and does much more than this feature requires, so here is an alternative implementation for the same feature. Please review it and let me know your opinion.
This solution supports the use of any kind of standard python modules which implements the required attributes of a plugin, so new plugins can be installed by standard python tools (pip/setup.py).
Downsides:
- Localization of plugins name/description isn't possible
- Plugins have to be updated manually
## What does this PR do?
Implements external plugin extensibility.
## Why is this change important?
Makes us able to decouple plugins from searx.
## Related issues
#1938 #1716 #1878
Diffstat (limited to 'docs/dev/plugins.rst')
| -rw-r--r-- | docs/dev/plugins.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst index 6add97517..16262ea6d 100644 --- a/docs/dev/plugins.rst +++ b/docs/dev/plugins.rst @@ -30,6 +30,13 @@ Example plugin ctx['search'].suggestions.add('example') return True +External plugins +================ + +External plugins are standard python modules implementing all the requirements of the standard plugins. +Plugins can be enabled by adding them to :ref:`settings.yml`'s ``plugins`` section. +Example external plugin can be found `here <https://github.com/asciimoo/searx_external_plugin_example>`_. + Register your plugin ==================== |