nio
nio is a multilayered Matrix client library. The underlying base layer doesn't do any network IO on its own, but on top of that is a full-fledged batteries-included asyncio layer using aiohttp. File IO is only done if you enable end-to-end encryption (E2EE).
Documentation
The full API documentation for nio can be found at https://matrix-nio.readthedocs.io
Features
nio has most of the features you'd expect in a Matrix library, but it's still a work in progress.
- ✅ transparent end-to-end encryption (EE2E)
- ✅ encrypted file uploads & downloads
- ✅ space parents/children
- ✅ manual and emoji verification
- ✅ custom authentication types
- ✅ well-integrated type system
- ✅ knocking, kick, ban and unban
- ✅ typing notifications
- ✅ message redaction
- ✅ token based login
- ✅ user registration
- ✅ read receipts
- ✅ live syncing
- ✅
m.reactions - ✅
m.tags - ❌ cross-signing support
- ❌ server-side key backups (room key backup, "Secure Backup")
- ❌ user deactivation (#112)
- ❌ threading support
- ❌ in-room emoji verification
Installation
To install nio, simply use pip:
$ pip install matrix-nio
Note that this installs nio without end-to-end encryption support. For e2ee
support, python-olm is needed which requires the
libolm C library (version 3.x).
On Debian and Ubuntu one can use apt-get to install package libolm-dev.
On Fedora one can use dnf to install package libolm-devel.
On MacOS one can use brew to install package libolm.
Make sure version 3 is installed.
After libolm has been installed, the e2ee enabled version of nio can be installed using pip:
$ pip install matrix-nio[e2e]
Additionally, a docker image with the e2ee enabled version of nio is provided in
the docker/ directory.
Examples
For examples of how to use nio, and how others are using it, read the docs
2 maintainers
Release files for matrix-nio 0.24.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| matrix_nio-0.24.0.tar.gz | 150.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| matrix_nio-0.24.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:326.7 kB
Release files / matrix_nio-0.24.0.tar.gz
| Download URL | matrix_nio-0.24.0.tar.gz |
|---|---|
| Size | 150.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
75f9c58958dbe353bec29be1854835df6d91e6f3be2952261a3a27c99ea896b9
|
|
BLAKE2b-256 checksum How to use checksums |
56fa7201f86adce5bd1b63f8970904d51a274ed2ea30160da51a60ac7a8597fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.1
|
Release files / matrix_nio-0.24.0-py3-none-any.whl
| Download URL | matrix_nio-0.24.0-py3-none-any.whl |
|---|---|
| Size | 176.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
87bcf8139e081e8e85ced2d02a2be08662bf1accb726e850325b4ab3c840e946
|
|
BLAKE2b-256 checksum How to use checksums |
123aee8afa828c70e60007f204416e875d4cd7f1a7dd361d00ed76ac646aef7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.1
|
