Skip to content

Commit

Permalink
improved error logging
Browse files Browse the repository at this point in the history
- all warnings and errors are now carrying an identifier, e.g. W123 or E234.
- this should help in identifying errors more easily in the stderr output or the logfile
- since warnings and errors in stderr are being treated (weakly) as being part of the API
  a new *MAJOR* version number was assigned; if you don't parse the stderr you can
  run this version carefree, as there are no other changes
- see more info in Versioning chapter in README.md
  • Loading branch information
8go committed Nov 22, 2022
1 parent e8a155a commit a051546
Show file tree
Hide file tree
Showing 13 changed files with 485 additions and 1,972 deletions.
48 changes: 28 additions & 20 deletions PyPi-Instructions.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
# PRE-INSTALLATION

Before you install `matrix-commander` with `pip install matrix-commander`
you *must* have `libolm` installed. `pip` installation will fail otherwise!
you *must* have followed these prerequisites steps! Otherwise `pip` will fail.

For e2ee support, python-olm is needed which requires the
[libolm](https://gitlab.matrix.org/matrix-org/olm) C library (version 3.x).
- Note that even if you install via `pip` you must have a) Python 3.8+
and b) `libolm` installed.
- Run `python -V` to get your Python version number and assure that it is
3.8+.
- For e2ee support, python-olm is needed which requires the libolm C
library (version 3.x). See also https://gitlab.matrix.org/matrix-org/olm.
Make sure that version 3 is installed. Version 2 will not work.
To install `libolm` do this:
- On Debian, Ubuntu and Debian/Ubuntu derivative distributions: `sudo apt install libolm-dev`
- On Fedora or Fedora derivative distributions do: `sudo dnf install libolm-devel`
- On MacOS use brew: `brew install libolm`

- On Debian, Ubuntu and Debian or Ubuntu derivate distributions do `sudo apt install libolm-dev` to install the `libolm` package.
- On Fedora or Fedora derivate distributions do `sudo dnf install libolm-devel` to install the `libolm` package.
- On MacOS one can use [brew](https://brew.sh/) to install package `libolm`.
- For macOS Monterey 12.4 (21F79) (Apple M1 Pro) and similar please follow
these steps for installation:

Make sure that version 3 is installed. Version 2 will not work.
- Install `libolm`, `dbus` and `libmagic` using Homebrew:
- `brew install libolm dbus libmagic`
- Install `matrix-commander` using this command:
- `pip3 install --global-option=build_ext --global-option="-I/opt/homebrew/include/" --global-option="-L/opt/homebrew/lib/" matrix-commander`
- For more details see Issue #79. Thanks to @KizzyCode for the contribution.

For macOS Monterey 12.4 (21F79) (Apple M1 Pro) and similar please follow
the these steps:
- Install `libolm`, `dbus` and `libmagic` using Homebrew
- Install `matrix-commander` using this command:
- `pip3 install --global-option=build_ext --global-option="-I/opt/homebrew/include/" --global-option="-L/opt/homebrew/lib/" matrix-commander`
- For more details see Issue #79. Thanks to @KizzyCode for the contribution.
- For macOS x86_64 and similar please follow these steps for installation:

On macOS x86_64, do these steps for installation:
- `brew install libolm dbus libmagic`
- `pip3 install poetry`
- `pip3 install --global-option=build_ext --global-option="-I/usr/local/include/" --global-option="-L/usr/local/lib/" matrix-commander`
- Notice that the Link and Include directories between ARM (M1, etc.) and x86-64 are different.
So, check for example where file `olm.h` is located on your hard disk. That gives you a hind which Include directory to use.
- For more details see Issue #103. Thanks to @johannes87 for the contribution.
- `brew install libolm dbus libmagic`
- `pip3 install poetry`
- `pip3 install --global-option=build_ext --global-option="-I/usr/local/include/" --global-option="-L/usr/local/lib/" matrix-commander`
- Notice that the Link and Include directories between ARM (M1, etc.)
and x86-64 are different.
So, check for example where file `olm.h` is located on your hard disk.
That gives you a hint which Include directory to use.
- For more details see Issue #103. Thanks to @johannes87 for the contribution.
237 changes: 143 additions & 94 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.0.0
5.0.0
Binary file removed dist/matrix-commander-4.0.0.tar.gz
Binary file not shown.
Binary file added dist/matrix-commander-5.0.0.tar.gz
Binary file not shown.
Binary file removed dist/matrix_commander-4.0.0-py3-none-any.whl
Binary file not shown.
Binary file added dist/matrix_commander-5.0.0-py3-none-any.whl
Binary file not shown.
Loading

0 comments on commit a051546

Please sign in to comment.