Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poljar/matrix-nio
A Python Matrix client library, designed according to sans I/O (http://sans-io.readthedocs.io/) principles
https://github.com/poljar/matrix-nio
Last synced: 3 months ago
JSON representation
A Python Matrix client library, designed according to sans I/O (http://sans-io.readthedocs.io/) principles
- Host: GitHub
- URL: https://github.com/poljar/matrix-nio
- Owner: matrix-nio
- License: other
- Created: 2018-04-06T11:32:18.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T02:41:39.000Z (6 months ago)
- Last Synced: 2024-05-22T03:37:50.718Z (6 months ago)
- Language: Python
- Homepage:
- Size: 7.82 MB
- Stars: 543
- Watchers: 15
- Forks: 150
- Open Issues: 81
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - poljar/matrix-nio - A Python Matrix client library, designed according to sans I/O (http://sans-io.readthedocs.io/) principles (others)
README
nio
===
[](https://github.com/matrix-nio/matrix-nio/actions)
[](https://pypi.org/project/matrix-nio/)
[](https://codecov.io/gh/matrix-nio/matrix-nio)
[](https://github.com/matrix-nio/matrix-nio/blob/master/LICENSE.md)
[](https://matrix-nio.readthedocs.io/en/latest/?badge=latest)
[](https://matrix.to/#/!JiiOHXrIUCtcOJsZCa:matrix.org?via=matrix.org&via=maunium.net&via=t2l.io)
nio is a multilayered [Matrix](https://matrix.org/) 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](https://github.com/aio-libs/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](https://matrix-nio.readthedocs.io/en/latest/#api-documentation)
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](https://matrix.org/docs/spec/client_server/r0.6.0#id183)
- ✅ 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.reaction`s
- ✅ `m.tag`s
- ❌ cross-signing support
- ❌ server-side key backups (room key backup, "Secure Backup")
- ❌ user deactivation ([#112](https://github.com/matrix-nio/matrix-nio/issues/112))
- ❌ in-room emoji verification
Installation
------------
To install nio, simply use pip:
```bash
$ 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](https://gitlab.matrix.org/matrix-org/olm) 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](https://brew.sh/) 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:
```bash
$ 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](https://matrix-nio.readthedocs.io/en/latest/examples.html)