Suite of tools targeted at monitoring, recording and exploring chat cancer on Twitch.

4 components run independently from each other and communicate through ZeroMQ sockets and WebSockets. Any single one can be restarted or down, the others will reconnect when possible.

• monitor: join Twitch chat channels
• record: update leaderboard data in Mongo
• expose: API for leaderboards and live stats
• explore: website to display leaderboards and live stats

git clone https://github.com/Benzhaomin/twitchcancer.git
cd twitchcancer
python3 -m venv venv
source venv/bin/activate
pip install -e .

Install +

pip install -e .[dev]
docker run --rm -d -p 21001:27017 --name twitchcancer_testdb mongo:4.2.1
export TWITCHCANCER_CONFIGFILE=$(pwd)/twitchcancer/config.unittest.yml
nosetests
flake8

Edit your local config file (see Configuration)

You can use the TWITCHCANCER_CONFIGFILE env variable or the -c or --config switch to pass the path of a configuration file overriding any of the default settings.

The monitor module requires a valid Twitch username, an active oauth key and an API Client ID, example:

monitor:
    chat:
        username: username      # your twitch username
        password: oauth:key     # http://twitchapps.com/tmi/
        clientid: xxxx          # https://www.twitch.tv/kraken/oauth2/clients/YOURCLIENTID

You would then run the monitor module with:

twitchcancer-monitor -c myconfig.yml

• join chat channels on Twitch
• compute cancer points for each message based on a cancer diagnosis
• store these in-memory and publish reports every minute on a ZeroMQ socket

• Python >= 3.5 (asyncio)
• AutoBahn: https://autobahn.ws/python
• PyZMQ: https://github.com/zeromq/pyzmq

See twitchcancer-monitor -h

• subscribe to the monitoring socket
• update persistent leaderboards with new data (MongoDB)

• PyMongo: https://pypi.python.org/pypi/pymongo
• PyZMQ: https://github.com/zeromq/pyzmq

See twitchcancer-record -h

Daily stats can be deleted unless you want to show browsable daily stats or timelines/graphs with daily data points.

The current front-end doesn't do any of that so a great way to clean-up the db goes like this:

use twitchcancer
db.daily_leaderboard.find({'date': { "$lt": ISODate("2016-08-01") }}).count()
db.daily_leaderboard.remove({'date': { "$lt": ISODate("2016-08-01") }})
db.runCommand ( { compact: 'daily_leaderboard' } )

• push live cancer status (every second) and leaderboards (every minute), Pub/Sub WebSocket API

See twitchcancer-expose -h

• connect to: 'ws://localhost:8080'
• subscribe: `{'subscribe': 'topic'}'
• unsubscribe: `{'unsubscribe': 'topic'}'

• PyMongo: https://pypi.python.org/pypi/pymongo
• PyZMQ: https://github.com/zeromq/pyzmq

Moved to its own repository.