Skip to main content

A Python library for downloading YouTube videos.

Project description

Pypi Build status Coverage

pytube is a lightweight, dependency-free Python library (and command-line utility) for downloading YouTube Videos.

A call for contributors

With pytube and python-lambda both continuing to gain momentum, I’m calling for contributors to help build out new features, review pull requests, fix bugs, and maintain overall code quality. If you’re interested, please email me at nficano[at]gmail.com.

Description

YouTube is the most popular video-sharing platform in the world and as a hacker you may encounter a situation where you want to script something to download videos. For this I present to you pytube.

pytube is a lightweight library written in Python. It has no third party dependencies and aims to be highly reliable.

pytube makes zero assumptions, meaning there is no built-in method to get say the “best” quality video, pytube simply exposes all the available formats and resolutions, giving you the developer the power to define what “best” is.

pytube also makes pipelining easy, allowing you to specify callback functions for different download events, such as on progress or on complete.

Finally pytube also includes a command-line utility, allowing you to quickly download videos right from terminal.

Installation

Download using pip via pypi.

pip install pytube

Library usage

from pytube import YouTube

# not necessary, just for demo purposes.
from pprint import pprint

yt = YouTube("http://www.youtube.com/watch?v=Ik-RsDGPI5Y")

# Once set, you can see all the codec and quality options YouTube has made
# available for the particular video by printing videos.

print(yt.get_videos())

# [<Video: MPEG-4 Visual (.3gp) - 144p>,
#  <Video: MPEG-4 Visual (.3gp) - 240p>,
#  <Video: Sorenson H.263 (.flv) - 240p>,
#  <Video: H.264 (.flv) - 360p>,
#  <Video: H.264 (.flv) - 480p>,
#  <Video: H.264 (.mp4) - 360p>,
#  <Video: H.264 (.mp4) - 720p>,
#  <Video: VP8 (.webm) - 360p>,
#  <Video: VP8 (.webm) - 480p>]

# The filename is automatically generated based on the video title.  You
# can override this by manually setting the filename.

# view the auto generated filename:
print(yt.filename)

# Pulp Fiction - Dancing Scene [HD]

# set the filename:
yt.set_filename('Dancing Scene from Pulp Fiction')

# You can also filter the criteria by filetype.
print(yt.filter('flv'))

# [<Video: Sorenson H.263 (.flv) - 240p>,
#  <Video: H.264 (.flv) - 360p>,
#  <Video: H.264 (.flv) - 480p>]

# Notice that the list is ordered by lowest resolution to highest. If you
# wanted the highest resolution available for a specific file type, you
# can simply do:
print(yt.filter('mp4')[-1])
# <Video: H.264 (.mp4) - 720p>

# You can also get all videos for a given resolution
print(yt.filter(resolution='480p'))

# [<Video: H.264 (.flv) - 480p>,
#  <Video: VP8 (.webm) - 480p>]

# To select a video by a specific resolution and filetype you can use the get
# method.

video = yt.get('mp4', '720p')

# NOTE: get() can only be used if and only if one object matches your criteria.
# for example:

print(yt.videos)

#[<Video: MPEG-4 Visual (.3gp) - 144p>,
# <Video: MPEG-4 Visual (.3gp) - 240p>,
# <Video: Sorenson H.263 (.flv) - 240p>,
# <Video: H.264 (.flv) - 360p>,
# <Video: H.264 (.flv) - 480p>,
# <Video: H.264 (.mp4) - 360p>,
# <Video: H.264 (.mp4) - 720p>,
# <Video: VP8 (.webm) - 360p>,
# <Video: VP8 (.webm) - 480p>]

# Since we have two H.264 (.mp4) available to us... now if we try to call get()
# on mp4...

video = yt.get('mp4')
# MultipleObjectsReturned: 2 videos met criteria.

# In this case, we'll need to specify both the codec (mp4) and resolution
# (either 360p or 720p).

# Okay, let's download it! (a destination directory is required)
video.download('/tmp/')

Command-line usage

You can download a video by simply passing the -e (or --extension=) switch and setting it to the desired filetype:

$ pytube -e mp4 http://www.youtube.com/watch?v=Ik-RsDGPI5Y

Same thing for specifying a resolution:

$ pytube -r 720p http://www.youtube.com/watch?v=Ik-RsDGPI5Y

When run without a resolution or extension, it shows a list of available formats to download

$ pytube http://www.youtube.com/watch?v=Ik-RsDGPI5Y
  Resolution      Extension
 ----------------------------
 0  3gp             144p
 1  3gp             240p
 2  mp4             360p
 3  mp4             720p
 4  webm            360p
 Enter choice:

You can see a list of available formats by passing the -s (or --show-available) flag

$ pytube -s http://www.youtube.com/watch?v=Ik-RsDGPI5Y

You can also specify a download file path (-p or --path=):

$ pytube -e mp4 -p ~/Downloads/ http://www.youtube.com/watch?v=Ik-RsDGPI5Y

and/or optionally choose the filename (-f or --filename=):

$ pytube -e mp4 -f "Dancing Scene from Pulp Fiction" http://www.youtube.com/watch?v=Ik-RsDGPI5Y

Development

Development of this happens on GitHub, patches including tests, documentation are very welcome, as well as bug reports and feature contributions are welcome! Also please open an issue if this tool does not function as you’d expect.

How to release updates

If this is the first time you’re releasing to pypi, you’ll need to run: pip install -r tests/dev_requirements.txt.

Once complete, execute the following commands:

$ git checkout master
$ bumpversion [major|minor|patch]
$
$ python setup.py sdist bdist_wheel upload
$
$ bumpversion --no-tag patch
$ git push origin master --tags

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytube-6.4.2.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

pytube-6.4.2-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file pytube-6.4.2.tar.gz.

File metadata

  • Download URL: pytube-6.4.2.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pytube-6.4.2.tar.gz
Algorithm Hash digest
SHA256 dd017fa8b844e391cb8f49a3970c36a3313c4095b5fe6557c740f79b44337a7f
MD5 627d5322374b3033c03dbdd1be516a7b
BLAKE2b-256 c9a79d0fefaac60f93de5f76b600430a87d8281a63b1714993db3b4e78c8b350

See more details on using hashes here.

File details

Details for the file pytube-6.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pytube-6.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cb7f20a8c7ad85753cb7ea9ec3f381c4e0338246d8a12217714b8947bf23429a
MD5 0bb38b0c154920feb7160a8e4f827757
BLAKE2b-256 7649e61a26bb9a44b01727e7b4450aa205863faeea9e9ee5e73edd89c4174915

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