{ "info": { "author": "Richard Nys\u00e4ter", "author_email": "richard@nysater.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: OS Independent", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Communications :: Chat" ], "description": "# chaanbot\n\nA python 3 [matrix](https://matrix.org) bot using [matrix-python-sdk](https://github.com/matrix-org/matrix-python-sdk).\nThe bot is extensible and currently provides:\n* Highlight module allows users to easily notify groups of users.\nE.g. \"!hl javadevs spring-boot vs micronaut?\" would higlight any user in the javadevs group.\n* Weather module allows users to broadcast weather reports.\n* More to come!\n\nBot is under active development and severe breaking changes should be expected until a stable release is created.\n\n# Install instructions\nChaanbot requires Python 3.\n\nAdd user for bot. Not required but recommended:\n```\nsudo adduser --disabled-password chaanbot\nsudo su chaanbot\n```\n\nCreate virtual environment and install bot and its dependencies:\n```\npython3 -m venv chaanbot\nsource chaanbot/bin/activate\npython3 -m pip install chaanbot\n```\n\nStart bot to initialize config file creation, then edit the config file to your liking.\nConfig file location is the user's config directory as determined by appdirs, typical locations are:\n\n Mac OS X: ~/Library/Application Support/chaanbot/chaanbot.cfg\n Unix: ~/.config/chaanbot/chaanbot.cfg or in $XDG_CONFIG_HOME, if defined\n Win *: C:\\Users\\\\AppData\\[local or roaming]\\chaanbot\\chaanbot\\chaanbot.cfg\n\nOutput of running the bot will also show where the config file is located:\n```\nchaanbot\nnano .config/chaanbot/chaanbot.cfg\n```\n\nBot should now be runnable as chaanbot user:\n```\nchaanbot\n```\n\nFor convenience bot can be added as service.\nWith sudo access, copy chaanbot.service file to /etc/systemd/system/chaanbot.service:\n```\nsudo nano /etc/systemd/system/chaanbot.service\n```\nBot is now startable from systemctl:\n\n```\nsudo service chaanbot start\n```\n\nAnd can be set to run on boot:\n```\nsudo systemctl enable chaanbot\n```\n\n# Upgrading version\n```\nsudo su chaanbot\nsource /home/chaanbot/chaanbot/bin/activate\npython3 -m pip install -U chaanbot\n```\n\n# TODO\n* Improve error handling\n* Integration tests and better test coverage\n* More modules\n* Improve installation documentation for non-Ubuntu 18.04 installations :-)\n* Use Poetry for dependency management?\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/RichardNysater/chaanbot", "keywords": "matrix chat bot", "license": "GPLv3+", "maintainer": "", "maintainer_email": "", "name": "chaanbot", "package_url": "https://pypi.org/project/chaanbot/", "platform": "", "project_url": "https://pypi.org/project/chaanbot/", "project_urls": { "Homepage": "https://github.com/RichardNysater/chaanbot" }, "release_url": "https://pypi.org/project/chaanbot/1.2.3/", "requires_dist": [ "matrix-client", "appdirs", "requests" ], "requires_python": ">=3.5", "summary": "A Matrix chat bot", "version": "1.2.3" }, "last_serial": 5695292, "releases": { "0.0.24": [ { "comment_text": "", "digests": { "md5": "540e1f96044bdcdb64835a8492d22dee", "sha256": "c5094e3f4a452a2b0b57a16ccf693faacd42bca9a64d18efb8ee0596a3e48797" }, "downloads": -1, "filename": "chaanbot-0.0.24-py3-none-any.whl", "has_sig": false, "md5_digest": "540e1f96044bdcdb64835a8492d22dee", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 37529, "upload_time": "2019-08-17T07:01:31", "url": "https://files.pythonhosted.org/packages/35/d9/c14601039c5025da77eb5a99b967e83136a9a620497f1a2c2e9d91acf9f6/chaanbot-0.0.24-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "22ec7fe948029a3b025a99eee3c552e6", "sha256": "f13f86d643842e0b08589e4004e4e32b548bfb0a40cebd95a007ee0968d01381" }, "downloads": -1, "filename": "chaanbot-0.0.24.tar.gz", "has_sig": false, "md5_digest": "22ec7fe948029a3b025a99eee3c552e6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 15311, "upload_time": "2019-08-17T07:01:34", "url": "https://files.pythonhosted.org/packages/93/1b/94f49d7ea69cafda5cdf50c4a86780b84937ccb854c36c416765067ef4b0/chaanbot-0.0.24.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "57e0f16ac0835ad52a47a441fae0e416", "sha256": "f7f9951e7f3dd8d423a15f55d42aabe6a164459ef3bc32336e851f39684653bd" }, "downloads": -1, "filename": "chaanbot-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "57e0f16ac0835ad52a47a441fae0e416", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 37877, "upload_time": "2019-08-17T08:55:36", "url": "https://files.pythonhosted.org/packages/0d/8a/d99b0f998e5cf6a9c321b2b1dcf337614757aaba86ccad1c3c29552b953d/chaanbot-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fc30de68f2324270ea2174d0d08922ab", "sha256": "1e3c116c383709f1cbcb70e15b1ac3062cc19d8f9c8e23adf8a07020f93c6fab" }, "downloads": -1, "filename": "chaanbot-1.0.0.tar.gz", "has_sig": false, "md5_digest": "fc30de68f2324270ea2174d0d08922ab", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 15727, "upload_time": "2019-08-17T08:55:37", "url": "https://files.pythonhosted.org/packages/90/63/dc2f6ca6b32fa60cf20bbfc7cb6df51ae35d00943e69684035ea8dc1d2d2/chaanbot-1.0.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "7f07e7acadd1c5f886f1cb3b1e8d34ee", "sha256": "12985eaa7e6353676ce458b5a03b91a4663f2f1ae6c7caceef7ae37fab5933f7" }, "downloads": -1, "filename": "chaanbot-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "7f07e7acadd1c5f886f1cb3b1e8d34ee", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 40764, "upload_time": "2019-08-18T09:22:50", "url": "https://files.pythonhosted.org/packages/b9/c0/06175eaa68e502c9d903446a04583a28e8fec10cd3edbd14b311e8e20d6b/chaanbot-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9e50eefe0aab3c642269bfd8206fe655", "sha256": "ef9d001c30ecfb3ec59b242ed1d7ef8febd58b14ef47b58829e8181bf6f7a110" }, "downloads": -1, "filename": "chaanbot-1.1.1.tar.gz", "has_sig": false, "md5_digest": "9e50eefe0aab3c642269bfd8206fe655", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 16547, "upload_time": "2019-08-18T09:22:52", "url": "https://files.pythonhosted.org/packages/b3/36/97741ccb62c0f5e099e2c32904a1ad8fb820e9bdab09105a17e85c26ad85/chaanbot-1.1.1.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "8f2547f05e0995638e5522684bcb21d5", "sha256": "a1a47ce9bb21dc3e97481b6fef10391249dc2ca625646cd8a0830118a3a90f39" }, "downloads": -1, "filename": "chaanbot-1.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8f2547f05e0995638e5522684bcb21d5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 43412, "upload_time": "2019-08-18T13:06:25", "url": "https://files.pythonhosted.org/packages/82/5c/89c6bd8694c32de604fe56a51c820502f9db60d76aecd0770297cc7b1998/chaanbot-1.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f43919b63c533b6d4338af9a5ed0c00b", "sha256": "9f31ea6485edde15796b8c0142ccd2030a673d4d717bde0fb0533cb9ed6163b0" }, "downloads": -1, "filename": "chaanbot-1.2.0.tar.gz", "has_sig": false, "md5_digest": "f43919b63c533b6d4338af9a5ed0c00b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 18208, "upload_time": "2019-08-18T13:06:26", "url": "https://files.pythonhosted.org/packages/b4/e9/17fee8badfbc1fcaea29cf952ec9342b61164981e5da4f75e2667f44ec76/chaanbot-1.2.0.tar.gz" } ], "1.2.1": [ { "comment_text": "", "digests": { "md5": "918e9b572e0f3379386b3e51aa3b74af", "sha256": "8509aa209d3379f0c152a29cc19f96ed172fd4e40a94213c6b2aea432f4a49ec" }, "downloads": -1, "filename": "chaanbot-1.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "918e9b572e0f3379386b3e51aa3b74af", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 44952, "upload_time": "2019-08-18T15:59:09", "url": "https://files.pythonhosted.org/packages/11/7f/9b1f8aa68af954478fb0a1ea9169a117b8e7e860e8c7a8f82166274800f0/chaanbot-1.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "54ac493ba8adcc40be82585928be59db", "sha256": "7056a9a5149d4f4185356b64e29d3452be21a0dab40771e8b9a2a8f90a892713" }, "downloads": -1, "filename": "chaanbot-1.2.1.tar.gz", "has_sig": false, "md5_digest": "54ac493ba8adcc40be82585928be59db", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 18709, "upload_time": "2019-08-18T15:59:10", "url": "https://files.pythonhosted.org/packages/ac/ad/044c8b08fb6cf32a4f83658d38c501df3095ed9c1a09347e9473f7e06e64/chaanbot-1.2.1.tar.gz" } ], "1.2.2": [ { "comment_text": "", "digests": { "md5": "7991044ab0ba85625fd96f67b639facc", "sha256": "dfc72cbaebc83895ae776748e86187abc9c224545366a690a4d147d3f08780d4" }, "downloads": -1, "filename": "chaanbot-1.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "7991044ab0ba85625fd96f67b639facc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 44979, "upload_time": "2019-08-18T17:08:00", "url": "https://files.pythonhosted.org/packages/95/6c/ddff736149c93f71a3530ff0e80e09294f5175c1b3bcfdb6cd8cb2a61516/chaanbot-1.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bf21bff6764d8961ce95f5423f13d0f2", "sha256": "148a38eeb05997fdd836b75ae66940acecf962455b679a495796bc0b256aefb7" }, "downloads": -1, "filename": "chaanbot-1.2.2.tar.gz", "has_sig": false, "md5_digest": "bf21bff6764d8961ce95f5423f13d0f2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 18735, "upload_time": "2019-08-18T17:08:02", "url": "https://files.pythonhosted.org/packages/83/ce/fc79628af13482a76931b352808c48ba7a762649e5bdee782e9ed4fccdb0/chaanbot-1.2.2.tar.gz" } ], "1.2.3": [ { "comment_text": "", "digests": { "md5": "01f5eee06b3401e4d291c7f143c801de", "sha256": "75ddbaafcd97c76e494ad3ea453b6dcda1dc667ef7bcb84d88d9a43b7c550c7d" }, "downloads": -1, "filename": "chaanbot-1.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "01f5eee06b3401e4d291c7f143c801de", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 44984, "upload_time": "2019-08-18T17:20:07", "url": "https://files.pythonhosted.org/packages/f5/4d/ae04c416bb196c243b75886494f5c67312907e8897966df4ef98293665cc/chaanbot-1.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "46cfd47134559e12fbd0cd8dae6a44af", "sha256": "f69e2fef7cfbb2a0b173692caa5614a302489fb8fcb0bd369e46158aaaa84956" }, "downloads": -1, "filename": "chaanbot-1.2.3.tar.gz", "has_sig": false, "md5_digest": "46cfd47134559e12fbd0cd8dae6a44af", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 18746, "upload_time": "2019-08-18T17:20:10", "url": "https://files.pythonhosted.org/packages/b0/a2/3257286760f635a6579306d5204657180d3c31afc5fb6b9dd279eb05b710/chaanbot-1.2.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "01f5eee06b3401e4d291c7f143c801de", "sha256": "75ddbaafcd97c76e494ad3ea453b6dcda1dc667ef7bcb84d88d9a43b7c550c7d" }, "downloads": -1, "filename": "chaanbot-1.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "01f5eee06b3401e4d291c7f143c801de", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 44984, "upload_time": "2019-08-18T17:20:07", "url": "https://files.pythonhosted.org/packages/f5/4d/ae04c416bb196c243b75886494f5c67312907e8897966df4ef98293665cc/chaanbot-1.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "46cfd47134559e12fbd0cd8dae6a44af", "sha256": "f69e2fef7cfbb2a0b173692caa5614a302489fb8fcb0bd369e46158aaaa84956" }, "downloads": -1, "filename": "chaanbot-1.2.3.tar.gz", "has_sig": false, "md5_digest": "46cfd47134559e12fbd0cd8dae6a44af", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 18746, "upload_time": "2019-08-18T17:20:10", "url": "https://files.pythonhosted.org/packages/b0/a2/3257286760f635a6579306d5204657180d3c31afc5fb6b9dd279eb05b710/chaanbot-1.2.3.tar.gz" } ] }