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 IO on its own. On top of the base layer, a no-IO HTTP client implementation exists, as well as a full fledged batteries included asyncio layer using aiohttp.
Documentation
The full API documentation for nio can be found at https://matrix-nio.readthedocs.io
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).
After libolm has been installed, the e2ee enabled version of nio can be installed using pip:
$ pip install "matrix-nio[e2e]"
Usage
Unless special requirements disallow the usage of asyncio, by far the easiest way to use nio is using the asyncio layer.
Please do note that these examples require python 3.5+ for the async/await
syntax. nio on the other hand works with older python versions as well.
Sending a message
import asyncio
from nio import AsyncClient
async def main():
client = AsyncClient("https://example.org", "@alice:example.org")
await client.login("hunter1")
await client.room_send(
room_id="!test:example.org",
message_type="m.room.message",
content={
"msgtype": "m.text",
"body": "Hello World"
}
)
await client.close()
asyncio.get_event_loop().run_until_complete(main())
Receiving messages
import asyncio
from nio import (AsyncClient, RoomMessageText)
async def message_cb(room, event):
print(
"Message received for room {} | {}: {}".format(
room.display_name, room.user_name(event.sender), event.body
)
)
async def main():
client = AsyncClient("https://example.org", "@alice:example.org")
client.add_event_callback(message_cb, RoomMessageText)
await client.login("hunter1")
await client.sync_forever(timeout=30000)
asyncio.get_event_loop().run_until_complete(main())
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.10.0.tar.gz.
File metadata
- Download URL: matrix-nio-0.10.0.tar.gz
- Upload date:
- Size: 125.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 61309abb8c393809b3056b1b4595898e11606ee8020b420a11c9a0edf9b3fac7 |
|
| MD5 | 8dc135fae3e619fd510352fade8339af |
|
| BLAKE2b-256 | aafac52c89b5ac31accda6fedfcd573f73de4ebc7bedfdea7d000f6d0a08d190 |
Provenance
File details
Details for the file matrix_nio-0.10.0-py3-none-any.whl.
File metadata
- Download URL: matrix_nio-0.10.0-py3-none-any.whl
- Upload date:
- Size: 149.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8730231af735ad73f5cd8b8909f3ec3b26a1e42b75143dd991797336aaebef57 |
|
| MD5 | 78ab7832c56692249ee1f3cc8416ac74 |
|
| BLAKE2b-256 | 6e5a6baea986826e64da5007ea1b6450ef0cf1127411cc791dfb4243e1e0da64 |
