release 2015.01.07
[ytdl] / README.md
1 youtube-dl - download videos from youtube.com or other video platforms
2
3 - [INSTALLATION](#installation)
4 - [DESCRIPTION](#description)
5 - [OPTIONS](#options)
6 - [CONFIGURATION](#configuration)
7 - [OUTPUT TEMPLATE](#output-template)
8 - [VIDEO SELECTION](#video-selection)
9 - [FAQ](#faq)
10 - [DEVELOPER INSTRUCTIONS](#developer-instructions)
11 - [BUGS](#bugs)
12 - [COPYRIGHT](#copyright)
13
14 # INSTALLATION
15
16 To install it right away for all UNIX users (Linux, OS X, etc.), type:
17
18     sudo curl https://yt-dl.org/latest/youtube-dl -o /usr/local/bin/youtube-dl
19     sudo chmod a+x /usr/local/bin/youtube-dl
20
21 If you do not have curl, you can alternatively use a recent wget:
22
23     sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
24     sudo chmod a+x /usr/local/bin/youtube-dl
25
26 Windows users can [download a .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in their home directory or any other location on their [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29).
27
28 OS X users can install **youtube-dl** with [Homebrew](http://brew.sh/).
29
30     brew install youtube-dl
31
32 You can also use pip:
33
34     sudo pip install youtube-dl
35
36 Alternatively, refer to the developer instructions below for how to check out and work with the git repository. For further options, including PGP signatures, see https://rg3.github.io/youtube-dl/download.html .
37
38 # DESCRIPTION
39 **youtube-dl** is a small command-line program to download videos from
40 YouTube.com and a few more sites. It requires the Python interpreter, version
41 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on
42 your Unix box, on Windows or on Mac OS X. It is released to the public domain,
43 which means you can modify it, redistribute it or use it however you like.
44
45     youtube-dl [OPTIONS] URL [URL...]
46
47 # OPTIONS
48     -h, --help                       print this help text and exit
49     --version                        print program version and exit
50     -U, --update                     update this program to latest version. Make
51                                      sure that you have sufficient permissions
52                                      (run with sudo if needed)
53     -i, --ignore-errors              continue on download errors, for example to
54                                      skip unavailable videos in a playlist
55     --abort-on-error                 Abort downloading of further videos (in the
56                                      playlist or the command line) if an error
57                                      occurs
58     --dump-user-agent                display the current browser identification
59     --list-extractors                List all supported extractors and the URLs
60                                      they would handle
61     --extractor-descriptions         Output descriptions of all supported
62                                      extractors
63     --proxy URL                      Use the specified HTTP/HTTPS proxy. Pass in
64                                      an empty string (--proxy "") for direct
65                                      connection
66     --socket-timeout None            Time to wait before giving up, in seconds
67     --default-search PREFIX          Use this prefix for unqualified URLs. For
68                                      example "gvsearch2:" downloads two videos
69                                      from google videos for  youtube-dl "large
70                                      apple". Use the value "auto" to let
71                                      youtube-dl guess ("auto_warning" to emit a
72                                      warning when guessing). "error" just throws
73                                      an error. The default value "fixup_error"
74                                      repairs broken URLs, but emits an error if
75                                      this is not possible instead of searching.
76     --ignore-config                  Do not read configuration files. When given
77                                      in the global configuration file /etc
78                                      /youtube-dl.conf: Do not read the user
79                                      configuration in ~/.config/youtube-
80                                      dl/config (%APPDATA%/youtube-dl/config.txt
81                                      on Windows)
82     --flat-playlist                  Do not extract the videos of a playlist,
83                                      only list them.
84
85 ## Video Selection:
86     --playlist-start NUMBER          playlist video to start at (default is 1)
87     --playlist-end NUMBER            playlist video to end at (default is last)
88     --match-title REGEX              download only matching titles (regex or
89                                      caseless sub-string)
90     --reject-title REGEX             skip download for matching titles (regex or
91                                      caseless sub-string)
92     --max-downloads NUMBER           Abort after downloading NUMBER files
93     --min-filesize SIZE              Do not download any videos smaller than
94                                      SIZE (e.g. 50k or 44.6m)
95     --max-filesize SIZE              Do not download any videos larger than SIZE
96                                      (e.g. 50k or 44.6m)
97     --date DATE                      download only videos uploaded in this date
98     --datebefore DATE                download only videos uploaded on or before
99                                      this date (i.e. inclusive)
100     --dateafter DATE                 download only videos uploaded on or after
101                                      this date (i.e. inclusive)
102     --min-views COUNT                Do not download any videos with less than
103                                      COUNT views
104     --max-views COUNT                Do not download any videos with more than
105                                      COUNT views
106     --no-playlist                    If the URL refers to a video and a
107                                      playlist, download only the video.
108     --age-limit YEARS                download only videos suitable for the given
109                                      age
110     --download-archive FILE          Download only videos not listed in the
111                                      archive file. Record the IDs of all
112                                      downloaded videos in it.
113     --include-ads                    Download advertisements as well
114                                      (experimental)
115
116 ## Download Options:
117     -r, --rate-limit LIMIT           maximum download rate in bytes per second
118                                      (e.g. 50K or 4.2M)
119     -R, --retries RETRIES            number of retries (default is 10)
120     --buffer-size SIZE               size of download buffer (e.g. 1024 or 16K)
121                                      (default is 1024)
122     --no-resize-buffer               do not automatically adjust the buffer
123                                      size. By default, the buffer size is
124                                      automatically resized from an initial value
125                                      of SIZE.
126     --playlist-reverse               Download playlist videos in reverse order
127
128 ## Filesystem Options:
129     -a, --batch-file FILE            file containing URLs to download ('-' for
130                                      stdin)
131     --id                             use only video ID in file name
132     -o, --output TEMPLATE            output filename template. Use %(title)s to
133                                      get the title, %(uploader)s for the
134                                      uploader name, %(uploader_id)s for the
135                                      uploader nickname if different,
136                                      %(autonumber)s to get an automatically
137                                      incremented number, %(ext)s for the
138                                      filename extension, %(format)s for the
139                                      format description (like "22 - 1280x720" or
140                                      "HD"), %(format_id)s for the unique id of
141                                      the format (like Youtube's itags: "137"),
142                                      %(upload_date)s for the upload date
143                                      (YYYYMMDD), %(extractor)s for the provider
144                                      (youtube, metacafe, etc), %(id)s for the
145                                      video id, %(playlist_title)s,
146                                      %(playlist_id)s, or %(playlist)s (=title if
147                                      present, ID otherwise) for the playlist the
148                                      video is in, %(playlist_index)s for the
149                                      position in the playlist. %(height)s and
150                                      %(width)s for the width and height of the
151                                      video format. %(resolution)s for a textual
152                                      description of the resolution of the video
153                                      format. %% for a literal percent. Use - to
154                                      output to stdout. Can also be used to
155                                      download to a different directory, for
156                                      example with -o '/my/downloads/%(uploader)s
157                                      /%(title)s-%(id)s.%(ext)s' .
158     --autonumber-size NUMBER         Specifies the number of digits in
159                                      %(autonumber)s when it is present in output
160                                      filename template or --auto-number option
161                                      is given
162     --restrict-filenames             Restrict filenames to only ASCII
163                                      characters, and avoid "&" and spaces in
164                                      filenames
165     -A, --auto-number                [deprecated; use  -o
166                                      "%(autonumber)s-%(title)s.%(ext)s" ] number
167                                      downloaded files starting from 00000
168     -t, --title                      [deprecated] use title in file name
169                                      (default)
170     -l, --literal                    [deprecated] alias of --title
171     -w, --no-overwrites              do not overwrite files
172     -c, --continue                   force resume of partially downloaded files.
173                                      By default, youtube-dl will resume
174                                      downloads if possible.
175     --no-continue                    do not resume partially downloaded files
176                                      (restart from beginning)
177     --no-part                        do not use .part files - write directly
178                                      into output file
179     --no-mtime                       do not use the Last-modified header to set
180                                      the file modification time
181     --write-description              write video description to a .description
182                                      file
183     --write-info-json                write video metadata to a .info.json file
184     --write-annotations              write video annotations to a .annotation
185                                      file
186     --write-thumbnail                write thumbnail image to disk
187     --load-info FILE                 json file containing the video information
188                                      (created with the "--write-json" option)
189     --cookies FILE                   file to read cookies from and dump cookie
190                                      jar in
191     --cache-dir DIR                  Location in the filesystem where youtube-dl
192                                      can store some downloaded information
193                                      permanently. By default $XDG_CACHE_HOME
194                                      /youtube-dl or ~/.cache/youtube-dl . At the
195                                      moment, only YouTube player files (for
196                                      videos with obfuscated signatures) are
197                                      cached, but that may change.
198     --no-cache-dir                   Disable filesystem caching
199     --rm-cache-dir                   Delete all filesystem cache files
200
201 ## Verbosity / Simulation Options:
202     -q, --quiet                      activates quiet mode
203     --no-warnings                    Ignore warnings
204     -s, --simulate                   do not download the video and do not write
205                                      anything to disk
206     --skip-download                  do not download the video
207     -g, --get-url                    simulate, quiet but print URL
208     -e, --get-title                  simulate, quiet but print title
209     --get-id                         simulate, quiet but print id
210     --get-thumbnail                  simulate, quiet but print thumbnail URL
211     --get-description                simulate, quiet but print video description
212     --get-duration                   simulate, quiet but print video length
213     --get-filename                   simulate, quiet but print output filename
214     --get-format                     simulate, quiet but print output format
215     -j, --dump-json                  simulate, quiet but print JSON information.
216                                      See --output for a description of available
217                                      keys.
218     -J, --dump-single-json           simulate, quiet but print JSON information
219                                      for each command-line argument. If the URL
220                                      refers to a playlist, dump the whole
221                                      playlist information in a single line.
222     --newline                        output progress bar as new lines
223     --no-progress                    do not print progress bar
224     --console-title                  display progress in console titlebar
225     -v, --verbose                    print various debugging information
226     --dump-intermediate-pages        print downloaded pages to debug problems
227                                      (very verbose)
228     --write-pages                    Write downloaded intermediary pages to
229                                      files in the current directory to debug
230                                      problems
231     --print-traffic                  Display sent and read HTTP traffic
232
233 ## Workarounds:
234     --encoding ENCODING              Force the specified encoding (experimental)
235     --no-check-certificate           Suppress HTTPS certificate validation.
236     --prefer-insecure                Use an unencrypted connection to retrieve
237                                      information about the video. (Currently
238                                      supported only for YouTube)
239     --user-agent UA                  specify a custom user agent
240     --referer URL                    specify a custom referer, use if the video
241                                      access is restricted to one domain
242     --add-header FIELD:VALUE         specify a custom HTTP header and its value,
243                                      separated by a colon ':'. You can use this
244                                      option multiple times
245     --bidi-workaround                Work around terminals that lack
246                                      bidirectional text support. Requires bidiv
247                                      or fribidi executable in PATH
248
249 ## Video Format Options:
250     -f, --format FORMAT              video format code, specify the order of
251                                      preference using slashes: -f 22/17/18 .  -f
252                                      mp4 , -f m4a and  -f flv  are also
253                                      supported. You can also use the special
254                                      names "best", "bestvideo", "bestaudio",
255                                      "worst", "worstvideo" and "worstaudio". By
256                                      default, youtube-dl will pick the best
257                                      quality. Use commas to download multiple
258                                      audio formats, such as -f
259                                      136/137/mp4/bestvideo,140/m4a/bestaudio.
260                                      You can merge the video and audio of two
261                                      formats into a single file using -f <video-
262                                      format>+<audio-format> (requires ffmpeg or
263                                      avconv), for example -f
264                                      bestvideo+bestaudio.
265     --all-formats                    download all available video formats
266     --prefer-free-formats            prefer free video formats unless a specific
267                                      one is requested
268     --max-quality FORMAT             highest quality format to download
269     -F, --list-formats               list all available formats
270     --youtube-skip-dash-manifest     Do not download the DASH manifest on
271                                      YouTube videos
272
273 ## Subtitle Options:
274     --write-sub                      write subtitle file
275     --write-auto-sub                 write automatic subtitle file (youtube
276                                      only)
277     --all-subs                       downloads all the available subtitles of
278                                      the video
279     --list-subs                      lists all available subtitles for the video
280     --sub-format FORMAT              subtitle format (default=srt) ([sbv/vtt]
281                                      youtube only)
282     --sub-lang LANGS                 languages of the subtitles to download
283                                      (optional) separated by commas, use IETF
284                                      language tags like 'en,pt'
285
286 ## Authentication Options:
287     -u, --username USERNAME          login with this account ID
288     -p, --password PASSWORD          account password
289     -2, --twofactor TWOFACTOR        two-factor auth code
290     -n, --netrc                      use .netrc authentication data
291     --video-password PASSWORD        video password (vimeo, smotri)
292
293 ## Post-processing Options:
294     -x, --extract-audio              convert video files to audio-only files
295                                      (requires ffmpeg or avconv and ffprobe or
296                                      avprobe)
297     --audio-format FORMAT            "best", "aac", "vorbis", "mp3", "m4a",
298                                      "opus", or "wav"; "best" by default
299     --audio-quality QUALITY          ffmpeg/avconv audio quality specification,
300                                      insert a value between 0 (better) and 9
301                                      (worse) for VBR or a specific bitrate like
302                                      128K (default 5)
303     --recode-video FORMAT            Encode the video to another format if
304                                      necessary (currently supported:
305                                      mp4|flv|ogg|webm|mkv)
306     -k, --keep-video                 keeps the video file on disk after the
307                                      post-processing; the video is erased by
308                                      default
309     --no-post-overwrites             do not overwrite post-processed files; the
310                                      post-processed files are overwritten by
311                                      default
312     --embed-subs                     embed subtitles in the video (only for mp4
313                                      videos)
314     --embed-thumbnail                embed thumbnail in the audio as cover art
315     --add-metadata                   write metadata to the video file
316     --xattrs                         write metadata to the video file's xattrs
317                                      (using dublin core and xdg standards)
318     --prefer-avconv                  Prefer avconv over ffmpeg for running the
319                                      postprocessors (default)
320     --prefer-ffmpeg                  Prefer ffmpeg over avconv for running the
321                                      postprocessors
322     --exec CMD                       Execute a command on the file after
323                                      downloading, similar to find's -exec
324                                      syntax. Example: --exec 'adb push {}
325                                      /sdcard/Music/ && rm {}'
326
327 # CONFIGURATION
328
329 You can configure youtube-dl by placing default arguments (such as `--extract-audio --no-mtime` to always extract the audio and not copy the mtime) into `/etc/youtube-dl.conf` and/or `~/.config/youtube-dl/config`. On Windows, the configuration file locations are `%APPDATA%\youtube-dl\config.txt` and `C:\Users\<Yourname>\youtube-dl.conf`.
330
331 # OUTPUT TEMPLATE
332
333 The `-o` option allows users to indicate a template for the output file names. The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "http://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format `%(NAME)s`. To clarify, that is a percent symbol followed by a name in parenthesis, followed by a lowercase S. Allowed names are:
334
335  - `id`: The sequence will be replaced by the video identifier.
336  - `url`: The sequence will be replaced by the video URL.
337  - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
338  - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
339  - `title`: The sequence will be replaced by the video title.
340  - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
341  - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
342  - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
343  - `playlist`: The name or the id of the playlist that contains the video.
344  - `playlist_index`: The index of the video in the playlist, a five-digit number.
345
346 The current default template is `%(title)s-%(id)s.%(ext)s`.
347
348 In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title:
349
350 ```bash
351 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
352 youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
353 $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
354 youtube-dl_test_video_.mp4          # A simple file name
355 ```
356
357 # VIDEO SELECTION
358
359 Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
360
361  - Absolute dates: Dates in the format `YYYYMMDD`.
362  - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
363  
364 Examples:
365
366 ```bash
367 # Download only the videos uploaded in the last 6 months
368 $ youtube-dl --dateafter now-6months
369
370 # Download only the videos uploaded on January 1, 1970
371 $ youtube-dl --date 19700101
372
373 $ # will only download the videos uploaded in the 200x decade
374 $ youtube-dl --dateafter 20000101 --datebefore 20091231
375 ```
376
377 # FAQ
378
379 ### How do I update youtube-dl?
380
381 If you've followed [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html), you can simply run `youtube-dl -U` (or, on Linux, `sudo youtube-dl -U`).
382
383 If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
384
385 If you have installed youtube-dl using a package manager like *apt-get* or *yum*, use the standard system update mechanism to update. Note that distribution packages are often outdated. As a rule of thumb, youtube-dl releases at least once a month, and often weekly or even daily. Simply go to http://yt-dl.org/ to find out the current version. Unfortunately, there is nothing we youtube-dl developers can do if your distributions serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum.
386
387 As a last resort, you can also uninstall the version installed by your package manager and follow our manual installation instructions. For that, remove the distribution's package, with a line like
388
389     sudo apt-get remove -y youtube-dl
390
391 Afterwards, simply follow [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html):
392
393 ```
394 sudo wget https://yt-dl.org/latest/youtube-dl -O /usr/local/bin/youtube-dl
395 sudo chmod a+x /usr/local/bin/youtube-dl
396 hash -r
397 ```
398
399 Again, from then on you'll be able to update with `sudo youtube-dl -U`.
400
401 ### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
402
403 YouTube changed their playlist format in March 2014 and later on, so you'll need at least youtube-dl 2014.07.25 to download all YouTube videos.
404
405 If you have installed youtube-dl with a package manager, pip, setup.py or a tarball, please use that to update. Note that Ubuntu packages do not seem to get updated anymore. Since we are not affiliated with Ubuntu, there is little we can do. Feel free to [report bugs](https://bugs.launchpad.net/ubuntu/+source/youtube-dl/+filebug) to the [Ubuntu packaging guys](mailto:ubuntu-motu@lists.ubuntu.com?subject=outdated%20version%20of%20youtube-dl) - all they have to do is update the package to a somewhat recent version. See above for a way to update.
406
407 ### Do I always have to pass in `--max-quality FORMAT`, or `-citw`?
408
409 By default, youtube-dl intends to have the best options (incidentally, if you have a convincing case that these should be different, [please file an issue where you explain that](https://yt-dl.org/bug)). Therefore, it is unnecessary and sometimes harmful to copy long option strings from webpages. In particular, `--max-quality` *limits* the video quality (so if you want the best quality, do NOT pass it in), and the only option out of `-citw` that is regularly useful is `-i`.
410
411 ### Can you please put the -b option back?
412
413 Most people asking this question are not aware that youtube-dl now defaults to downloading the highest available quality as reported by YouTube, which will be 1080p or 720p in some cases, so you no longer need the `-b` option. For some specific videos, maybe YouTube does not report them to be available in a specific high quality format you're interested in. In that case, simply request it with the `-f` option and youtube-dl will try to download it.
414
415 ### I get HTTP error 402 when trying to download a video. What's this?
416
417 Apparently YouTube requires you to pass a CAPTCHA test if you download too much. We're [considering to provide a way to let you solve the CAPTCHA](https://github.com/rg3/youtube-dl/issues/154), but at the moment, your best course of action is pointing a webbrowser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
418
419 ### I have downloaded a video but how can I play it?
420
421 Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
422
423 ### The links provided by youtube-dl -g are not working anymore
424
425 The URLs youtube-dl outputs require the downloader to have the correct cookies. Use the `--cookies` option to write the required cookies into a file, and advise your downloader to read cookies from that file. Some sites also require a common user agent to be used, use `--dump-user-agent` to see the one in use by youtube-dl.
426
427 ### ERROR: no fmt_url_map or conn information found in video info
428
429 youtube has switched to a new video info format in July 2011 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
430
431 ### ERROR: unable to download video ###
432
433 youtube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`.
434
435 ### SyntaxError: Non-ASCII character ###
436
437 The error
438
439     File "youtube-dl", line 2
440     SyntaxError: Non-ASCII character '\x93' ...
441
442 means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
443
444 ### What is this binary file? Where has the code gone?
445
446 Since June 2012 (#342) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
447
448 ### The exe throws a *Runtime error from Visual C++*
449
450 To run the exe you need to install first the [Microsoft Visual C++ 2008 Redistributable Package](http://www.microsoft.com/en-us/download/details.aspx?id=29).
451
452 ### How can I detect whether a given URL is supported by youtube-dl?
453
454 For one, have a look at the [list of supported sites](docs/supportedsites). Note that it can sometimes happen that the site changes its URL scheme (say, from http://example.com/v/1234567 to http://example.com/v/1234567 ) and youtube-dl reports an URL of a service in that list as unsupported. In that case, simply report a bug.
455
456 It is *not* possible to detect whether a URL is supported or not. That's because youtube-dl contains a generic extractor which matches **all** URLs. You may be tempted to disable, exclude, or remove the generic extractor, but the generic extractor not only allows users to extract videos from lots of websites that embed a video from another service, but may also be used to extract video from a service that it's hosting itself. Therefore, we neither recommend nor support disabling, excluding, or removing the generic extractor.
457
458 If you want to find out whether a given URL is supported, simply call youtube-dl with it. If you get no videos back, chances are the URL is either not referring to a video or unsupported. You can find out which by examining the output (if you run youtube-dl on the console) or catching an `UnsupportedError` exception if you run it from a Python program.
459
460 # DEVELOPER INSTRUCTIONS
461
462 Most users do not need to build youtube-dl and can [download the builds](http://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
463
464 To run youtube-dl as a developer, you don't need to build anything either. Simply execute
465
466     python -m youtube_dl
467
468 To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
469
470     python -m unittest discover
471     python test/test_download.py
472     nosetests
473
474 If you want to create a build of youtube-dl yourself, you'll need
475
476 * python
477 * make
478 * pandoc
479 * zip
480 * nosetests
481
482 ### Adding support for a new site
483
484 If you want to add support for a new site, you can follow this quick list (assuming your service is called `yourextractor`):
485
486 1. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
487 2. Check out the source code with `git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git`
488 3. Start a new git branch with `cd youtube-dl; git checkout -b yourextractor`
489 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
490     ```python
491     # coding: utf-8
492     from __future__ import unicode_literals
493
494     from .common import InfoExtractor
495
496
497     class YourExtractorIE(InfoExtractor):
498         _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
499         _TEST = {
500             'url': 'http://yourextractor.com/watch/42',
501             'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
502             'info_dict': {
503                 'id': '42',
504                 'ext': 'mp4',
505                 'title': 'Video title goes here',
506                 'thumbnail': 're:^https?://.*\.jpg$',
507                 # TODO more properties, either as:
508                 # * A value
509                 # * MD5 checksum; start the string with md5:
510                 # * A regular expression; start the string with re:
511                 # * Any Python type (for example int or float)
512             }
513         }
514
515         def _real_extract(self, url):
516             video_id = self._match_id(url)
517             webpage = self._download_webpage(url, video_id)
518
519             # TODO more code goes here, for example ...
520             title = self._html_search_regex(r'<h1>(.*?)</h1>', webpage, 'title')
521
522             return {
523                 'id': video_id,
524                 'title': title,
525                 'description': self._og_search_description(webpage),
526                 # TODO more properties (see youtube_dl/extractor/common.py)
527             }
528     ```
529 5. Add an import in [`youtube_dl/extractor/__init__.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/__init__.py).
530 6. Run `python test/test_download.py TestDownload.test_YourExtractor`. This *should fail* at first, but you can continually re-run it until you're done. If you decide to add more than one test, then rename ``_TEST`` to ``_TESTS`` and make it into a list of dictionaries. The tests will be then be named `TestDownload.test_YourExtractor`, `TestDownload.test_YourExtractor_1`, `TestDownload.test_YourExtractor_2`, etc.
531 7. Have a look at [`youtube_dl/common/extractor/common.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should return](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L38). Add tests and code for as many as you want.
532 8. If you can, check the code with [pyflakes](https://pypi.python.org/pypi/pyflakes) (a good idea) and [pep8](https://pypi.python.org/pypi/pep8) (optional, ignore E501).
533 9. When the tests pass, [add](http://git-scm.com/docs/git-add) the new files and [commit](http://git-scm.com/docs/git-commit) them and [push](http://git-scm.com/docs/git-push) the result, like this:
534
535         $ git add youtube_dl/extractor/__init__.py
536         $ git add youtube_dl/extractor/yourextractor.py
537         $ git commit -m '[yourextractor] Add new extractor'
538         $ git push origin yourextractor
539
540 10. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
541
542 In any case, thank you very much for your contributions!
543
544 # EMBEDDING YOUTUBE-DL
545
546 youtube-dl makes the best effort to be a good command-line program, and thus should be callable from any programming language. If you encounter any problems parsing its output, feel free to [create a report](https://github.com/rg3/youtube-dl/issues/new).
547
548 From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
549
550 ```python
551 import youtube_dl
552
553 ydl_opts = {}
554 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
555     ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
556 ```
557
558 Most likely, you'll want to use various options. For a list of what can be done, have a look at [youtube_dl/YoutubeDL.py](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L69). For a start, if you want to intercept youtube-dl's output, set a `logger` object.
559
560 Here's a more complete example of a program that outputs only errors (and a short message after the download is finished), and downloads/converts the video to an mp3 file:
561
562 ```python
563 import youtube_dl
564
565
566 class MyLogger(object):
567     def debug(self, msg):
568         pass
569
570     def warning(self, msg):
571         pass
572
573     def error(self, msg):
574         print(msg)
575
576
577 def my_hook(d):
578     if d['status'] == 'finished':
579         print('Done downloading, now converting ...')
580
581
582 ydl_opts = {
583     'format': 'bestaudio/best',
584     'postprocessors': [{
585         'key': 'FFmpegExtractAudio',
586         'preferredcodec': 'mp3',
587         'preferredquality': '192',
588     }],
589     'logger': MyLogger(),
590     'progress_hooks': [my_hook],
591 }
592 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
593     ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
594 ```
595
596 # BUGS
597
598 Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues> . Unless you were prompted so or there is another pertinent reason (e.g. GitHub fails to accept the bug report), please do not send bug reports via personal email. For discussions, join us in the irc channel #youtube-dl on freenode.
599
600 Please include the full output of the command when run with `--verbose`. The output (including the first lines) contain important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever.
601
602 Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
603
604 ### Is the description of the issue itself sufficient?
605
606 We often get issue reports that we cannot really decipher. While in most cases we eventually get the required information after asking back multiple times, this poses an unnecessary drain on our resources. Many contributors, including myself, are also not native speakers, so we may misread some parts.
607
608 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
609
610 - What the problem is
611 - How it could be fixed
612 - How your proposed solution would look like
613
614 If your report is shorter than two lines, it is almost certainly missing some of these, which makes it hard for us to respond to it. We're often too polite to close the issue outright, but the missing info makes misinterpretation likely. As a commiter myself, I often get frustrated by these issues, since the only possible way for me to move forward on them is to ask for clarification over and over.
615
616 For bug reports, this means that your report should contain the *complete* output of youtube-dl when called with the -v flag. The error message you get for (most) bugs even says so, but you would not believe how many of our bug reports do not contain this information.
617
618 Site support requests **must contain an example URL**. An example URL is a URL you might want to download, like http://www.youtube.com/watch?v=BaW_jenozKc . There should be an obvious video present. Except under very special circumstances, the main page of a video service (e.g. http://www.youtube.com/ ) is *not* an example URL.
619
620 ###  Are you using the latest version?
621
622 Before reporting any issue, type youtube-dl -U. This should report that you're up-to-date. About 20% of the reports we receive are already fixed, but people are using outdated versions. This goes for feature requests as well.
623
624 ###  Is the issue already documented?
625
626 Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or at https://github.com/rg3/youtube-dl/search?type=Issues . If there is an issue, feel free to write something along the lines of "This affects me as well, with version 2015.01.01. Here is some more information on the issue: ...". While some issues may be old, a new post into them often spurs rapid activity.
627
628 ###  Why are existing options not enough?
629
630 Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/rg3/youtube-dl/blob/master/README.md#synopsis). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
631
632 ###  Is there enough context in your bug report?
633
634 People want to solve problems, and often think they do us a favor by breaking down their larger problems (e.g. wanting to skip already downloaded files) to a specific request (e.g. requesting us to look whether the file exists before downloading the info page). However, what often happens is that they break down the problem into two steps: One simple, and one impossible (or extremely complicated one).
635
636 We are then presented with a very complicated request when the original problem could be solved far easier, e.g. by recording the downloaded video IDs in a separate file. To avoid this, you must include the greater context where it is non-obvious. In particular, every feature request that does not consist of adding support for a new site should contain a use case scenario that explains in what situation the missing feature would be useful.
637
638 ###  Does the issue involve one problem, and one problem only?
639
640 Some of our users seem to think there is a limit of issues they can or should open. There is no limit of issues they can or should open. While it may seem appealing to be able to dump all your issues into one ticket, that means that someone who solves one of your issues cannot mark the issue as closed. Typically, reporting a bunch of issues leads to the ticket lingering since nobody wants to attack that behemoth, until someone mercifully splits the issue into multiple ones.
641
642 In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, Whitehouse podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of youtube-dl that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
643
644 ###  Is anyone going to need the feature?
645
646 Only post features that you (or an incapicated friend you can personally talk to) require. Do not post features because they seem like a good idea. If they are really useful, they will be requested by someone who requires them.
647
648 ###  Is your question about youtube-dl?
649
650 It may sound strange, but some bug reports we receive are completely unrelated to youtube-dl and relate to a different or even the reporter's own application. Please make sure that you are actually using youtube-dl. If you are using a UI for youtube-dl, report the bug to the maintainer of the actual application providing the UI. On the other hand, if your UI for youtube-dl fails in some way you believe is related to youtube-dl, by all means, go ahead and report the bug.
651
652 # COPYRIGHT
653
654 youtube-dl is released into the public domain by the copyright holders.
655
656 This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.