Metadata-Version: 2.1
Name: VibeBot
Version: 1.0.1
Summary: Ensures all members of a Groupme chat are vibin.
Home-page: https://github.com/dgisolfi/VibeBot
Author: Daniel Nicolas Gisolfi
Author-email: Daniel.Gisolfi1@marist.edu
License: WTFPL
Project-URL: Bugs, https://github.com/dgisolfi/VibeBot/issues/
Project-URL: Documentation, https://github.com/dgisolfi/VibeBot/
Project-URL: Source Code, https://github.com/dgisolfi/VibeBot
Keywords: Package
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: certifi (==2020.6.20)
Requires-Dist: chardet (==3.0.4)
Requires-Dist: flask (==1.1.2)
Requires-Dist: markdown (==3.2.2)
Requires-Dist: requests (==2.24.0)
Requires-Dist: importlib-metadata (==1.7.0) ; python_version < "3.8"
Requires-Dist: idna (==2.10) ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"
Requires-Dist: itsdangerous (==1.1.0) ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"
Requires-Dist: markupsafe (==1.1.1) ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"
Requires-Dist: click (==7.1.2) ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3, 3.4"
Requires-Dist: jinja2 (==2.11.2) ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3, 3.4"
Requires-Dist: werkzeug (==1.0.1) ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3, 3.4"
Requires-Dist: urllib3 (==1.25.10) ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3, 3.4" and python_version < "4"
Requires-Dist: zipp (==3.1.0) ; python_version >= "3.6"

# VibeBot <a href="http://www.wtfpl.net/"><img src="http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-4.png" width="80" height="15" alt="WTFPL" /></a>  [![Package Pypi](https://img.shields.io/pypi/v/VibeBot.svg)](https://pypi.org/project/VibeBot)

Ensures all members of a Groupme chat are vibin. Warning: will remove users until the vibe is achieved.

### 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 `USER_ID` of the sender matches that of the `USER_ID` environment variable.

## Usage

Once a bot is registered with Groupme the following requirements must be specified in the form of environment variables:

* **USER_ID** - The ID of the user that should be mocked in the group chat.

  Example: `USER_ID=29384`    

* **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, `python3 -m VibeBot`

## Found a bug?

Please let us know! Submit an issue [here](https://github.com/dgisolfi/VibeBot/issues).


