Skip to main content

Filter Twitch streams that are online from follows text file.

Project description

Streamer Retriever

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

Usage

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

Check if Your Follows are Online

Output names of streams that are online.

streamretriever -c
streamretriever --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.

streamretriever -p
streamretriever --play

Show Vods and Start Playing

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

streamretriever -d
streamretriever --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.

streamretriever -pmw
streamretriever --play --web --mobile

The additional options also work with vod option.

streamretriever -dwm
streamretriever --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 streamretriever to install from PyPI
  3. Run streamretriever -v to show installed streamretriever 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/StreamRetriever/follows.csv

Windows: %USERPROFILE%\Documents\StreamRetriever\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/StreamRetriever/cli_conf.json

Windows %USERPROFILE%\Documents\StreamRetriever\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

Streamer Retriever-0.20.2.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

Streamer_Retriever-0.20.2-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file Streamer Retriever-0.20.2.tar.gz.

File metadata

  • Download URL: Streamer Retriever-0.20.2.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for Streamer Retriever-0.20.2.tar.gz
Algorithm Hash digest
SHA256 e9a2f275613eabe304ed7f284dbba32120f2c0324bb7a63bc8a2c8000fb1f897
MD5 9cbb970861764896ff960ed654ed6d51
BLAKE2b-256 ac544b3e16ce76ee6a77b73e099602c5c27a5688dfb0d9a52870f7862bf136e4

See more details on using hashes here.

File details

Details for the file Streamer_Retriever-0.20.2-py3-none-any.whl.

File metadata

  • Download URL: Streamer_Retriever-0.20.2-py3-none-any.whl
  • Upload date:
  • Size: 28.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for Streamer_Retriever-0.20.2-py3-none-any.whl
Algorithm Hash digest
SHA256 70160b2ffb87c5f92a6564a54053ea9240116a1aa0e35bf14d93b92c9afbe30c
MD5 54c6bd9207898eabaea1ac0eb130c849
BLAKE2b-256 163b54c5f664ef418594c718d3934058986ad1c22eed987b357c9899e09ed3e6

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