{ "info": { "author": "The Matrix.org Team", "author_email": "team@matrix.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Communications :: Chat", "Topic :: Communications :: Conferencing" ], "description": "Matrix Client SDK for Python\n============================\n\n.. image:: https://img.shields.io/pypi/v/matrix-client.svg?maxAge=600\n :target: https://pypi.python.org/pypi/matrix-client\n :alt: Latest Version\n.. image:: https://travis-ci.org/matrix-org/matrix-python-sdk.svg?branch=master\n :target: https://travis-ci.org/matrix-org/matrix-python-sdk\n :alt: Travis-CI Results\n.. image:: https://coveralls.io/repos/github/matrix-org/matrix-python-sdk/badge.svg?branch=master\n :target: https://coveralls.io/github/matrix-org/matrix-python-sdk?branch=master\n :alt: coveralls.io Results\n\n\nThis is a Matrix client-server SDK for Python 2.7 and 3.4+\n\nCommunity discussion on usage of this SDK and development of this SDK can be\nfound at `#matrix-python-sdk:matrix.org`_.\n\nDocumentation can be found at http://matrix-org.github.io/matrix-python-sdk/\n\n.. _`#matrix-python-sdk:matrix.org`: https://matrix.to/#/%23matrix-python-sdk:matrix.org\n\n\n\nInstallation\n============\nStable release\n--------------\nInstall with pip from pypi. This will install all necessary dependencies as well.\n\n.. code:: shell\n\n pip install matrix_client\n\nDevelopment version\n-------------------\nInstall using ``setup.py`` in root project directory. This will also install all\nneeded dependencies.\n\n.. code:: shell\n\n git clone https://github.com/matrix-org/matrix-python-sdk.git\n cd matrix-python-sdk\n python setup.py install\n\nUsage\n=====\nThe SDK provides 2 layers of interaction. The low-level layer just wraps the\nraw HTTP API calls. The high-level layer wraps the low-level layer and provides\nan object model to perform actions on.\n\nClient:\n\n.. code:: python\n\n from matrix_client.client import MatrixClient\n\n client = MatrixClient(\"http://localhost:8008\")\n\n # New user\n token = client.register_with_password(username=\"foobar\", password=\"monkey\")\n\n # Existing user\n token = client.login_with_password(username=\"foobar\", password=\"monkey\")\n\n room = client.create_room(\"my_room_alias\")\n room.send_text(\"Hello!\")\n\n\nAPI:\n\n.. code:: python\n\n from matrix_client.api import MatrixHttpApi\n\n matrix = MatrixHttpApi(\"https://matrix.org\", token=\"some_token\")\n response = matrix.send_message(\"!roomid:matrix.org\", \"Hello!\")\n\n\nStructure\n=========\nThe SDK is split into two modules: ``api`` and ``client``.\n\nAPI\n---\nThis contains the raw HTTP API calls and has minimal business logic. You can\nset the access token (``token``) to use for requests as well as set a custom\ntransaction ID (``txn_id``) which will be incremented for each request.\n\nClient\n------\nThis encapsulates the API module and provides object models such as ``Room``.\n\nSamples\n=======\nA collection of samples are included, written in Python 3.\n\nYou can either install the SDK, or run the sample like this:\n\n.. code:: shell\n\n PYTHONPATH=. python samples/samplename.py\n\nBuilding the Documentation\n==========================\n\nThe documentation can be built by installing ``sphinx`` and ``sphinx_rtd_theme``.\n\nSimple run ``make`` inside ``docs`` which will list the avaliable output formats.\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/matrix-org/matrix-python-sdk", "keywords": "chat sdk matrix matrix.org", "license": "Apache License, Version 2.0", "maintainer": "", "maintainer_email": "", "name": "matrix-client", "package_url": "https://pypi.org/project/matrix-client/", "platform": "", "project_url": "https://pypi.org/project/matrix-client/", "project_urls": { "Homepage": "https://github.com/matrix-org/matrix-python-sdk" }, "release_url": "https://pypi.org/project/matrix-client/0.3.2/", "requires_dist": null, "requires_python": "", "summary": "Client-Server SDK for Matrix", "version": "0.3.2" }, "last_serial": 3987587, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "a80f19752fada7cebc064b898cd09791", "sha256": "91e99bd62b4688d7f30201f40c1b5803dc867285dffc69d751cba3b16094e806" }, "downloads": -1, "filename": "matrix_client-0.0.1.tar.gz", "has_sig": false, "md5_digest": "a80f19752fada7cebc064b898cd09791", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7989, "upload_time": "2015-01-07T09:54:36", "url": "https://files.pythonhosted.org/packages/8a/d4/3c6d2e8cf894126f623b23e5cdebfe530980e80e65212a362b560c71e417/matrix_client-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "569bd72f26c3e89202510176862e4757", "sha256": "bbc832010bfa59596528ea51fb2444763fedb462685cf8fa9dd75acb0ee873f0" }, "downloads": -1, "filename": "matrix_client-0.0.2.tar.gz", "has_sig": false, "md5_digest": "569bd72f26c3e89202510176862e4757", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10005, "upload_time": "2015-08-12T09:03:53", "url": "https://files.pythonhosted.org/packages/ce/59/c9d91f9df2f52c6a54a90ad15c77b26b6edaaf21510259d130c78ee41384/matrix_client-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "4f392e3f9b8b564cbd7a3fe4fdd36577", "sha256": "40b90864967065ea668cc243f842f6e922e575c97326783c164b2d153b3fc550" }, "downloads": -1, "filename": "matrix-client-0.0.3.tar.gz", "has_sig": false, "md5_digest": "4f392e3f9b8b564cbd7a3fe4fdd36577", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14258, "upload_time": "2016-05-05T13:47:18", "url": "https://files.pythonhosted.org/packages/0c/81/36e6fbddfa34c9507e1387ec62b8539589999cd2726c8199dcc7653c1213/matrix-client-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "a2658357780a54e8d487e82ae330891b", "sha256": "2125b0167ec241e6e9f6e76791dd3d5c5995f8900de80f663b13819c39f786e8" }, "downloads": -1, "filename": "matrix-client-0.0.4.tar.gz", "has_sig": false, "md5_digest": "a2658357780a54e8d487e82ae330891b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20421, "upload_time": "2016-08-15T08:59:59", "url": "https://files.pythonhosted.org/packages/6d/81/94703a0e9f6d830795946aedd359beecb1fe07122a7d1e69fe6b9ec1ef73/matrix-client-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "53a112127902fb5b69fe1a1090bfe505", "sha256": "65efa6f22710703f783372897141a8a25a63758d8f3f1cb47258d1c365c48b71" }, "downloads": -1, "filename": "matrix_client-0.0.5-py3.6.egg", "has_sig": false, "md5_digest": "53a112127902fb5b69fe1a1090bfe505", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 37182, "upload_time": "2018-04-18T17:25:06", "url": "https://files.pythonhosted.org/packages/ba/ac/ab7a247778858744a09f58d5dabbf6fa34a0691e7910b7cbbe2ddfce7697/matrix_client-0.0.5-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "245a1709c899c21ae61e6cf0323fde5a", "sha256": "a3fc8817c87f1a9bf81c3f3d2a3d020db7aed56c4207d076312ab0f3380c686f" }, "downloads": -1, "filename": "matrix-client-0.0.5.tar.gz", "has_sig": false, "md5_digest": "245a1709c899c21ae61e6cf0323fde5a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21092, "upload_time": "2016-10-14T12:26:56", "url": "https://files.pythonhosted.org/packages/da/8b/823c24ccc0f30d5b88c7f7d5b2453d84e3e46dd7f6e48e46baf6cf1656e6/matrix-client-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "d481607d730abe24c235cb5e3ccbf68c", "sha256": "38428949978065e56dd09ec35356784b59e982e1644a7fbb06994323fa2d7d96" }, "downloads": -1, "filename": "matrix-client-0.0.6.tar.gz", "has_sig": false, "md5_digest": "d481607d730abe24c235cb5e3ccbf68c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25507, "upload_time": "2017-03-10T17:39:41", "url": "https://files.pythonhosted.org/packages/a9/b8/6f53131f73628df7f79f84a83922c8b90c34c099419d8995473a5ad37f6b/matrix-client-0.0.6.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "cf1855dc5dbde4a084716497950827b3", "sha256": "4c22548f57ad858e7f7aa123f34bc3885ed4cc307aef6fefb83f226af06bd4f7" }, "downloads": -1, "filename": "matrix_client-0.1.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "cf1855dc5dbde4a084716497950827b3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 21849, "upload_time": "2018-03-27T01:14:58", "url": "https://files.pythonhosted.org/packages/2b/14/710a67497203ee833a13c8de8c0a79864e6ab1a08c4ea38eaddad977fec0/matrix_client-0.1.0-py2.py3-none-any.whl" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "1c4e945bf019840dde39ed24e648232b", "sha256": "138cc15937c04edc1fdfc25ef0bc630fa34a086a387a56b709359d26a31cbdc2" }, "downloads": -1, "filename": "matrix_client-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1c4e945bf019840dde39ed24e648232b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 22139, "upload_time": "2018-04-18T17:25:04", "url": "https://files.pythonhosted.org/packages/7d/25/878db485dd74c058e4ad4d1e73b4174fdc9cd4a54dd6227e14684a0f6133/matrix_client-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "373d961b0258ba2644fc110d4ccd94c6", "sha256": "b96e87adf1bc2270166b2a4cff1320d2ef283779ea8b3c4edd0d9051fc7b7924" }, "downloads": -1, "filename": "matrix_client-0.2.0.tar.gz", "has_sig": false, "md5_digest": "373d961b0258ba2644fc110d4ccd94c6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34867, "upload_time": "2018-04-18T17:25:07", "url": "https://files.pythonhosted.org/packages/80/54/a5d12bef76bf5afd2899cfe3eac088768714de03e5ecd00b3ed2456550f1/matrix_client-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "96da79ffa4b21c1c776a8c4eb1cafed1", "sha256": "bcb024107483460985864993c87ebf2c5f016827eb4f78cde21ec4e8a395a2e5" }, "downloads": -1, "filename": "matrix_client-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "96da79ffa4b21c1c776a8c4eb1cafed1", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 28513, "upload_time": "2018-06-22T02:05:45", "url": "https://files.pythonhosted.org/packages/ed/f6/52a353b6df5f5e60718a072abe3e18115c04f500a1717f6653eefcb3f251/matrix_client-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "645ea91f6e48089b748a2abe347296af", "sha256": "49eeb85d901ce9191bd379fdc8f5b7dcaa64fff7e0d086a56bcd363f12b0c296" }, "downloads": -1, "filename": "matrix_client-0.3.0.tar.gz", "has_sig": false, "md5_digest": "645ea91f6e48089b748a2abe347296af", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38874, "upload_time": "2018-06-22T02:05:43", "url": "https://files.pythonhosted.org/packages/87/95/03d1432c24ad8221a3df83f6aeb6d7bfc7d6d3075ff8877139ae7f756e68/matrix_client-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "a5911c8d5f999f80c80e38fdbe99bca8", "sha256": "1b632998708fd3e47e03ffec725eaa07910a4fdd21f41d8552267f452257ad3f" }, "downloads": -1, "filename": "matrix_client-0.3.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a5911c8d5f999f80c80e38fdbe99bca8", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 28507, "upload_time": "2018-06-22T02:12:33", "url": "https://files.pythonhosted.org/packages/9d/d6/33e210ed0dfca1a9a509bc456c17138ed3fd814df66248422fafab39618d/matrix_client-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "efeec6b9c790fa45bcd6eae1b4664158", "sha256": "28779cb27d1e3ed3f27b03ef11e87f382d3f27cf82888be92691b073a6fa4f31" }, "downloads": -1, "filename": "matrix_client-0.3.1.tar.gz", "has_sig": false, "md5_digest": "efeec6b9c790fa45bcd6eae1b4664158", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38871, "upload_time": "2018-06-22T02:12:35", "url": "https://files.pythonhosted.org/packages/1d/4e/bd47af03ce9ca66161f59a1b9b6ad9e2f41cd4b822b497cb828bff77f4f3/matrix_client-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "0812b05268f3b0704c41be20713d5056", "sha256": "2855a2614a177db66f9bc3ba38cbd2876041456f663c334f72a160ab6bb11c49" }, "downloads": -1, "filename": "matrix_client-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0812b05268f3b0704c41be20713d5056", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 28512, "upload_time": "2018-06-22T02:23:49", "url": "https://files.pythonhosted.org/packages/6b/0b/65dc841fd3d14e7ebc6081bbfce23365a6b2f68cc6ae2ae2d1d7d59570cd/matrix_client-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e0231d84e7209a17581660c30f35d7a1", "sha256": "dce3ccb8665df0d519f08e07a16e6d3f9fab3a947df4b7a7c4bb26573d68f2d5" }, "downloads": -1, "filename": "matrix_client-0.3.2.tar.gz", "has_sig": false, "md5_digest": "e0231d84e7209a17581660c30f35d7a1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38878, "upload_time": "2018-06-22T02:23:50", "url": "https://files.pythonhosted.org/packages/36/dd/b69819db7e01efb3487093e085b806184c013273741c8be9e4c7bd0df102/matrix_client-0.3.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0812b05268f3b0704c41be20713d5056", "sha256": "2855a2614a177db66f9bc3ba38cbd2876041456f663c334f72a160ab6bb11c49" }, "downloads": -1, "filename": "matrix_client-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0812b05268f3b0704c41be20713d5056", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 28512, "upload_time": "2018-06-22T02:23:49", "url": "https://files.pythonhosted.org/packages/6b/0b/65dc841fd3d14e7ebc6081bbfce23365a6b2f68cc6ae2ae2d1d7d59570cd/matrix_client-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e0231d84e7209a17581660c30f35d7a1", "sha256": "dce3ccb8665df0d519f08e07a16e6d3f9fab3a947df4b7a7c4bb26573d68f2d5" }, "downloads": -1, "filename": "matrix_client-0.3.2.tar.gz", "has_sig": false, "md5_digest": "e0231d84e7209a17581660c30f35d7a1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38878, "upload_time": "2018-06-22T02:23:50", "url": "https://files.pythonhosted.org/packages/36/dd/b69819db7e01efb3487093e085b806184c013273741c8be9e4c7bd0df102/matrix_client-0.3.2.tar.gz" } ] }