{ "info": { "author": "Declan Hoare", "author_email": "declanhoare@exemail.com.au", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "============\nMatterbabble\n============\n\nMatterbabble is an API client for Discourse_ and Matterbridge_. It\nmirrors Discourse posts in a topic to Matterbridge messages on a\ngateway, and vice versa. It works well with the `Discourse Babble`_\nplugin, which formats a thread as a chat room.\n\n.. _Discourse: https://discourse.org/\n.. _Matterbridge: https://github.com/42wim/matterbridge\n.. _Discourse Babble: https://discourse-babble.com/\n\nInstallation and Usage\n----------------------\n\nTo install, execute::\n\n\tpip install matterbabble\n\nTo run, execute::\n\n\tpython -m matterbabble CONFIGPATH\n\nproviding the path to a Matterbabble configuration file as described\nbelow.\n\nConfiguration\n-------------\n\nMatterbabble is configured with a ``configparser`` INI file.\n\nExample::\n\n\t[discourse]\n\taddress = https://forum.bitphoenixsoftware.com/\n\tusername = matterbridge\n\ttoken = 0dwdmaddzludwvntpg7gss6dxdem7byemre3krw86k60n39vn1ni7wganakpzjd0\n\tfmt = {username}: {message}\n\n\t[matterbridge]\n\taddress = http://127.0.0.1:4242/\n\ttoken = oTUaGHctYYve28nYNMzLZszJvT1RD3kXLlZwPLULEaTFMRrGyvFzdvOdpsuQYFEhD84qL9PP5FJvGFOsQINESs1keaLO8SnvQNHHM6wq41mwHVX0NNKaBXD5uDaDhZ4p\n\n\t[connections]\n\tlounge = /babble/topics/68\n\n\t[logging]\n\tlevel = INFO\n\ndiscourse\n~~~~~~~~~\n\nThe ``discourse`` section must contain an address and API key for a\nDiscourse forum, and the username of the user you want the client to run\nas. You can also change the format used for messages going to Discourse\n(the ``fmt`` key is optional).\n\nmatterbridge\n~~~~~~~~~~~~\n\nThe ``matterbridge`` section must contain the ``BindAddress`` of a\n`Matterbridge API`_ instance. If you added a ``Token`` to the API,\nyou must also include that here.\n\nconnections\n~~~~~~~~~~~\n\nThe ``connections`` section maps Matterbridge gateways to Discourse\ntopics. The ID of a topic is the last component of the URL after you\nnavigate to it on Discourse, and the correct format is ``/topics/{id}``.\nYou can find a Babble chat room's ID by clicking on it in the admin\nchat manager. The format for those is ``/babble/topics/{id}``.\n\nlogging\n~~~~~~~\n\nThe optional ``logging`` section can contain ``basicConfig`` options\nfor ``logging`` in Matterbabble. You can set ``level`` to ``INFO`` to\nlog raw objects sent through Matterbabble to ``stderr``.\n\n.. _Matterbridge API: https://github.com/42wim/matterbridge/wiki/Api\n\nCaveat Emptor\n-------------\n\nInline images in the Discourse post are currently replaced with links\nbefore being sent to the gateway because they generally aren't\nsupported by chat rooms. Maybe there will be a better solution to this\nproblem in future.\n\nCopyright\n---------\n\nCopyright 2019 Declan Hoare\n\nLicensed under Apache License 2.0.\nNO WARRANTY\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/DeclanHoare/matterbabble", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "matterbabble", "package_url": "https://pypi.org/project/matterbabble/", "platform": "", "project_url": "https://pypi.org/project/matterbabble/", "project_urls": { "Homepage": "https://github.com/DeclanHoare/matterbabble" }, "release_url": "https://pypi.org/project/matterbabble/1.0.1/", "requires_dist": [ "aiohttp", "bidict", "commonmark", "commonmarkextensions" ], "requires_python": "", "summary": "Connect Discourse threads to Matterbridge.", "version": "1.0.1" }, "last_serial": 4848544, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "e5e523db100135de9f57e06131ce5982", "sha256": "db165d084f5e27bb925cc442a439a5999c34b88d792b8f73c2fd7c1eec0ebe07" }, "downloads": -1, "filename": "matterbabble-1.0.0-py3.7.egg", "has_sig": false, "md5_digest": "e5e523db100135de9f57e06131ce5982", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 14332, "upload_time": "2019-02-20T08:44:53", "url": "https://files.pythonhosted.org/packages/c2/f5/76db88204d10b78f7a6d89e8ae344ee2ab174d7e09ea67eaeca13dc86ef1/matterbabble-1.0.0-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "e31f874fffc2d562df629b6ee761fea4", "sha256": "8ad87535ef5cf023f82abeb02463087b9aa2a8b9ff9aae879cb7418cb95d003d" }, "downloads": -1, "filename": "matterbabble-1.0.0.tar.gz", "has_sig": false, "md5_digest": "e31f874fffc2d562df629b6ee761fea4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9468, "upload_time": "2019-02-20T08:59:35", "url": "https://files.pythonhosted.org/packages/e9/37/30f43010a653e8a58086838d697355f3ac61bc2fe95819d3deaf802deff2/matterbabble-1.0.0.tar.gz" } ], "1.0.0.post1": [ { "comment_text": "", "digests": { "md5": "8877c2b47aec89adc0bbfd6519bbee34", "sha256": "03b1720c98a8b6c271ef1b0af40f3161cb5d391f375181451d0728b659a52892" }, "downloads": -1, "filename": "matterbabble-1.0.0.post1-py3-none-any.whl", "has_sig": false, "md5_digest": "8877c2b47aec89adc0bbfd6519bbee34", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11965, "upload_time": "2019-02-20T09:07:04", "url": "https://files.pythonhosted.org/packages/22/b0/e1ebf52d82c76cc17a9f4326828459b57c02fd8604182152cc51cc65f8ff/matterbabble-1.0.0.post1-py3-none-any.whl" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "bd80f9e17355257262e0d1e6a7ba2ceb", "sha256": "83abbb2d571d0e3e44aaf0d2a67ee5902643c9ffce5f493cb33d6e6649155bca" }, "downloads": -1, "filename": "matterbabble-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "bd80f9e17355257262e0d1e6a7ba2ceb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11926, "upload_time": "2019-02-21T05:13:58", "url": "https://files.pythonhosted.org/packages/5e/00/6da33b172fea65bc8dc834d00651194022b7912fda7b88b101b7656185ca/matterbabble-1.0.1-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "bd80f9e17355257262e0d1e6a7ba2ceb", "sha256": "83abbb2d571d0e3e44aaf0d2a67ee5902643c9ffce5f493cb33d6e6649155bca" }, "downloads": -1, "filename": "matterbabble-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "bd80f9e17355257262e0d1e6a7ba2ceb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11926, "upload_time": "2019-02-21T05:13:58", "url": "https://files.pythonhosted.org/packages/5e/00/6da33b172fea65bc8dc834d00651194022b7912fda7b88b101b7656185ca/matterbabble-1.0.1-py3-none-any.whl" } ] }