plugins: doc for external plugins/entry points

Signed-off-by: Maxime Buquet's avatarMaxime “pep” Buquet <pep@bouah.net>
parent 3577f887
Plugin API documentation
========================
External plugins
----------------
It is possible to create external plugins easily using `setuptools'
entry_point
<https://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins>`_
feature. You can register your plugin against the ``poezio_plugins`` entry
group with the following snippet in your project ``setup.py``:
.. code-block:: python
setup(
..
packages=['yourmodule'],
entry_points{'poezio_plugins': 'yourplugin = yourmodule'},
..
)
The plugin will then be available as ``yourplugin`` at runtime.
BasePlugin
----------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment