A Python Matrix client library, designed according to sans I/O principles.
Project description
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.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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file matrix_nio-0.21.1.tar.gz.
File metadata
- Download URL: matrix_nio-0.21.1.tar.gz
- Upload date:
- Size: 147.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3e2bbd66ea71df9f01ad507528c6f8e29d2e1d2469eed834dd85e98204348bd8 |
|
| MD5 | 0e8ff41e2a91235ef473a24d1a596cc9 |
|
| BLAKE2b-256 | 8536c10a41bacdab9c2739ed344e5ec9194ad3c67b8a39247a0bc8a82851f0ac |
Provenance
File details
Details for the file matrix_nio-0.21.1-py3-none-any.whl.
File metadata
- Download URL: matrix_nio-0.21.1-py3-none-any.whl
- Upload date:
- Size: 173.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 68e8e6978d99df224cb4b382b54f70881d96dda03b53edbc0bb048a22dad0c5d |
|
| MD5 | e33b92d73e6f7c4a8c74d308772b18ef |
|
| BLAKE2b-256 | 4d450b08565eed87fb483a37b63150f439d297ae69cc641e0a2d4ffa5d470b10 |
