Metadata-Version: 2.1
Name: pytube3
Version: 9.5.7
Summary: Python 3 library for downloading YouTube Videos.
Home-page: https://github.com/hbmartin/pytube3
Author: Nick Ficano, Harold Martin
Author-email: nficano@gmail.com, harold.martin@gmail.com
License: MIT
Project-URL: Bug Reports, https://github.com/hbmartin/pytube3/issues
Project-URL: Read the Docs, https://pytube3.readthedocs.io/en/latest/?badge=latest
Description: 
        
        <div align="center">
          <p align="center">
        	  <a href="https://pypi.org/project/pytube3/"><img src="https://img.shields.io/pypi/v/pytube3.svg" alt="pypi"></a>
        	  <a href="https://travis-ci.com/hbmartin/pytube3/"><img src="https://travis-ci.org/hbmartin/pytube3.svg?branch=master" /></a>
        	  <a href='https://pytube3.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/pytube3/badge/?version=latest' alt='Documentation Status' /></a>
        	  <a href="https://coveralls.io/github/hbmartin/pytube3?branch=master"><img src="https://coveralls.io/repos/github/hbmartin/pytube3/badge.svg?branch=master" /></a>
        	  <a href="https://pypi.python.org/pypi/pytube3/"><img src="https://img.shields.io/pypi/pyversions/pytube3.svg" /></a>
        	  <a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a>
        	  <a href="https://twitter.com/hmartin"><img src="https://img.shields.io/badge/twitter-@hmartin-blue.svg?style=flat" /></a>
          </p>
        </div>
        
        # pytube3
        
        ## Installation
        
        Download using pip via pypi.
        
        ```bash
        $ pip install pytube3 --upgrade
        ```
        (Mac/homebrew users may need to use ``pip3``)
        
        
        ## Quick start
        ```python
         >>> from pytube import YouTube
         >>> YouTube('https://youtu.be/9bZkp7q19f0').streams.first().download()
         >>>
         >>> yt = YouTube('http://youtube.com/watch?v=9bZkp7q19f0')
         >>> yt.streams
          ... .filter(progressive=True, file_extension='mp4')
          ... .order_by('resolution')
          ... .desc()
          ... .first()
          ... .download()
        ```
        
        ## Features
        - Support for Both Progressive & DASH Streams
        - Support for downloading complete playlist
        - Easily Register ``on_download_progress`` & ``on_download_complete`` callbacks
        - Command-line Interfaced Included
        - Caption Track Support
        - Outputs Caption Tracks to .srt format (SubRip Subtitle)
        - Ability to Capture Thumbnail URL.
        - Extensively Documented Source Code
        - No Third-Party Dependencies
        
        
        ## Usage
        
        Let's begin with showing how easy it is to download a video with pytube:
        
        ```python
        >>> from pytube import YouTube
        >>> YouTube('http://youtube.com/watch?v=9bZkp7q19f0').streams.first().download()
        ```
        This example will download the highest quality progressive download stream available.
        
        Next, let's explore how we would view what video streams are available:
        
        ```python
        >>> yt = YouTube('http://youtube.com/watch?v=9bZkp7q19f0')
        >>> yt.streams.all()
         [<Stream: itag="22" mime_type="video/mp4" res="720p" fps="30fps" vcodec="avc1.64001F" acodec="mp4a.40.2">,
         <Stream: itag="43" mime_type="video/webm" res="360p" fps="30fps" vcodec="vp8.0" acodec="vorbis">,
         <Stream: itag="18" mime_type="video/mp4" res="360p" fps="30fps" vcodec="avc1.42001E" acodec="mp4a.40.2">,
         <Stream: itag="36" mime_type="video/3gpp" res="240p" fps="30fps" vcodec="mp4v.20.3" acodec="mp4a.40.2">,
         <Stream: itag="17" mime_type="video/3gpp" res="144p" fps="30fps" vcodec="mp4v.20.3" acodec="mp4a.40.2">,
         <Stream: itag="137" mime_type="video/mp4" res="1080p" fps="30fps" vcodec="avc1.640028">,
         <Stream: itag="248" mime_type="video/webm" res="1080p" fps="30fps" vcodec="vp9">,
         <Stream: itag="136" mime_type="video/mp4" res="720p" fps="30fps" vcodec="avc1.4d401f">,
         <Stream: itag="247" mime_type="video/webm" res="720p" fps="30fps" vcodec="vp9">,
         <Stream: itag="135" mime_type="video/mp4" res="480p" fps="30fps" vcodec="avc1.4d401e">,
         <Stream: itag="244" mime_type="video/webm" res="480p" fps="30fps" vcodec="vp9">,
         <Stream: itag="134" mime_type="video/mp4" res="360p" fps="30fps" vcodec="avc1.4d401e">,
         <Stream: itag="243" mime_type="video/webm" res="360p" fps="30fps" vcodec="vp9">,
         <Stream: itag="133" mime_type="video/mp4" res="240p" fps="30fps" vcodec="avc1.4d4015">,
         <Stream: itag="242" mime_type="video/webm" res="240p" fps="30fps" vcodec="vp9">,
         <Stream: itag="160" mime_type="video/mp4" res="144p" fps="30fps" vcodec="avc1.4d400c">,
         <Stream: itag="278" mime_type="video/webm" res="144p" fps="30fps" vcodec="vp9">,
         <Stream: itag="140" mime_type="audio/mp4" abr="128kbps" acodec="mp4a.40.2">,
         <Stream: itag="171" mime_type="audio/webm" abr="128kbps" acodec="vorbis">,
         <Stream: itag="249" mime_type="audio/webm" abr="50kbps" acodec="opus">,
         <Stream: itag="250" mime_type="audio/webm" abr="70kbps" acodec="opus">,
         <Stream: itag="251" mime_type="audio/webm" abr="160kbps" acodec="opus">]
        ```
        
        ### Selecting an itag
        
        You may notice that some streams listed have both a video codec and audio codec, while others have just video or just audio, this is a result of YouTube supporting a streaming technique called Dynamic Adaptive Streaming over HTTP (DASH).
        
        In the context of pytube, the implications are for the highest quality streams; you now need to download both the audio and video tracks and then post-process them with software like FFmpeg to merge them.
        
        The legacy streams that contain the audio and video in a single file (referred to as "progressive download") are still available, but only for resolutions 720p and below.
        
        To only view these progressive download streams:
        
        ```python
         >>> yt.streams.filter(progressive=True).all()
          [<Stream: itag="22" mime_type="video/mp4" res="720p" fps="30fps" vcodec="avc1.64001F" acodec="mp4a.40.2">,
          <Stream: itag="43" mime_type="video/webm" res="360p" fps="30fps" vcodec="vp8.0" acodec="vorbis">,
          <Stream: itag="18" mime_type="video/mp4" res="360p" fps="30fps" vcodec="avc1.42001E" acodec="mp4a.40.2">,
          <Stream: itag="36" mime_type="video/3gpp" res="240p" fps="30fps" vcodec="mp4v.20.3" acodec="mp4a.40.2">,
          <Stream: itag="17" mime_type="video/3gpp" res="144p" fps="30fps" vcodec="mp4v.20.3" acodec="mp4a.40.2">]
        ```
        
        Conversely, if you only want to see the DASH streams (also referred to as "adaptive") you can do:
        
        ```python
        >>> yt.streams.filter(adaptive=True).all()
         [<Stream: itag="137" mime_type="video/mp4" res="1080p" fps="30fps" vcodec="avc1.640028">,
          <Stream: itag="248" mime_type="video/webm" res="1080p" fps="30fps" vcodec="vp9">,
          <Stream: itag="136" mime_type="video/mp4" res="720p" fps="30fps" vcodec="avc1.4d401f">,
          <Stream: itag="247" mime_type="video/webm" res="720p" fps="30fps" vcodec="vp9">,
          <Stream: itag="135" mime_type="video/mp4" res="480p" fps="30fps" vcodec="avc1.4d401e">,
          <Stream: itag="244" mime_type="video/webm" res="480p" fps="30fps" vcodec="vp9">,
          <Stream: itag="134" mime_type="video/mp4" res="360p" fps="30fps" vcodec="avc1.4d401e">,
          <Stream: itag="243" mime_type="video/webm" res="360p" fps="30fps" vcodec="vp9">,
          <Stream: itag="133" mime_type="video/mp4" res="240p" fps="30fps" vcodec="avc1.4d4015">,
          <Stream: itag="242" mime_type="video/webm" res="240p" fps="30fps" vcodec="vp9">,
          <Stream: itag="160" mime_type="video/mp4" res="144p" fps="30fps" vcodec="avc1.4d400c">,
          <Stream: itag="278" mime_type="video/webm" res="144p" fps="30fps" vcodec="vp9">,
          <Stream: itag="140" mime_type="audio/mp4" abr="128kbps" acodec="mp4a.40.2">,
          <Stream: itag="171" mime_type="audio/webm" abr="128kbps" acodec="vorbis">,
          <Stream: itag="249" mime_type="audio/webm" abr="50kbps" acodec="opus">,
          <Stream: itag="250" mime_type="audio/webm" abr="70kbps" acodec="opus">,
          <Stream: itag="251" mime_type="audio/webm" abr="160kbps" acodec="opus">]
        ```
        
        You can also download a complete Youtube playlist:
        
        ```python
        >>> from pytube import Playlist
        >>> pl = Playlist("https://www.youtube.com/watch?v=Edpy1szoG80&list=PL153hDY-y1E00uQtCVCVC8xJ25TYX8yPU")
        >>> pl.download_all()
        >>> # or if you want to download in a specific directory
        >>> pl.download_all('/path/to/directory/')
        ```
        This will download the highest progressive stream available (generally 720p) from the given playlist. Later more options would be given for user's flexibility
        to choose video resolution.
        
        ### Filtering
        
        Pytube allows you to filter on every property available (see the documentation for the complete list), let's take a look at some of the most useful ones.
        
        To list the audio only streams:
        
        ```python
        >>> yt.streams.filter(only_audio=True).all()
          [<Stream: itag="140" mime_type="audio/mp4" abr="128kbps" acodec="mp4a.40.2">,
          <Stream: itag="171" mime_type="audio/webm" abr="128kbps" acodec="vorbis">,
          <Stream: itag="249" mime_type="audio/webm" abr="50kbps" acodec="opus">,
          <Stream: itag="250" mime_type="audio/webm" abr="70kbps" acodec="opus">,
          <Stream: itag="251" mime_type="audio/webm" abr="160kbps" acodec="opus">]
        ```
        
        To list only ``mp4`` streams:
        
        ```python
        >>> yt.streams.filter(subtype='mp4').all()
         [<Stream: itag="22" mime_type="video/mp4" res="720p" fps="30fps" vcodec="avc1.64001F" acodec="mp4a.40.2">,
          <Stream: itag="18" mime_type="video/mp4" res="360p" fps="30fps" vcodec="avc1.42001E" acodec="mp4a.40.2">,
          <Stream: itag="137" mime_type="video/mp4" res="1080p" fps="30fps" vcodec="avc1.640028">,
          <Stream: itag="136" mime_type="video/mp4" res="720p" fps="30fps" vcodec="avc1.4d401f">,
          <Stream: itag="135" mime_type="video/mp4" res="480p" fps="30fps" vcodec="avc1.4d401e">,
          <Stream: itag="134" mime_type="video/mp4" res="360p" fps="30fps" vcodec="avc1.4d401e">,
          <Stream: itag="133" mime_type="video/mp4" res="240p" fps="30fps" vcodec="avc1.4d4015">,
          <Stream: itag="160" mime_type="video/mp4" res="144p" fps="30fps" vcodec="avc1.4d400c">,
          <Stream: itag="140" mime_type="audio/mp4" abr="128kbps" acodec="mp4a.40.2">]
        ```
        
        Multiple filters can also be specified:
        
        ```python
        >>> yt.streams.filter(subtype='mp4', progressive=True).all()
        >>> # this can also be expressed as:
        >>> yt.streams.filter(subtype='mp4').filter(progressive=True).all()
          [<Stream: itag="22" mime_type="video/mp4" res="720p" fps="30fps" vcodec="avc1.64001F" acodec="mp4a.40.2">,
          <Stream: itag="18" mime_type="video/mp4" res="360p" fps="30fps" vcodec="avc1.42001E" acodec="mp4a.40.2">]
        ```
        You also have an interface to select streams by their itag, without needing to filter:
        
        ```python
        >>> yt.streams.get_by_itag(22)
          <Stream: itag="22" mime_type="video/mp4" res="720p" fps="30fps" vcodec="avc1.64001F" acodec="mp4a.40.2">
        ```
        
        If you need to optimize for a specific feature, such as the "highest resolution" or "lowest average bitrate":
        
        ```python
        >>> yt.streams.filter(progressive=True).order_by('resolution').desc().all()
        ```
        Note: Using ``order_by`` on a given attribute will filter out all streams missing that attribute.
        
        ### Callbacks
        
        If your application requires post-processing logic, pytube allows you to specify an "on download complete" callback function:
        
        ```python
         >>> def convert_to_aac(stream, file_handler):
                 return  # do work
        
         >>> yt.register_on_complete_callback(convert_to_aac)
        ```
        
        Similarly, if your application requires on-download progress logic, pytube exposes a callback for this as well:
        
        ```python
         >>> def show_progress_bar(stream, chunk, file_handler, bytes_remaining):
                 return  # do work
        
         >>> yt.register_on_progress_callback(show_progress_bar)
        ```
        
        ## Command-line interface
        
        pytube also ships with a tiny cli interface for downloading and probing videos.
        
        Let's start with downloading:
        
        ```bash
        $ pytube3 http://youtube.com/watch?v=9bZkp7q19f0 --itag=22
        ```
        To view available streams:
        
        ```bash
        $ pytube3 http://youtube.com/watch?v=9bZkp7q19f0 --list
        ```
        
        Finally, if you're filing a bug report, the cli contains a switch called ``--build-playback-report``, which bundles up the state, allowing others to easily replay your issue.
        
        ## Development
        
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        
        To run code checking before a PR use ``make test``
        
        #### Virtual environment
        
        Virtual environment is setup with [pipenv](https://pipenv-fork.readthedocs.io/en/latest/) and can be automatically activated with [direnv](https://direnv.net/docs/installation.html)
        
        #### Code Formatting
        
        This project is linted with [pyflakes](https://github.com/PyCQA/pyflakes), formatted with [black](https://github.com/ambv/black), and typed with [mypy](https://mypy.readthedocs.io/en/latest/introduction.html)
        
        #### Testing
        
        This project is tested with [pytest](https://docs.pytest.org/en/latest/) and coverage is evaluated with [coveralls](https://coveralls-python.readthedocs.io/en/latest/index.html).
        
        #### Code of Conduct
        
        Treat other people with helpfulness, gratitude, and consideration! See the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
        
        #### See also
        * [youtube-python](https://github.com/rohitkhatri/youtube-python) - client for the YouTube data API
        * [youtube-dl](https://github.com/ytdl-org/youtube-dl) - command line downloader with sophisticated options
        * [youtube-dl-gui](https://github.com/MrS0m30n3/youtube-dl-gui) - wxPython GUI frontend for youtube-dl
        * [youtube-dl-server](https://github.com/manbearwiz/youtube-dl-server) - web frontend for youtube-dl
Keywords: youtube,download,video,stream
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Requires-Python: >=3.5
Description-Content-Type: text/markdown
