code.delx.au - webdl/blob - README.md

   1 # WebDL #
   2
   3 WebDL is a set of Python scripts to grab video from online Free To Air Australian channels.
   4
   5
   6 ## News
   7
   8 ### 2017-02-24
   9 * Now requires Python3, use the `python2` branch if you need the old version.
  10 * Recommended installation is now with `virtualenv` and `pip` to install dependencies.
  11 * Removed some custom logic in favour of the `requests` and `requests_cache` libraries.
  12 * `autograbber.py` can write to multiple directories, previous command line args are still supported.
  13
  14
  15 ## Installation using pip
  16
  17 Install the following packages using your package manager:
  18
  19 * Python 3.2+ (including dev package)
  20 * ffmpeg or libav-tools
  21
  22 Clone the WebDL repository:
  23 ```
  24 git clone https://bitbucket.org/delx/webdl
  25 cd webdl
  26 ```
  27
  28 Set up a Python virtualenv and use pip to install the other dependencies:
  29 ```
  30 virtualenv --python python3 .virtualenv
  31 . .virtualenv/bin/activate
  32 pip install -r requirements.txt
  33 ```
  34
  35 Whenever you want to run WebDL you must source the `.virtualenv/bin/activate` script from your shell.
  36
  37
  38 ## Installation on Debian/Ubuntu
  39
  40 Install Python 3 and needed libraries:
  41 ```
  42 apt-get install python3 python3-lxml python3-requests python3-requests-cache
  43 ```
  44
  45
  46 Install Livestreamer and PyCrypto. Ubuntu packages this as Python 2:
  47 ```
  48 apt-get install livestreamer python-crypto
  49 ```
  50
  51
  52 Install ffmpeg:
  53 ```
  54 apt-get install ffmpeg
  55 ```
  56
  57 ## Interactive usage (grabber.py)
  58
  59 You can run WebDL interactively to browse categories and episode lists and download TV episodes.
  60
  61 ```
  62 $ ./grabber.py
  63  1) ABC iView
  64  2) SBS
  65  0) Back
  66 Choose> 1
  67  1) ABC 4 Kids
  68  2) Arts & Culture
  69  3) Comedy
  70  4) Documentary
  71 <snipped>
  72 Choose> 4
  73  1) ABC Open Series 2012
  74  2) Art Of Germany
  75  3) Baby Beauty Queens
  76  4) Catalyst Series 13
  77 <snipped>
  78 Choose> 4
  79  1) Catalyst Series 13 Episode 15
  80  2) Catalyst Series 13 Episode 16
  81  0) Back
  82 Choose> 1
  83 RTMPDump v2.3
  84 (c) 2010 Andrej Stepanchuk, Howard Chu, The Flvstreamer Team; license: GPL
  85 Connecting ...
  86 INFO: Connected...
  87 Starting download at: 0.000 kB
  88 ```
  89
  90 The bolded parts are what you type. Note that you can go back on any screen by typing “0”. At the list of episodes you can download a single episode by typing one number, or multiple episodes by typing several numbers separated by spaces.
  91
  92
  93
  94 ## Cron scripted usage (autograbber.py)
  95
  96 You can schedule a regular download of your favourite shows. This example uses `chronic` from `moreutils`.
  97
  98 ```
  99 # m    h  dom mon dow   command
 100   0    1   *   *   *     timeout 6h chronic $HOME/webdl/autograbber-cron.sh /videos/ABC4Kids /videos/Insight
 101 ```
 102
 103 Each of these directories should contain a `.patterns.txt` with shell-style globs:
 104
 105 ```
 106 ABC iView/By Channel/ABC4Kids/*/*
 107 SBS/Channel/SBS1/Insight*
 108 ```
 109
 110 Whenever an episode is downloaded it is recorded into `.downloaded_auto.txt`. Even if you move the files somewhere else they will not be redownloaded.
 111
 112
 113 ## Bug reports
 114
 115 Please raise issues on the [Bitbucket project](https://bitbucket.org/delx/webdl/issues?status=new&status=open).