Metadata-Version: 2.1
Name: StreamerRetriever
Version: 0.20.3
Summary: Filter Twitch streams that are online from follows text file.
Home-page: https://gitlab.com/obtusescholar/streamerretriever
Author: obtusescholar
License: GPLv3+
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](https://www.python.org/)
            * You should consider selecting `Add Python to PATH` during install
        
        
        ## Install
        
        1.  Install [Python 3](https://www.python.org/) from the [Requirements][1]
        2.  Run `pip install streamerretriever` to install from [PyPI][3]
        3.  Run `streamerretriever -v` to show installed streamerretriever version number
        4.  Create your streamer list [Configuration][2]
        
        
        ## 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"]}
        ```
        
        
        
        [1]: #requirements
        [2]: #configuration
        [3]: https://pypi.org/project/streamerretriever
        [4]: #usage
        [5]: #cli-play
        
Keywords: twitch terminal
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
