Skip to main content

Client-Server SDK for Matrix

Project description

Matrix Client SDK for Python

Latest Version

This is a Matrix client-server SDK for Python 2.x.

Usage

The SDK provides 2 layers of interaction. The low-level layer just wraps the raw HTTP API calls. The high-level layer wraps the low-level layer and provides an object model to perform actions on.

Client:

from matrix_client.client import MatrixClient

client = MatrixClient("http://localhost:8008")
token = client.register_with_password(username="foobar", password="monkey")
room = client.create_room("my_room_alias")
room.send_text("Hello!")

API:

from matrix_client.api import MatrixHttpApi

matrix = MatrixHttpApi("https://matrix.org", token="some_token")
response = matrix.initial_sync()
response = matrix.send_message("!roomid:matrix.org", "Hello!")

Structure

The SDK is split into two modules: api and client.

API

This contains the raw HTTP API calls and has minimal business logic. You can set the access token (token) to use for requests as well as set a custom transaction ID (txn_id) which will be incremented for each request.

Client

This encapsulates the API module and provides object models such as Room.

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_client-0.0.2.tar.gz (10.0 kB view details)

Uploaded Source

File details

Details for the file matrix_client-0.0.2.tar.gz.

File metadata

File hashes

Hashes for matrix_client-0.0.2.tar.gz
Algorithm Hash digest
SHA256 bbc832010bfa59596528ea51fb2444763fedb462685cf8fa9dd75acb0ee873f0
MD5 569bd72f26c3e89202510176862e4757
BLAKE2b-256 ce59c9d91f9df2f52c6a54a90ad15c77b26b6edaaf21510259d130c78ee41384

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