Metadata-Version: 2.1
Name: yt-helper
Version: 0.2.10
Summary: Light wrapper to youtube-dl with a simplified CLI for downloading media
Home-page: https://github.com/kenjyco/yt-helper
Author: Ken
Author-email: kenjyco@gmail.com
License: MIT
Download-URL: https://github.com/kenjyco/yt-helper/tarball/v0.2.10
Keywords: youtube-dl,youtube,ffmpeg,sox,rtmpdump,video,audio,cli,command-line,download,helper,kenjyco
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Dist: click
Requires-Dist: fs-helper
Requires-Dist: input-helper
Requires-Dist: youtube-dl
Provides-Extra: redis-helper
Requires-Dist: redis-helper ; extra == 'redis-helper'

Install
-------

Install system av tools

::

   % sudo apt-get install -y ffmpeg sox rtmpdump

   or

   % brew install ffmpeg sox rtmpdump

Install with ``pip``

::

   % pip3 install yt-helper

Usage
-----

The ``yt-download`` script is provided

::

   % venv/bin/yt-download --help
   Usage: yt-download [OPTIONS] [ARGS]...

     Wrapper to 'av_from_url'

     - args: urls or filenames containing urls

   Options:
     -o, --template TEXT       string representing generated filenames
     -h, --max-height INTEGER  maximum height of video (i.e. 1080, 720, 480,
                               240.. default 720)
     -p, --playlist            Allow downloading entire playlist
     -t, --thumbnail           Download thumbnail image of video
     -d, --description         Download description of video to a file
     -s, --subtitles           Embed subtitles in the downloaded video
     -a, --audio-only          Don't keep the video file if one was downloaded
     -m, --mp3                 Convert downloaded audio to MP3 file
     -v, --verbose             Show extra debugging output
     --help                    Show this message and exit.

Optional Installs
-----------------

Collections/models (QUERIES, URLS, FILES, COMMENTS)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In order to make use of the ``QUERIES``, ``URLS``, ``FILES``, and
``COMMENTS`` collections, you must also install the ``redis-helper``
package and have a Redis server running.

If the collections/models are available, some functions will save
relevant info to them.

   See: https://github.com/kenjyco/redis-helper#intro

If you don’t have `docker <https://docs.docker.com/get-docker>`__
installed, install Redis and start server

::

   % sudo apt-get install -y redis-server

   or

   % brew install redis
   % brew services start redis

Install with ``pip``

::

   % pip3 install redis-helper


