Simple twitch chat bot which counts words in the chat.
Bot supports the following commands:
| Command | Description |
|---|---|
| !help | Get list of all commands |
| !top_words | Get 10 top used words |
The project is written in Python 3.5 and uses irc 15.0.5 library.
To install all necessary dependencies use the following command from the root dir of the project:
pip install -r requirements.txt
To run twitch chat bot you can use the following command from the root dir:
python -m twitchchatbot -c <channel> -n <username> -k <password>
For password you should use OAuth Token. It looks like this:
oauth:<some_hash_code>
If you don't have one, please use this link to generate it for your account.
Besides, to run the bot you can put all your params to an .ini file and pass the path to the file via command line argument like this:
python -m twitchchatbot --config <path_to_ini_file>
An .ini file should looks like the following:
[connection]
channel = <channel_name>
nickname = <nickname>
password = <password>
By default twitch chat bot tries to connect to the irc.chat.twitch.tv server to 6667 port. If you want to change it please use this command line arguments:
-s <server> -p <port>
Or add the following lines to your .ini file to the connection section:
server = <server>
port = <port>
By default the bot is using logging configuration from the logger.ini file from the project root directory.
To run all unit tests use the following command from the root dit of the project:
python -m tests
##TODO
- Improve the code documentation