You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

676 lines
43 KiB

13 years ago
13 years ago
13 years ago
10 years ago
  1. youtube-dl - download videos from youtube.com or other video platforms
  2. - [INSTALLATION](#installation)
  3. - [DESCRIPTION](#description)
  4. - [OPTIONS](#options)
  5. - [CONFIGURATION](#configuration)
  6. - [OUTPUT TEMPLATE](#output-template)
  7. - [VIDEO SELECTION](#video-selection)
  8. - [FAQ](#faq)
  9. - [DEVELOPER INSTRUCTIONS](#developer-instructions)
  10. - [BUGS](#bugs)
  11. - [COPYRIGHT](#copyright)
  12. # INSTALLATION
  13. To install it right away for all UNIX users (Linux, OS X, etc.), type:
  14. sudo curl https://yt-dl.org/latest/youtube-dl -o /usr/local/bin/youtube-dl
  15. sudo chmod a+x /usr/local/bin/youtube-dl
  16. If you do not have curl, you can alternatively use a recent wget:
  17. sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
  18. sudo chmod a+x /usr/local/bin/youtube-dl
  19. 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).
  20. OS X users can install **youtube-dl** with [Homebrew](http://brew.sh/).
  21. brew install youtube-dl
  22. You can also use pip:
  23. sudo pip install youtube-dl
  24. 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 .
  25. # DESCRIPTION
  26. **youtube-dl** is a small command-line program to download videos from
  27. YouTube.com and a few more sites. It requires the Python interpreter, version
  28. 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on
  29. your Unix box, on Windows or on Mac OS X. It is released to the public domain,
  30. which means you can modify it, redistribute it or use it however you like.
  31. youtube-dl [OPTIONS] URL [URL...]
  32. # OPTIONS
  33. -h, --help print this help text and exit
  34. --version print program version and exit
  35. -U, --update update this program to latest version. Make
  36. sure that you have sufficient permissions
  37. (run with sudo if needed)
  38. -i, --ignore-errors continue on download errors, for example to
  39. skip unavailable videos in a playlist
  40. --abort-on-error Abort downloading of further videos (in the
  41. playlist or the command line) if an error
  42. occurs
  43. --dump-user-agent display the current browser identification
  44. --list-extractors List all supported extractors and the URLs
  45. they would handle
  46. --extractor-descriptions Output descriptions of all supported
  47. extractors
  48. --proxy URL Use the specified HTTP/HTTPS proxy. Pass in
  49. an empty string (--proxy "") for direct
  50. connection
  51. --socket-timeout None Time to wait before giving up, in seconds
  52. --default-search PREFIX Use this prefix for unqualified URLs. For
  53. example "gvsearch2:" downloads two videos
  54. from google videos for youtube-dl "large
  55. apple". Use the value "auto" to let
  56. youtube-dl guess ("auto_warning" to emit a
  57. warning when guessing). "error" just throws
  58. an error. The default value "fixup_error"
  59. repairs broken URLs, but emits an error if
  60. this is not possible instead of searching.
  61. --ignore-config Do not read configuration files. When given
  62. in the global configuration file /etc
  63. /youtube-dl.conf: Do not read the user
  64. configuration in ~/.config/youtube-
  65. dl/config (%APPDATA%/youtube-dl/config.txt
  66. on Windows)
  67. --flat-playlist Do not extract the videos of a playlist,
  68. only list them.
  69. ## Video Selection:
  70. --playlist-start NUMBER playlist video to start at (default is 1)
  71. --playlist-end NUMBER playlist video to end at (default is last)
  72. --match-title REGEX download only matching titles (regex or
  73. caseless sub-string)
  74. --reject-title REGEX skip download for matching titles (regex or
  75. caseless sub-string)
  76. --max-downloads NUMBER Abort after downloading NUMBER files
  77. --min-filesize SIZE Do not download any videos smaller than
  78. SIZE (e.g. 50k or 44.6m)
  79. --max-filesize SIZE Do not download any videos larger than SIZE
  80. (e.g. 50k or 44.6m)
  81. --date DATE download only videos uploaded in this date
  82. --datebefore DATE download only videos uploaded on or before
  83. this date (i.e. inclusive)
  84. --dateafter DATE download only videos uploaded on or after
  85. this date (i.e. inclusive)
  86. --min-views COUNT Do not download any videos with less than
  87. COUNT views
  88. --max-views COUNT Do not download any videos with more than
  89. COUNT views
  90. --no-playlist If the URL refers to a video and a
  91. playlist, download only the video.
  92. --age-limit YEARS download only videos suitable for the given
  93. age
  94. --download-archive FILE Download only videos not listed in the
  95. archive file. Record the IDs of all
  96. downloaded videos in it.
  97. --include-ads Download advertisements as well
  98. (experimental)
  99. ## Download Options:
  100. -r, --rate-limit LIMIT maximum download rate in bytes per second
  101. (e.g. 50K or 4.2M)
  102. -R, --retries RETRIES number of retries (default is 10)
  103. --buffer-size SIZE size of download buffer (e.g. 1024 or 16K)
  104. (default is 1024)
  105. --no-resize-buffer do not automatically adjust the buffer
  106. size. By default, the buffer size is
  107. automatically resized from an initial value
  108. of SIZE.
  109. --playlist-reverse Download playlist videos in reverse order
  110. ## Filesystem Options:
  111. -a, --batch-file FILE file containing URLs to download ('-' for
  112. stdin)
  113. --id use only video ID in file name
  114. -o, --output TEMPLATE output filename template. Use %(title)s to
  115. get the title, %(uploader)s for the
  116. uploader name, %(uploader_id)s for the
  117. uploader nickname if different,
  118. %(autonumber)s to get an automatically
  119. incremented number, %(ext)s for the
  120. filename extension, %(format)s for the
  121. format description (like "22 - 1280x720" or
  122. "HD"), %(format_id)s for the unique id of
  123. the format (like Youtube's itags: "137"),
  124. %(upload_date)s for the upload date
  125. (YYYYMMDD), %(extractor)s for the provider
  126. (youtube, metacafe, etc), %(id)s for the
  127. video id, %(playlist_title)s,
  128. %(playlist_id)s, or %(playlist)s (=title if
  129. present, ID otherwise) for the playlist the
  130. video is in, %(playlist_index)s for the
  131. position in the playlist. %(height)s and
  132. %(width)s for the width and height of the
  133. video format. %(resolution)s for a textual
  134. description of the resolution of the video
  135. format. %% for a literal percent. Use - to
  136. output to stdout. Can also be used to
  137. download to a different directory, for
  138. example with -o '/my/downloads/%(uploader)s
  139. /%(title)s-%(id)s.%(ext)s' .
  140. --autonumber-size NUMBER Specifies the number of digits in
  141. %(autonumber)s when it is present in output
  142. filename template or --auto-number option
  143. is given
  144. --restrict-filenames Restrict filenames to only ASCII
  145. characters, and avoid "&" and spaces in
  146. filenames
  147. -A, --auto-number [deprecated; use -o
  148. "%(autonumber)s-%(title)s.%(ext)s" ] number
  149. downloaded files starting from 00000
  150. -t, --title [deprecated] use title in file name
  151. (default)
  152. -l, --literal [deprecated] alias of --title
  153. -w, --no-overwrites do not overwrite files
  154. -c, --continue force resume of partially downloaded files.
  155. By default, youtube-dl will resume
  156. downloads if possible.
  157. --no-continue do not resume partially downloaded files
  158. (restart from beginning)
  159. --no-part do not use .part files - write directly
  160. into output file
  161. --no-mtime do not use the Last-modified header to set
  162. the file modification time
  163. --write-description write video description to a .description
  164. file
  165. --write-info-json write video metadata to a .info.json file
  166. --write-annotations write video annotations to a .annotation
  167. file
  168. --write-thumbnail write thumbnail image to disk
  169. --load-info FILE json file containing the video information
  170. (created with the "--write-json" option)
  171. --cookies FILE file to read cookies from and dump cookie
  172. jar in
  173. --cache-dir DIR Location in the filesystem where youtube-dl
  174. can store some downloaded information
  175. permanently. By default $XDG_CACHE_HOME
  176. /youtube-dl or ~/.cache/youtube-dl . At the
  177. moment, only YouTube player files (for
  178. videos with obfuscated signatures) are
  179. cached, but that may change.
  180. --no-cache-dir Disable filesystem caching
  181. --rm-cache-dir Delete all filesystem cache files
  182. ## Verbosity / Simulation Options:
  183. -q, --quiet activates quiet mode
  184. --no-warnings Ignore warnings
  185. -s, --simulate do not download the video and do not write
  186. anything to disk
  187. --skip-download do not download the video
  188. -g, --get-url simulate, quiet but print URL
  189. -e, --get-title simulate, quiet but print title
  190. --get-id simulate, quiet but print id
  191. --get-thumbnail simulate, quiet but print thumbnail URL
  192. --get-description simulate, quiet but print video description
  193. --get-duration simulate, quiet but print video length
  194. --get-filename simulate, quiet but print output filename
  195. --get-format simulate, quiet but print output format
  196. -j, --dump-json simulate, quiet but print JSON information.
  197. See --output for a description of available
  198. keys.
  199. -J, --dump-single-json simulate, quiet but print JSON information
  200. for each command-line argument. If the URL
  201. refers to a playlist, dump the whole
  202. playlist information in a single line.
  203. --print-json Be quiet and print the video information as
  204. JSON (video is still being downloaded).
  205. --newline output progress bar as new lines
  206. --no-progress do not print progress bar
  207. --console-title display progress in console titlebar
  208. -v, --verbose print various debugging information
  209. --dump-intermediate-pages print downloaded pages to debug problems
  210. (very verbose)
  211. --write-pages Write downloaded intermediary pages to
  212. files in the current directory to debug
  213. problems
  214. --print-traffic Display sent and read HTTP traffic
  215. ## Workarounds:
  216. --encoding ENCODING Force the specified encoding (experimental)
  217. --no-check-certificate Suppress HTTPS certificate validation.
  218. --prefer-insecure Use an unencrypted connection to retrieve
  219. information about the video. (Currently
  220. supported only for YouTube)
  221. --user-agent UA specify a custom user agent
  222. --referer URL specify a custom referer, use if the video
  223. access is restricted to one domain
  224. --add-header FIELD:VALUE specify a custom HTTP header and its value,
  225. separated by a colon ':'. You can use this
  226. option multiple times
  227. --bidi-workaround Work around terminals that lack
  228. bidirectional text support. Requires bidiv
  229. or fribidi executable in PATH
  230. ## Video Format Options:
  231. -f, --format FORMAT video format code, specify the order of
  232. preference using slashes, as in -f 22/17/18
  233. . Instead of format codes, you can select
  234. by extension for the extensions aac, m4a,
  235. mp3, mp4, ogg, wav, webm. You can also use
  236. the special names "best", "bestvideo",
  237. "bestaudio", "worst". By default, youtube-
  238. dl will pick the best quality. Use commas
  239. to download multiple audio formats, such as
  240. -f
  241. 136/137/mp4/bestvideo,140/m4a/bestaudio.
  242. You can merge the video and audio of two
  243. formats into a single file using -f <video-
  244. format>+<audio-format> (requires ffmpeg or
  245. avconv), for example -f
  246. bestvideo+bestaudio.
  247. --all-formats download all available video formats
  248. --prefer-free-formats prefer free video formats unless a specific
  249. one is requested
  250. --max-quality FORMAT highest quality format to download
  251. -F, --list-formats list all available formats
  252. --youtube-skip-dash-manifest Do not download the DASH manifest on
  253. YouTube videos
  254. --merge-output-format FORMAT If a merge is required (e.g.
  255. bestvideo+bestaudio), output to given
  256. container format. One of mkv, mp4, ogg,
  257. webm, flv.Ignored if no merge is required
  258. ## Subtitle Options:
  259. --write-sub write subtitle file
  260. --write-auto-sub write automatic subtitle file (youtube
  261. only)
  262. --all-subs downloads all the available subtitles of
  263. the video
  264. --list-subs lists all available subtitles for the video
  265. --sub-format FORMAT subtitle format (default=srt) ([sbv/vtt]
  266. youtube only)
  267. --sub-lang LANGS languages of the subtitles to download
  268. (optional) separated by commas, use IETF
  269. language tags like 'en,pt'
  270. ## Authentication Options:
  271. -u, --username USERNAME login with this account ID
  272. -p, --password PASSWORD account password
  273. -2, --twofactor TWOFACTOR two-factor auth code
  274. -n, --netrc use .netrc authentication data
  275. --video-password PASSWORD video password (vimeo, smotri)
  276. ## Post-processing Options:
  277. -x, --extract-audio convert video files to audio-only files
  278. (requires ffmpeg or avconv and ffprobe or
  279. avprobe)
  280. --audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a",
  281. "opus", or "wav"; "best" by default
  282. --audio-quality QUALITY ffmpeg/avconv audio quality specification,
  283. insert a value between 0 (better) and 9
  284. (worse) for VBR or a specific bitrate like
  285. 128K (default 5)
  286. --recode-video FORMAT Encode the video to another format if
  287. necessary (currently supported:
  288. mp4|flv|ogg|webm|mkv)
  289. -k, --keep-video keeps the video file on disk after the
  290. post-processing; the video is erased by
  291. default
  292. --no-post-overwrites do not overwrite post-processed files; the
  293. post-processed files are overwritten by
  294. default
  295. --embed-subs embed subtitles in the video (only for mp4
  296. videos)
  297. --embed-thumbnail embed thumbnail in the audio as cover art
  298. --add-metadata write metadata to the video file
  299. --xattrs write metadata to the video file's xattrs
  300. (using dublin core and xdg standards)
  301. --fixup POLICY (experimental) Automatically correct known
  302. faults of the file. One of never (do
  303. nothing), warn (only emit a warning),
  304. detect_or_warn(check whether we can do
  305. anything about it, warn otherwise
  306. --prefer-avconv Prefer avconv over ffmpeg for running the
  307. postprocessors (default)
  308. --prefer-ffmpeg Prefer ffmpeg over avconv for running the
  309. postprocessors
  310. --exec CMD Execute a command on the file after
  311. downloading, similar to find's -exec
  312. syntax. Example: --exec 'adb push {}
  313. /sdcard/Music/ && rm {}'
  314. # CONFIGURATION
  315. 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\<user name>\youtube-dl.conf`.
  316. # OUTPUT TEMPLATE
  317. 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:
  318. - `id`: The sequence will be replaced by the video identifier.
  319. - `url`: The sequence will be replaced by the video URL.
  320. - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
  321. - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
  322. - `title`: The sequence will be replaced by the video title.
  323. - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
  324. - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
  325. - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
  326. - `playlist`: The name or the id of the playlist that contains the video.
  327. - `playlist_index`: The index of the video in the playlist, a five-digit number.
  328. The current default template is `%(title)s-%(id)s.%(ext)s`.
  329. 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:
  330. ```bash
  331. $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
  332. youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
  333. $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
  334. youtube-dl_test_video_.mp4 # A simple file name
  335. ```
  336. # VIDEO SELECTION
  337. Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
  338. - Absolute dates: Dates in the format `YYYYMMDD`.
  339. - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
  340. Examples:
  341. ```bash
  342. # Download only the videos uploaded in the last 6 months
  343. $ youtube-dl --dateafter now-6months
  344. # Download only the videos uploaded on January 1, 1970
  345. $ youtube-dl --date 19700101
  346. $ # will only download the videos uploaded in the 200x decade
  347. $ youtube-dl --dateafter 20000101 --datebefore 20091231
  348. ```
  349. # FAQ
  350. ### How do I update youtube-dl?
  351. 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`).
  352. If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
  353. 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.
  354. 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
  355. sudo apt-get remove -y youtube-dl
  356. Afterwards, simply follow [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html):
  357. ```
  358. sudo wget https://yt-dl.org/latest/youtube-dl -O /usr/local/bin/youtube-dl
  359. sudo chmod a+x /usr/local/bin/youtube-dl
  360. hash -r
  361. ```
  362. Again, from then on you'll be able to update with `sudo youtube-dl -U`.
  363. ### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
  364. 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.
  365. 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.
  366. ### Do I always have to pass in `--max-quality FORMAT`, or `-citw`?
  367. 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`.
  368. ### Can you please put the -b option back?
  369. 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.
  370. ### I get HTTP error 402 when trying to download a video. What's this?
  371. 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.
  372. ### I have downloaded a video but how can I play it?
  373. Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
  374. ### The links provided by youtube-dl -g are not working anymore
  375. 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.
  376. ### ERROR: no fmt_url_map or conn information found in video info
  377. 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`.
  378. ### ERROR: unable to download video ###
  379. 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`.
  380. ### SyntaxError: Non-ASCII character ###
  381. The error
  382. File "youtube-dl", line 2
  383. SyntaxError: Non-ASCII character '\x93' ...
  384. means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
  385. ### What is this binary file? Where has the code gone?
  386. 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`.
  387. ### The exe throws a *Runtime error from Visual C++*
  388. 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).
  389. ### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
  390. If you put youtube-dl and ffmpeg in the same directory that you're running the command from, it will work, but that's rather cumbersome.
  391. To make a different directory work - either for ffmpeg, or for youtube-dl, or for both - simply create the directory (say, `C:\bin`, or `C:\Users\<User name>\bin`), put all the executables directly in there, and then [set your PATH environment variable](https://www.java.com/en/download/help/path.xml) to include that directory.
  392. From then on, after restarting your shell, you will be able to access both youtube-dl and ffmpeg (and youtube-dl will be able to find ffmpeg) by simply typing `youtube-dl` or `ffmpeg`, no matter what directory you're in.
  393. ### How can I detect whether a given URL is supported by youtube-dl?
  394. 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.
  395. 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.
  396. 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.
  397. # DEVELOPER INSTRUCTIONS
  398. 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.
  399. To run youtube-dl as a developer, you don't need to build anything either. Simply execute
  400. python -m youtube_dl
  401. To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
  402. python -m unittest discover
  403. python test/test_download.py
  404. nosetests
  405. If you want to create a build of youtube-dl yourself, you'll need
  406. * python
  407. * make
  408. * pandoc
  409. * zip
  410. * nosetests
  411. ### Adding support for a new site
  412. If you want to add support for a new site, you can follow this quick list (assuming your service is called `yourextractor`):
  413. 1. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
  414. 2. Check out the source code with `git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git`
  415. 3. Start a new git branch with `cd youtube-dl; git checkout -b yourextractor`
  416. 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
  417. ```python
  418. # coding: utf-8
  419. from __future__ import unicode_literals
  420. from .common import InfoExtractor
  421. class YourExtractorIE(InfoExtractor):
  422. _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
  423. _TEST = {
  424. 'url': 'http://yourextractor.com/watch/42',
  425. 'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
  426. 'info_dict': {
  427. 'id': '42',
  428. 'ext': 'mp4',
  429. 'title': 'Video title goes here',
  430. 'thumbnail': 're:^https?://.*\.jpg$',
  431. # TODO more properties, either as:
  432. # * A value
  433. # * MD5 checksum; start the string with md5:
  434. # * A regular expression; start the string with re:
  435. # * Any Python type (for example int or float)
  436. }
  437. }
  438. def _real_extract(self, url):
  439. video_id = self._match_id(url)
  440. webpage = self._download_webpage(url, video_id)
  441. # TODO more code goes here, for example ...
  442. title = self._html_search_regex(r'<h1>(.*?)</h1>', webpage, 'title')
  443. return {
  444. 'id': video_id,
  445. 'title': title,
  446. 'description': self._og_search_description(webpage),
  447. # TODO more properties (see youtube_dl/extractor/common.py)
  448. }
  449. ```
  450. 5. Add an import in [`youtube_dl/extractor/__init__.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/__init__.py).
  451. 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.
  452. 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.
  453. 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).
  454. 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:
  455. $ git add youtube_dl/extractor/__init__.py
  456. $ git add youtube_dl/extractor/yourextractor.py
  457. $ git commit -m '[yourextractor] Add new extractor'
  458. $ git push origin yourextractor
  459. 10. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
  460. In any case, thank you very much for your contributions!
  461. # EMBEDDING YOUTUBE-DL
  462. 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).
  463. From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
  464. ```python
  465. import youtube_dl
  466. ydl_opts = {}
  467. with youtube_dl.YoutubeDL(ydl_opts) as ydl:
  468. ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
  469. ```
  470. 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.
  471. 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:
  472. ```python
  473. import youtube_dl
  474. class MyLogger(object):
  475. def debug(self, msg):
  476. pass
  477. def warning(self, msg):
  478. pass
  479. def error(self, msg):
  480. print(msg)
  481. def my_hook(d):
  482. if d['status'] == 'finished':
  483. print('Done downloading, now converting ...')
  484. ydl_opts = {
  485. 'format': 'bestaudio/best',
  486. 'postprocessors': [{
  487. 'key': 'FFmpegExtractAudio',
  488. 'preferredcodec': 'mp3',
  489. 'preferredquality': '192',
  490. }],
  491. 'logger': MyLogger(),
  492. 'progress_hooks': [my_hook],
  493. }
  494. with youtube_dl.YoutubeDL(ydl_opts) as ydl:
  495. ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
  496. ```
  497. # BUGS
  498. 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.
  499. 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.
  500. Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
  501. ### Is the description of the issue itself sufficient?
  502. 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.
  503. So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
  504. - What the problem is
  505. - How it could be fixed
  506. - How your proposed solution would look like
  507. 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.
  508. 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.
  509. 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.
  510. ### Are you using the latest version?
  511. 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.
  512. ### Is the issue already documented?
  513. 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.
  514. ### Why are existing options not enough?
  515. 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.
  516. ### Is there enough context in your bug report?
  517. 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).
  518. 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.
  519. ### Does the issue involve one problem, and one problem only?
  520. 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.
  521. 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.
  522. ### Is anyone going to need the feature?
  523. 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.
  524. ### Is your question about youtube-dl?
  525. 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.
  526. # COPYRIGHT
  527. youtube-dl is released into the public domain by the copyright holders.
  528. This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.