Skip to main content

Filter Twitch streams that are online from follows text file.

Project description

Streamer Retriever

Streamer Retriever allows you to search if a stream is online. It also allows you to start playing the stream or even its vod.

Usage

  • streamerretriever -h or --help to list all possible arguments
  • streamerretriever -v or --version to show installed streamerretriever version
  • streamerretriever -c or --check show follows that are streaming
  • streamerretriever -l or --link links of follows that are streaming
  • streamerretriever -p or --play show online streams and choose one to play
  • streamerretriever -d or --vod choose vod to play
  • streamerretriever -w or --web use default webbrowser regardless of your configurations, use with -p or -d
  • streamerretriever -m or --mobile mobile twitch links of follows that are streaming, works also with -p and -d
  • streamerretriever -t or --twitch-follows print your follows from twitch

Check if Your Follows are Online

Output names of streams that are online.

streamerretriever -c
streamerretriever --check

Show and Start Playing

Use the option -p or --play to see who is online and choose if you want to start playing a stream.

streamerretriever -p
streamerretriever --play

Show Vods and Start Playing

The -d or --vod allows you to chooce a vod from your followed streamer and start playing it.

streamerretriever -d
streamerretriever --vod

Additional Options for Playing

You can use the additional -m or --mobile to use twitch mobile link. To force use default webbrowser regardless of your configurations us -w or --web options. Or you can use bot optional playing arguments.

streamerretriever -pmw
streamerretriever --play --web --mobile

The additional options also work with vod option.

streamerretriever -dwm
streamerretriever --web --vod --mobile

Requirements

  • Python 3.8 or newer
    • In Ubuntu sudo apt install python3
    • In Windows install Python 3
      • You should consider selecting Add Python to PATH during install

Install

  1. Install Python 3 from the Requirements
  2. Run pip install streamerretriever to install from PyPI
  3. Run streamerretriever -v to show installed streamerretriever version number
  4. Create your streamer list Configuration

Configuration

Add "streamer name" into your follows csv file. Separate each streamer with a comma.

Linux: ~/.config/StreamerRetriever/follows.csv

Windows: %USERPROFILE%\Documents\StreamerRetriever\follows.csv

The "streamer name" can be found at the end of a Twitch link: https://www.twitch.tv/<streamer_name>

follows.csv

esamarathon,gamesdonequick,esl_csgo

CLI Play

Add your player of choice to CLI configuration file.

Linux: ~/.config/StreamerRetriever/cli_conf.json

Windows %USERPROFILE%\Documents\StreamerRetriever\cli_conf.json

cli.json

{"player": ["/usr/bin/firefox", "--private-window"]}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

StreamerRetriever-0.20.3.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

StreamerRetriever-0.20.3-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file StreamerRetriever-0.20.3.tar.gz.

File metadata

  • Download URL: StreamerRetriever-0.20.3.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for StreamerRetriever-0.20.3.tar.gz
Algorithm Hash digest
SHA256 421c12b622ba595aa5312daf7255dcc341af7fce1c2c960b1c35b641bdf76efa
MD5 f1a678b0c1323b1bf279a5176e6c9010
BLAKE2b-256 6b5b1668322282aefb687b4c10869538637ba5312d9b3a1475d293761020b3b5

See more details on using hashes here.

File details

Details for the file StreamerRetriever-0.20.3-py3-none-any.whl.

File metadata

  • Download URL: StreamerRetriever-0.20.3-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for StreamerRetriever-0.20.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b1f85f21e6ce1ed1731ff79e40b45107331ff843a89d081d4af436a1ec5754a5
MD5 5cb7d680f8c3ac0d9462c2b55db4c4ec
BLAKE2b-256 41366e5e4b81310646bbf83ae1b1164ec4cb4711d6ec530842ff3bb28910a11d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page