From 3096d439d4586c0bcc703b767099be3e1b35af6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Mon, 4 Jul 2022 12:27:40 +0200 Subject: [PATCH] README: add common issues MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maxime “pep” Buquet --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.rst b/README.rst index b07ae3c..1493c85 100644 --- a/README.rst +++ b/README.rst @@ -41,6 +41,31 @@ dependencies. - PIP: `poezio-omemo` - Manual: `python3 setup.py install` +Common issues +------------- + +This plugin is **NOT** to be placed in the Poezio plugin folder, doing +so may shadow the OMEMO library and render it inaccessible from Poezio. +This module declares itself via `pkg_resources` under the +`poezio_plugins` group. + +Other possible issues when loading the plugin may be that the OMEMO +library is incorrectly setup. + +In a Python interpreter:: + + >>> # Is the backend OMEMO library is reachable? (success: no error, no output) + >>> import omemo + >>> # Is poezio_omemo reachable? (success: no error, no output) + >>> import poezio_omemo + >>> # Is the module probably declared in plugin entries? (success: true) + >>> import pkg_resources + >>> 'omemo' in map(lambda e: e.name, pkg_resources.iter_entry_points('poezio_plugins')) + +If this doesn't yield any error and Poezio still can't load the plugin, +try starting it with a debug file (`-d poezio.log`) and join our +`channel `_. + Use in poezio -------------