Skip to main content

A Python Matrix client library, designed according to sans I/O principles.

Project description

nio

Build Status codecov license Documentation Status #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
  • ✅ manual and emoji verification
  • ✅ custom authentication types
  • ✅ well-integrated type system
  • ✅ kick, ban and unban
  • ✅ typing notifications
  • ✅ message redaction
  • ✅ token based login
  • ✅ user registration
  • ✅ read receipts
  • ✅ live syncing
  • m.tags
  • ❌ python 2.7 support
  • ❌ cross-signing support
  • ❌ user deactivation (#112)
  • ❌ in-room emoji verification
  • ❌ room upgrades and m.room.tombstone events (#47)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matrix-nio-0.17.0.tar.gz (153.3 kB view details)

Uploaded Source

Built Distribution

matrix_nio-0.17.0-py3-none-any.whl (181.4 kB view details)

Uploaded Python 3

File details

Details for the file matrix-nio-0.17.0.tar.gz.

File metadata

  • Download URL: matrix-nio-0.17.0.tar.gz
  • Upload date:
  • Size: 153.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.2 Linux/5.11.2-arch1-1

File hashes

Hashes for matrix-nio-0.17.0.tar.gz
Algorithm Hash digest
SHA256 b826d24ee9370cecf3ea82e34e1b490a0fca682833a3085af7e9087b2172b7a1
MD5 75e52f6a61c5ff9851fbe37f1be333a2
BLAKE2b-256 6edf0d9193404bfc30fbb32aac4a1bf358590d381c18f1bc2ba647beacf9e2e6

See more details on using hashes here.

Provenance

File details

Details for the file matrix_nio-0.17.0-py3-none-any.whl.

File metadata

  • Download URL: matrix_nio-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 181.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.2 Linux/5.11.2-arch1-1

File hashes

Hashes for matrix_nio-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5876a3e02be41e7065fc17ce1f46ea375ad7a7f201edc6371301b39694133e70
MD5 1b404350c5c3722c62592dcf4369002a
BLAKE2b-256 586b45129e52103f5d3e0de3066248d76b523d6e284bce5bb481c90d9962a485

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page