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.18.0.tar.gz (153.4 kB view details)

Uploaded Source

Built Distribution

matrix_nio-0.18.0-py3-none-any.whl (181.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: matrix-nio-0.18.0.tar.gz
  • Upload date:
  • Size: 153.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for matrix-nio-0.18.0.tar.gz
Algorithm Hash digest
SHA256 0ffa58344c7b548d6d76b8430bbd5eedf57da74a8e8a0f72c59b10a4d11d05b0
MD5 01661e20304a1c0704a0ceb32945e1b0
BLAKE2b-256 65fc26a4f073871ec3ffe15d2f4de80e90b0c0b1c95c4a75b4abc1b60fd1f40e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: matrix_nio-0.18.0-py3-none-any.whl
  • Upload date:
  • Size: 181.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for matrix_nio-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee16e853ba2a9237a23be6f216080d12de331aa45a20172fb72cad1c0bb3ab16
MD5 5d02aa402c8c4224ec5b714648c0133e
BLAKE2b-256 1b390b98b5bb97703b38133dc38c444d2c57c6979bcd5e8ac60ec657f00799fc

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