A Bot that responds with custom messages when mentioned in a Groupme chat
Project description
# GroupmeChatbot [![GroupmeChatbot version](https://img.shields.io/pypi/v/GroupmeChatbot.svg)](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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file GroupmeChatbot-3.0.0.tar.gz
.
File metadata
- Download URL: GroupmeChatbot-3.0.0.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ace9de7010f488ae3cc7bf6647447cef94341d3612b59d33dd7c6c630ee8b319 |
|
MD5 | c5b74377265dde44a04f31795a3601dd |
|
BLAKE2b-256 | 37d3537cba2f6d17bb65d896e2a47f1ae7db4872e2a0b3c5f26613fd40a76150 |