Groupie

• A bot that can be used in a GroupMe chat
• Supports a variety on useful commands

Getting Started

Locally

To run the bot locally you will first need to have all the required Python modules installed and the supported version of Python installed. The required module versions can be found in the requirments.txt file and the current supported Python can be found in the runtime.txt file.

Next you will have to set your terminal application to use the correct application. To do this the FLASK_APP environment variable must be set. This is most commonly done by running the following command: $ export FLASK_APP=Groupie.py If you are on windows you may need to use set instead of export

Now, the application can be started by running the following command: $ flask run You can also use Python's -m switch with Flask i.e. python -m flask run If you are experiencing issues taking a look at the Flask Quickstart Docs might help.

TODO

• create GitHub repo
• Have the bot join a chat
• Create a test chat for bot testing
• Add bot commands
  • /quote
    • Displays a random quote from a JSON string
  • /Quote
    • Displays a random quote from a JSON string comprised of quotes from residents
  • /all
    • Causes the following message to ping all members in the group
  • /weather
    • Displays details about the weather in the specified area code
  • /wiki
    • Displays a random Wikipedia article title and a link to that article
  • More ideas?
• DEPLOY!
  • Create Procfile file
  • Create runtime.txt file
  • Create requirements.txt file
  • setup Heroku for deployment
  • Setup Heroku config vars for needed fields
  • Deploy to Heroku

Stretch Features

• Set timeouts to prevent command spamming
• Create white-list functionality for specific commands
• Move all JSON data to web host instead of being hard coded
• Add game functionality i.e. Group Trivia