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

Uploaded Source

Built Distribution

matrix_nio-0.15.0-py3-none-any.whl (173.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: matrix-nio-0.15.0.tar.gz
  • Upload date:
  • Size: 145.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.5 Linux/5.8.1-arch1-1

File hashes

Hashes for matrix-nio-0.15.0.tar.gz
Algorithm Hash digest
SHA256 53bcc05ee25714c05b1e73ebde29b3ec62fd69de4c43f365cfaefd9a45e421f3
MD5 8a9127814128ea90730c07dd22cfdebe
BLAKE2b-256 5ee65f364e68caa46bd20536780e9e9dc606c0fba779ee01f0556adedf13614e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: matrix_nio-0.15.0-py3-none-any.whl
  • Upload date:
  • Size: 173.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.5 Linux/5.8.1-arch1-1

File hashes

Hashes for matrix_nio-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1740a34b34e78f0fc3ecb98381080587b73d3013f55e3fd388ff85d23a3a2197
MD5 b978d50613224187b5e62f9b3507737e
BLAKE2b-256 d3ac054b9e8aac550ad6037632c0eebe607859005accda3bde6bca33a6537b4a

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