https://github.com/dgisolfi/groupmechatbot
A Bot that responds with custom messages when mentioned in a Groupme chat
https://github.com/dgisolfi/groupmechatbot
chatbot flask python
Last synced: 3 months ago
JSON representation
A Bot that responds with custom messages when mentioned in a Groupme chat
- Host: GitHub
- URL: https://github.com/dgisolfi/groupmechatbot
- Owner: dgisolfi
- License: mit
- Created: 2017-11-20T22:33:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-30T21:11:42.000Z (about 7 years ago)
- Last Synced: 2025-06-02T05:56:39.729Z (about 1 year ago)
- Topics: chatbot, flask, python
- Language: Python
- Homepage: https://pypi.org/project/GroupmeChatbot/
- Size: 62.5 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GroupmeChatbot [](https://pypi.org/project/GroupmeChatbot)
A Bot that responds with custom messages when mentioned in a Groupme chat
### Author
**Daniel Gisolfi** - *All current work* - [dgisolfi](https://github.com/dgisolfi)
## Groupme Bot?
A GroupMe bot can be created [here](https://dev.groupme.com/bots) and using the Groupme API can send messages to its assigned group. This particular bot uses a callback URL to be notified of new messages. Once notified the message will be parsed and a response will be created if the bot was specifically mentioned by name example: `@marty how are you?`.
## Usage
Once a bot is registered with Groupme the following requirements must be specified in the form of environment variables:
* **BOT_NAME** - Is the name of the bot that members of the group chat can refer to it by.
Example: `BOT_NAME=marty`
* **BOT_ID** - The assigned bot ID by GroupMe.
Example: `BOT_ID=a6a7a7a7a7a7a7a7a77a7a7`
* **GROUP_ID** - The ID of the Groupme Chat where the bot resides
Example: `GROUP_ID=0987890987`
* **API_TOKEN** - The api token for the authorized Groupme account
Example: `API_TOKEN=983u4ritgo0v98ujkorf`
After the environment variables have been set run the Flask server, `python -m GroupmeChatbot`
## Customization/Additions
Feature Additions/Suggestions are welcome, for any particular functionality that may need to be added for a particular use case, simple parse the incoming messages looking for specified input in the `server.py` file and add methods in the bot class to perform the desired function.