Twitch Keywords Bot

A Twitch bot that handles commands and other features through the use of custom keywords.

Installation

Installing from pip:

pip install twitchkeywords --upgrade

By cloning the repository:

Clone this repository

git clone https://github.com/tpreischadt/Twitch-Keywords.git

Install all dependencies (it's heavily recommended that you do this inside a virtual enviroment).

pip install -r requirements.txt

Authenticating

Go to https://twitchapps.com/tmi/ and get your OAuth Password. This is linked to your logged in account, so if you're planing on using bot-like features (such as sending messages in chat), you'd probably wanna do this within a bot account.
Go to the Twitch Developer Portal and register an Application to get your Client ID like so:

Create a .env file in the project's directory which looks like this:

And replace each value with your credentials.

IMPORTANT: This is all sensitive information, do not share your OAuth Password, Client ID and/or .env file.

Basic usage

Example code:

Here's a test in chat:

Here's what the program's log will look like. Notice how when some message invokes a coroutine, it's colored blue.

Other features

Support for prefixes (bind coroutines to every message that starts with a prefix)
- See Keyword.set_prefix and Keyword.prefix_keywords
- This allows the use of commands, but in a more generic/automated way, for example, you can define hundreds of commands following a specific rule.
Support for suffixes and "contains" keywords aswell.

P.S.: For more advanced usage, you could create a class extending the Keywords class, which is a child class of TwitchIO's bot class. Nonetheless, I suggest to not completely override the event_message method (at least call the parents' method), since that's what's handling the keywords/bindings coroutines invokations.