{ "info": { "author": "Reilly Tucker Siemens", "author_email": "reilly@tuckersiemens.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: ISC License (ISCL)", "Natural Language :: English", "Operating System :: POSIX :: BSD :: FreeBSD", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: Implementation :: CPython", "Topic :: Communications :: Chat", "Topic :: Software Development :: Libraries" ], "description": "Layabout\n========\n\n.. image:: https://img.shields.io/travis/reillysiemens/layabout/master.svg?style=flat-square&label=build\n :target: https://travis-ci.org/reillysiemens/layabout\n :alt: Unix build status on Travis CI\n\n.. image:: https://img.shields.io/coveralls/reillysiemens/layabout/master.svg?style=flat-square&label=coverage\n :target: https://coveralls.io/github/reillysiemens/layabout?branch=master\n :alt: Code coverage on Coveralls\n\n.. image:: https://img.shields.io/badge/license-ISC-blue.svg?style=flat-square\n :target: https://github.com/reillysiemens/layabout/blob/master/LICENSE\n :alt: ISC Licensed\n\n.. image:: https://img.shields.io/readthedocs/layabout/latest.svg?style=flat-square\n :target: http://layabout.readthedocs.io/en/latest/\n :alt: Docs on Read the Docs\n\n.. image:: https://img.shields.io/pypi/pyversions/layabout.svg?style=flat-square&label=python\n :target: https://pypi.org/project/layabout\n :alt: Python Version\n\n.. image:: https://img.shields.io/pypi/v/layabout.svg?style=flat-square\n :target: https://pypi.org/project/layabout\n :alt: Layabout on PyPI\n\n**Layabout** is a small event handling library on top of the Slack RTM API.\n\n.. code-block:: python\n\n from pprint import pprint\n from layabout import Layabout\n\n app = Layabout()\n\n\n @app.handle('*')\n def debug(slack, event):\n \"\"\" Pretty print every event seen by the app. \"\"\"\n pprint(event)\n\n\n @app.handle('message')\n def echo(slack, event):\n \"\"\" Echo all messages seen by the app except our own. \"\"\"\n if event.get('subtype') != 'bot_message':\n slack.rtm_send_message(event['channel'], event['text'])\n\n\n def someone_leaves(events):\n \"\"\" Return False if a member leaves, otherwise True. \"\"\"\n return not any(e.get('type') == 'member_left_channel'\n for e in events)\n\n\n if __name__ == '__main__':\n # Automatically load app token from $LAYABOUT_TOKEN and run!\n app.run(until=someone_leaves)\n print(\"Looks like someone left a channel!\")\n\nInstallation\n------------\n\nTo install **Layabout** use `pip`_ and `PyPI`_:\n\n.. code-block:: bash\n\n pip install layabout\n\nWhat's It Good For?\n-------------------\n\nYou can think of **Layabout** as a micro framework for building Slack bots.\nSince it wraps Slack's RTM API it does best with tasks like interacting with\nusers, responding to channel messages, and monitoring events. If you want more\nideas on what you can do with it check out the `examples`_.\n\nFeatures\n--------\n\nNot sold yet? Here's a list of features to sweeten the deal.\n\n- Automatically load Slack API tokens from environment variables, provide\n them directly, or even bring your own SlackClient.\n- Register multiple event handlers for one event.\n- Register a single handler for multiple events by stacking decorators.\n- Configurable application shutdown.\n- Configurable retry logic in the event of lost connections.\n- Lightweight. Depends only on the official Python `slackclient`_ library.\n\nCode of Conduct\n---------------\n\nEveryone interacting with the Layabout project's codebase is expected to follow\nthe `Code of Conduct`_.\n\n.. _pip: https://pypi.org/project/pip/\n.. _PyPI: https://pypi.org/\n.. _examples: https://github.com/reillysiemens/layabout/tree/master/examples\n.. _slackclient: https://github.com/slackapi/python-slackclient\n.. _Code of Conduct: https://github.com/reillysiemens/layabout/blob/master/CODE_OF_CONDUCT.rst\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/reillysiemens/layabout", "keywords": "Slack RTM API Bot Framework", "license": "ISCL", "maintainer": "", "maintainer_email": "", "name": "layabout", "package_url": "https://pypi.org/project/layabout/", "platform": "", "project_url": "https://pypi.org/project/layabout/", "project_urls": { "Homepage": "https://github.com/reillysiemens/layabout" }, "release_url": "https://pypi.org/project/layabout/1.0.1/", "requires_dist": [ "slackclient (~=1.2)", "flake8; extra == 'dev'", "mypy; extra == 'dev'", "pytest; extra == 'dev'", "pytest-cov; extra == 'dev'", "Sphinx; extra == 'dev'", "sphinx-autodoc-typehints; extra == 'dev'", "Sphinx; extra == 'docs'", "sphinx-autodoc-typehints; extra == 'docs'", "flake8; extra == 'test'", "mypy; extra == 'test'", "pytest; extra == 'test'", "pytest-cov; extra == 'test'" ], "requires_python": ">=3.6", "summary": "A small event handling library on top of the Slack RTM API.", "version": "1.0.1" }, "last_serial": 4376155, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "4a6414ca70474a0e4e57e8c6ab1def05", "sha256": "9545137ea40d60c734ec846b3597d1d8cd094afb70f53b3c81eb8ea34504ca87" }, "downloads": -1, "filename": "layabout-1.0.0-py3-none-any.whl", "has_sig": true, "md5_digest": "4a6414ca70474a0e4e57e8c6ab1def05", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 6657, "upload_time": "2018-06-18T09:25:26", "url": "https://files.pythonhosted.org/packages/d0/05/c10ee72db87089e03a9288fefaf4fd6c1e31d83f341f7c5cfe1e5ce18993/layabout-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b78a9bd980dad691e92f738c64f6c7fb", "sha256": "f5e37c73ccb9a386d7127cddaf6f8322d5f27ce956285215ff1a75778cd03c5d" }, "downloads": -1, "filename": "layabout-1.0.0.tar.gz", "has_sig": true, "md5_digest": "b78a9bd980dad691e92f738c64f6c7fb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 7537, "upload_time": "2018-06-18T09:25:27", "url": "https://files.pythonhosted.org/packages/26/f3/cba4d92326f2fa2e80c1bfcd37d28718f6333d660a9ac6d6b43cdcea8f04/layabout-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "6d3f334726b6fd0e0bf9083e484ae13d", "sha256": "02d4633ab9fab4265b3a4956c8777b247f4b6ca43bd4110d44d8364bb917900a" }, "downloads": -1, "filename": "layabout-1.0.1-py3-none-any.whl", "has_sig": true, "md5_digest": "6d3f334726b6fd0e0bf9083e484ae13d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 7677, "upload_time": "2018-10-15T03:36:17", "url": "https://files.pythonhosted.org/packages/2a/87/57a92026c6b30012bcbc7ad56a1cc89f1ebb8f51f35ec680719c76cb9d9b/layabout-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0bb374be5b578c5c0c63986d4d35afff", "sha256": "eeab0ce909f6c2c5801ff9a4dba29f47a76edaa5036eb238f5c77b6f7bfd694e" }, "downloads": -1, "filename": "layabout-1.0.1.tar.gz", "has_sig": true, "md5_digest": "0bb374be5b578c5c0c63986d4d35afff", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 7378, "upload_time": "2018-10-15T03:36:19", "url": "https://files.pythonhosted.org/packages/68/4a/adc840846463b7179579a7108b47f47dc59bc1ce6037515158d452a48ea9/layabout-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6d3f334726b6fd0e0bf9083e484ae13d", "sha256": "02d4633ab9fab4265b3a4956c8777b247f4b6ca43bd4110d44d8364bb917900a" }, "downloads": -1, "filename": "layabout-1.0.1-py3-none-any.whl", "has_sig": true, "md5_digest": "6d3f334726b6fd0e0bf9083e484ae13d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 7677, "upload_time": "2018-10-15T03:36:17", "url": "https://files.pythonhosted.org/packages/2a/87/57a92026c6b30012bcbc7ad56a1cc89f1ebb8f51f35ec680719c76cb9d9b/layabout-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0bb374be5b578c5c0c63986d4d35afff", "sha256": "eeab0ce909f6c2c5801ff9a4dba29f47a76edaa5036eb238f5c77b6f7bfd694e" }, "downloads": -1, "filename": "layabout-1.0.1.tar.gz", "has_sig": true, "md5_digest": "0bb374be5b578c5c0c63986d4d35afff", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 7378, "upload_time": "2018-10-15T03:36:19", "url": "https://files.pythonhosted.org/packages/68/4a/adc840846463b7179579a7108b47f47dc59bc1ce6037515158d452a48ea9/layabout-1.0.1.tar.gz" } ] }