diff --git a/README.rst b/README.rst index e9f43e3..9815333 100644 --- a/README.rst +++ b/README.rst @@ -41,10 +41,12 @@ dependencies. - Debian: The author posed a `Request for packaging `_, but so far, Debian has not packaged poezio-omemo yet. - Pip is disabled in Debian by default. Call `virtualenv your-name-for-your-poezio-env` and then - *source your-name-for-your-poezio-env* in order to be able to use pip. -- PIP: `poezio-omemo` -- Manual: `python3 setup.py install` + Pip is disabled in Debian by default. + Call ``virtualenv your-name-for-your-poezio-env`` + and then ``source your-name-for-your-poezio-env`` + in order to be able to use pip. +- PIP: ``pip install poezio-omemo`` +- Manual: ``python3 setup.py install`` Common issues ------------- @@ -74,13 +76,21 @@ try starting it with a debug file (`-d poezio.log`) and join our Use in poezio ------------- -Once installed (see the `Installation`_ section below), you can add +Once installed (see the `Installation`_ section), you can add `omemo` in the `plugin_autoload` configuration. See the Poezio `documentation `_ for more information about autoloading plugins. +To load it manually in poezio, type ``/load omemo``. TODO ---- - UI, various commands and indicators that messages are encrypted or not. + +DEBUG +----- + +Find :doc:`debugging logs ` for + +- :doc:`pip installation on Debian unstable ` diff --git a/doc/debug/20230310_debug-debian-sid-pip.md b/doc/debug/20230310_debug-debian-sid-pip.md new file mode 100644 index 0000000..fa044b2 --- /dev/null +++ b/doc/debug/20230310_debug-debian-sid-pip.md @@ -0,0 +1,32 @@ +# Log + +Log of eevvoor's omemo plugin installation via pip on debian sid (siduction). + +In the pip environment: + +```bash +(poeziopip) $ pip install protobuf==3.20.3 +Collecting protobuf==3.20.3 + Downloading protobuf-3.20.3-py2.py3-none-any.whl (162 kB) + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 162.1/162.1 kB 3.2 MB/s eta 0:00:00 +Installing collected packages: protobuf + Attempting uninstall: protobuf + Found existing installation: protobuf 4.22.1 + Uninstalling protobuf-4.22.1: + Successfully uninstalled protobuf-4.22.1 +Successfully installed protobuf-3.20.3 +``` + +```bash +$ python3 +Python 3.11.2 (main, Mar 5 2023, 08:28:49) [GCC 12.2.0] on linux +Type "help", "copyright", "credits" or "license" for more information. +>>> import poezio_omemo +Using slower stringprep, consider compiling the faster cython/libidn one. +>>> import pkg_resources +>>> 'omemo' in map(lambda e: e.name, pkg_resources.iter_entry_points('poezio_plugins')) +True +>>> omemo.version.__version__ +'0.14.0' +>>> +```