Metadata-Version: 1.1
Name: ytgrep
Version: 0.4.4
Summary: CLI tool to search youtube captions
Home-page: UNKNOWN
Author: Alex Kohler
Author-email: alexjohnkohler@gmail.com
License: UNKNOWN
Description: ytgrep
        -----------------------
        
        ytgrep is a CLI tool to search youtube closed captions with a grep-like interface.
        
        
        Requirements
        =============
        
        * Requires python >= 3.5
        
        Installation
        =============
        
        .. code:: bash
            
            pip install ytgrep
        
        Purpose
        =============
        ytgrep is particularly useful whilst looking for particular topic or keywords mentioned in a video.
        
            For example, searching for the word 'topoloigcal sort' in `MIT's Open Courseware Lecture on DFS and topological sort <https://www.youtube.com/watch?v=AfSk24UTFS8>`__:
        
        .. raw:: html
            
            <a href="https://asciinema.org/a/SjG0XTmIPzDfNgx2SxwhCdXwt" target="_blank"><img src="https://asciinema.org/a/SjG0XTmIPzDfNgx2SxwhCdXwt.svg" /></a>
        
        Usage
        ==============
        
        .. code:: bash
        
            usage: ytgrep.py [-h] [-e] [-v] [-links] pattern urls [urls ...]
        
        Flags
        =============
        * -e <PATTERN> - specify a regular expression to match
        * -v - verbose, print debug information
        * -links - include the time shortcut link with each match (see example below) 
        
        
        More examples
        =============
        
        Search multiple urls
        .. code:: bash
        
            ytgrep 'bananas' https://www.youtube.com/watch?v=G0PQrCwol6g
        
        
        Development
        =============
        
        Run Tests
        ~~~~~~~~~
        
        *Note:* Functional tests do download directly from Youtube
        
        .. code:: bash
        
           ## All tests
           python -m unittest discover
        
           ## Unit tests
           python -m unittest discover test/unit
        
           ## Functional tests
           python -m unittest discover test/functional
        
        Related projects
        ==================
         * youtube-closed-captions - This project used this library as a starting point https://github.com/mkly/youtube-closed-captions
         * videogrep - get supercuts of video matching provided seach terms
            
        
        TODO
        ============
        * Supporting languages other than English
        * -e '*' breaks ytgrep - appears to be applying red more than once
        * Run coverage and see if any tests are missing
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
