TwitchNotifier
A simple python application that sits in the background and notifies you when some followed channel goes online or offline.
Also, it can only check for offline/online channels once and exit using options -n/--online or -f/--offline. Furthermore, if you pass -u/--user USER(,USER) then TwitchNotifier will only check the status of USER(,USER) and exit. Atleast -c/--nick or -u/--user has to be passed. If both are then -u/--user takes precedence.
Uses the fifth version of the Kraken Twitch API.
Demo
Message configuration
It is possible to configure the message format of TwitchNotifier. Create a file called "twitchnotifier.cfg" in $XDG_CONFIG_HOME (or $HOME/.config, or /.config). Also, you could manually set the configuration file location with -g/--config. Or if you hate configuration files then you can manipulate the format via environment variables. The environment variable names are the same as the key names in the configuration file.
You can look at twitchnotifier.cfg for an example. There has to be a section called "messages" with "user_message", "list_entry", "notification_title" and "notification_content" (and with a _off suffix). Explanations of each key:
| Key | Explanation |
|---|---|
| $1 | Channel name |
| $2 | 'online' if channel is online, 'offline' if channel is offline |
| $3 | (Only if online) Game name |
| $4 | (Only if online) Number of viewers |
| $5 | (Only if online) Status or IOW text above the player |
| $6 | (Only if online) Language |
| $7 | (Only if online) Average FPS |
| $8 | (Only if online) Followers |
| $9 | (Only if online) Views |
| ${foo} | Replaced as if strftime is applied on foo |
You don't have to reload TwitchNotifier to use new configuration! Send SIGHUP to the TwitchNotifier process to make it reload the configuration. For example: killall -s HUP twitchnotifier.
Usage
| Command | Explanation |
|---|---|
| twitchnotifier -u nadeshot | Check if nadeshot is online |
| twitchnotifier -u nadeshot,Xangold | Check nadeshot and Xangold status |
| twitchnotifier -c Xangold | Watch followed channels of Xangold |
| twitchnotifier -c Xangold -n | Check for online channels followed by Xangold |
| twitchnotifier -h | Show help message |
| twitchnotifier -c Xangold -l ~/log | Listen for events on Xangold and log to '~/log' |
Dependencies
| Name | Version |
|---|---|
| python-requests | >= 2.5.1 |
| libnotify | >= 0.7.6 |
| python-gobject | >= 3.14.0 |
| python | >= 3.4.2 |
Options
| Option | Explanation |
|---|---|
| -h/--help | Print help message |
| -i/--interval | Interval between checks |
| -n/--online | Only check for online channels |
| -f/--offline | Only check for offline channels |
| -v/--verbose | Enable verbose output |
| -u/--user | Check status of user (multiple may be separated by ,) |
| -c/--nick | Watch NICK followed channels |
| -l/--logfile | Also put new events to a log file |
| -g/--config | Full path to a configuration file (overrides the defaults) |
Contributing
Please make sure your patches don't introduce any new pylint or flake8 warnings