GithubHelp home page GithubHelp logo

dgisolfi / groupmechatbot Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 64 KB

A Bot that responds with custom messages when mentioned in a Groupme chat

Home Page: https://pypi.org/project/GroupmeChatbot/

License: MIT License

Python 87.16% Dockerfile 5.65% Makefile 7.18%
flask python chatbot

groupmechatbot's Introduction

GroupmeChatbot GroupmeChatbot version

A Bot that responds with custom messages when mentioned in a Groupme chat

Author

Daniel Gisolfi - All current work - dgisolfi

Groupme Bot?

A GroupMe bot can be created here 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.

groupmechatbot's People

Contributors

dgisolfi avatar

Stargazers

 avatar

Watchers

 avatar

groupmechatbot's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.