Client-Server SDK for Matrix - development fork
Matrix Client SDK for Python
This is a Matrix client-server SDK for Python 2.7 and 3.4+
Community discussion on usage of this SDK and development of this SDK can be found at #matrix-python-sdk:matrix.org.
Documentation can be found at http://matrix-org.github.io/matrix-python-sdk/
Install with pip from pypi. This will install all necessary dependencies as well.
pip install matrix_client
Install using setup.py in root project directory. This will also install all needed dependencies.
git clone https://github.com/matrix-org/matrix-python-sdk.git cd matrix-python-sdk python setup.py install
The Olm bindings are not yet hosted on PyPI. Hence it it necessary to pass --process-dependency-links when installing with pip, in order to fetch them from their Git repository. For example replace python setup.py install in the above instructions by pip install --process-dependency-links .[e2e].
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.
from matrix_client.client import MatrixClient client = MatrixClient("http://localhost:8008") # New user token = client.register_with_password(username="foobar", password="monkey") # Existing user token = client.login_with_password(username="foobar", password="monkey") room = client.create_room("my_room_alias") room.send_text("Hello!")
from matrix_client.api import MatrixHttpApi matrix = MatrixHttpApi("https://matrix.org", token="some_token") response = matrix.send_message("!roomid:matrix.org", "Hello!")
The SDK is split into two modules: api and client.
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.
This encapsulates the API module and provides object models such as Room.
A collection of samples are included, written in Python 3.
You can either install the SDK, or run the sample like this:
PYTHONPATH=. python samples/samplename.py
Building the Documentation
The documentation can be built by installing sphinx and sphinx_rtd_theme.
Simple run make inside docs which will list the avaliable output formats.
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|matrix_client_harmonyqt-0.4.2.dev5-py2.py3-none-any.whl (86.0 kB) Copy SHA256 hash SHA256||Wheel||py2.py3|
|matrix_client_harmonyqt-0.4.2.dev5.tar.gz (84.9 kB) Copy SHA256 hash SHA256||Source||None|