Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benzhaomin/twitchcancer
Full suite of tools to monitor Twitch chat, diagnose chat cancer and build cancer leaderboards
https://github.com/benzhaomin/twitchcancer
twitch twitch-bot twitch-irc
Last synced: about 1 month ago
JSON representation
Full suite of tools to monitor Twitch chat, diagnose chat cancer and build cancer leaderboards
- Host: GitHub
- URL: https://github.com/benzhaomin/twitchcancer
- Owner: Benzhaomin
- License: gpl-3.0
- Created: 2015-08-19T14:26:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T23:20:41.000Z (over 1 year ago)
- Last Synced: 2024-10-12T05:29:47.718Z (2 months ago)
- Topics: twitch, twitch-bot, twitch-irc
- Language: Python
- Homepage: https://cancerino.info
- Size: 523 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TwitchCancer
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
## Install
```
git clone https://github.com/Benzhaomin/twitchcancer.git
cd twitchcancer
python3 -m venv venv
source venv/bin/activate
pip install -e .
```
## Dev
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)
### 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](twitchcancer/config.default.yml).
The monitor module requires a valid Twitch username, an active oauth key and an API Client ID, example:
```yaml
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`
## Monitor
### Goal
- 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
### Requirements
- Python >= 3.5 (asyncio)
- AutoBahn: https://autobahn.ws/python
- PyZMQ: https://github.com/zeromq/pyzmq
### Usage
See `twitchcancer-monitor -h`
## Record
### Goal
- subscribe to the monitoring socket
- update persistent leaderboards with new data (MongoDB)
### Requirements
- PyMongo: https://pypi.python.org/pypi/pymongo
- PyZMQ: https://github.com/zeromq/pyzmq
### Usage
See `twitchcancer-record -h`
### Maintenance
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:
```mongo
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' } )
```
## Expose
### Goal
- push live cancer status (every second) and leaderboards (every minute), Pub/Sub WebSocket API
### Usage
See `twitchcancer-expose -h`
- connect to: 'ws://localhost:8080'
- subscribe: `{'subscribe': 'topic'}'
- unsubscribe: `{'unsubscribe': 'topic'}'
### Requirements
- PyMongo: https://pypi.python.org/pypi/pymongo
- PyZMQ: https://github.com/zeromq/pyzmq
## Explore
Moved to [its own repository](https://github.com/Benzhaomin/TwitchCancerExplore).