mindroom-nio
This fork exists primarily because I need vodozemac-backed E2EE support for
MindRoom, which relies heavily on
nio. libolm is officially deprecated, and the python-olm wheels currently stop
at CPython 3.12, making the old dependency path a poor fit for newer Python
versions. This fork keeps that support, plus a small set of other useful
pending upstream PRs, available in a published package while upstream activity
is quiet. I would be happy to see the upstream project become active again and
reduce fork-specific maintenance over time.
mindroom-nio is a fork of nio, a multilayered Matrix
client library. The distribution name is mindroom-nio; the Python import name
remains nio. 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
- ✅ threading support
- ✅ 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 (fork addition; bot-scoped producer side — self-signs the account's own device so it stays usable under MSC4153. The verifier side, Secret Storage, and key backup are not implemented. See doc/cross-signing.md.)
- ❌ server-side key backups (room key backup, "Secure Backup")
- ❌ user deactivation (#112)
- ❌ in-room emoji verification
Installation
To install mindroom-nio, simply use pip:
$ pip install mindroom-nio
Note that this installs mindroom-nio without end-to-end encryption support. The e2ee enabled version can be installed using pip:
$ pip install "mindroom-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
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mindroom_nio-0.27.3.tar.gz.
File metadata
- Download URL: mindroom_nio-0.27.3.tar.gz
- Upload date:
- Size: 167.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3c9fe9e7a4a8c1398b4f2babbe8287bce69215e779cbe1e8853f179ec366ef74
|
|
| MD5 |
8f5d4494406c70e0680585f98ba5bc0c
|
|
| BLAKE2b-256 |
4f15a7b8dc36422ab4efd6b0b2a22176aa4e751fb660d8de92bf1a2d90418705
|
Provenance
The following attestation bundles were made for mindroom_nio-0.27.3.tar.gz:
Publisher:
release.yml on mindroom-ai/mindroom-nio
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mindroom_nio-0.27.3.tar.gz -
Subject digest:
3c9fe9e7a4a8c1398b4f2babbe8287bce69215e779cbe1e8853f179ec366ef74 - Sigstore transparency entry: 2209720820
- Sigstore integration time:
-
Permalink:
mindroom-ai/mindroom-nio@208b64f8e270f5d70ca2b92c22a3d4e3fe11f95d -
Branch / Tag:
refs/tags/0.27.3 - Owner: https://github.com/mindroom-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@208b64f8e270f5d70ca2b92c22a3d4e3fe11f95d -
Trigger Event:
push
-
Statement type:
File details
Details for the file mindroom_nio-0.27.3-py3-none-any.whl.
File metadata
- Download URL: mindroom_nio-0.27.3-py3-none-any.whl
- Upload date:
- Size: 195.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3b33cd93a3e9c08bf50e8857a3fd31c7cdac43bb12f752cefe138eb0c2f8c562
|
|
| MD5 |
7966e9a4d86b8acedfc1989faabd8abe
|
|
| BLAKE2b-256 |
8bd6b1f05b246ff6ee97ccb1139b4e84592dd7858eb4ceb9dd4c92ef07f56eda
|
Provenance
The following attestation bundles were made for mindroom_nio-0.27.3-py3-none-any.whl:
Publisher:
release.yml on mindroom-ai/mindroom-nio
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mindroom_nio-0.27.3-py3-none-any.whl -
Subject digest:
3b33cd93a3e9c08bf50e8857a3fd31c7cdac43bb12f752cefe138eb0c2f8c562 - Sigstore transparency entry: 2209720870
- Sigstore integration time:
-
Permalink:
mindroom-ai/mindroom-nio@208b64f8e270f5d70ca2b92c22a3d4e3fe11f95d -
Branch / Tag:
refs/tags/0.27.3 - Owner: https://github.com/mindroom-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@208b64f8e270f5d70ca2b92c22a3d4e3fe11f95d -
Trigger Event:
push
-
Statement type:
