README.md 2.1 KB

Twiins - Minimal Twitch information gatherer

Usage

command description flags
check-live Checks if CHANNEL is livestreaming. SHOULDPRINT determines if result is returned to stdout or function caller. --print
choose Gets top 30 Twitch categories, requests user to choose one and then gets current live channels. PRETTY determines if output is pretty printed or not. --pretty
get-categories Gets top 30 Twitch categories. SHOULDPRINT determines if result is returned to stdout or to function caller. PRETTY determines if output is pretty printed or not. --print, --pretty
get-channels Gets live channels in TARGET, it can be a channel link, or just channel name. SHOULDPRINT determines if result is returned to stdout or function caller. PRETTY determines if output is pretty printed or not. --print, --pretty

Type twiins --help for general help or twiins <COMMAND> --help for help with a specific command.

Prerequisites

  • Python with version equal or superior to 3.6
  • Geckodriver
  • GNU Make

Installation

  1. git clone https://notabug.org/ropemann/twiins.git
  2. cd twiins
  3. make venv
  4. . venv/bin/activate
  5. sudo make install
  6. deactivate

At the end, you can optionally run make clean. Refer to Makefile for full details on the aforementioned commands.

Uninstallation

Just run sudo make uninstall

License

This software is licensed under GNU GPL.