{"id":18292502,"url":"https://github.com/marclop/roboslack","last_synced_at":"2025-07-16T07:36:20.307Z","repository":{"id":52706275,"uuid":"70681354","full_name":"marclop/roboslack","owner":"marclop","description":"Simple Python bot Framework using RTM Websocket API","archived":false,"fork":false,"pushed_at":"2021-04-20T16:57:08.000Z","size":14,"stargazers_count":5,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-08T12:02:41.019Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marclop.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-12T08:52:26.000Z","updated_at":"2016-10-27T15:02:26.000Z","dependencies_parsed_at":"2022-08-21T19:40:12.871Z","dependency_job_id":null,"html_url":"https://github.com/marclop/roboslack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/marclop/roboslack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marclop%2Froboslack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marclop%2Froboslack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marclop%2Froboslack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marclop%2Froboslack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marclop","download_url":"https://codeload.github.com/marclop/roboslack/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marclop%2Froboslack/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265049316,"owners_count":23703513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T14:18:20.630Z","updated_at":"2025-07-16T07:36:20.240Z","avatar_url":"https://github.com/marclop.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RoboSlack\n[![PyPI version](https://badge.fury.io/py/roboslack.svg)](https://badge.fury.io/py/roboslack)\n\nRoboSlack is a [Slack](https://slack.com/) bot python framework that allows you to create simple enough bots\n\n# Features\n\n* Regular expression matching\n* RTM integration\n* Threaded\n\n## Missing\n* Conversational\n* Tests\n\n# Installation\n*NOTE: RoboSlack requires python version 3.4+*\n\n```bash\npip install roboslack\n```\n\n# Configuration parameters\nThere's just one configuration parameter, `SLACK_API_KEY` environment variable, setting that to the appropriate\nSlack token key will allow you to connect to the RTM API for Slack, for more information on that, visit Slack's\n[documentation](https://api.slack.com/bot-users)\n\n# Usage\n\nTo create a simple bot, you could use this snippet, which will allow you to greet the bot.\n```python\nfrom roboslack import RoboSlack\n\nbot = RoboSlack()\n\n\ndef reply_to_hi(event, *args):\n    bot.say(\"hi dude\", event)\n\n\nbot.on(\n    'mention',\n    '^hi',\n    reply_to_hi\n)\nbot.on(\n    'direct_message',\n    '^hi',\n    reply_to_hi\n)\n\nbot.on_direct_message('^hello', reply_to_hi)\nbot.on_mention('^hello', reply_to_hi)\n\nbot.run()\n```\n\n## Message types\nTo listen to different types of messages you can choose from `mention` and `direct_message`.\n\n\n# Example application\n\nYou can check out an example of how to use *roboslack* framework in the [examples](examples/) folder.\n\n# Contributing\n\nTo develop the bot is as easy as having [Docker](https://docs.docker.com/#/components) and [docker-compose](https://docs.docker.com/compose/install/) installed, then typing `make`\nwill start the development environment for the bot. (Requires `SLACK_API_KEY` environment variable) set in your current terminal.\n\n# License\nMIT License\n\nCopyright (c) 2016 Marc Lopez Rubio\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarclop%2Froboslack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarclop%2Froboslack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarclop%2Froboslack/lists"}