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 ### 2023-06-05
   9
  10 * Fixed SBS.
  11 * Support modern ffmpeg, dropped libav-tools.
  12
  13 ### 2018-02-24
  14
  15 * Support for Streamlink in addition to Livestreamer.
  16 * Currently working with iView, SBS and Channel 10.
  17
  18 ### 2017-02-24
  19 * Now requires Python3, use the `python2` branch if you need the old version.
  20 * Recommended installation is now with `virtualenv` and `pip` to install dependencies.
  21 * Removed some custom logic in favour of the `requests` and `requests_cache` libraries.
  22 * `autograbber.py` can write to multiple directories, previous command line args are still supported.
  23
  24
  25 ## Updating to the latest version
  26
  27 You must use [git](https://git-scm.com) to keep up to date. The `autograbber-cron.sh` script is how I do this. If you'd like to manually update just run these commands.
  28
  29 ```
  30 cd webdl
  31 git pull --ff-only
  32 ```
  33
  34
  35 ## Installation using pip
  36
  37 Install the following packages using your package manager:
  38
  39 * Python 3.2+ (including dev package)
  40
  41 Clone the WebDL repository:
  42 ```
  43 git clone https://bitbucket.org/delx/webdl
  44 cd webdl
  45 ```
  46
  47 Set up a Python virtualenv and use pip to install the other dependencies:
  48 ```
  49 virtualenv .virtualenv
  50 . .virtualenv/bin/activate
  51 pip install -r requirements.txt
  52 ```
  53
  54 Whenever you want to run WebDL you must source the `.virtualenv/bin/activate` script from your shell.
  55
  56
  57 ## Installation on Debian/Ubuntu
  58
  59 Clone the WebDL repository:
  60 ```
  61 git clone https://bitbucket.org/delx/webdl
  62 cd webdl
  63 ```
  64
  65 Install Python 3 and needed libraries:
  66 ```
  67 apt-get install python3 python3-lxml python3-requests python3-requests-cache
  68 ```
  69
  70 You must also install Streamlink, or if it unavailable, the older Livestreamer. Depending on the age of your distro you'll need either:
  71
  72 - `apt-get install streamlink`
  73 - `apt-get install livestreamer python-crypto`
  74
  75
  76 Install ffmpeg:
  77 ```
  78 apt-get install ffmpeg
  79 ```
  80
  81 ## Interactive usage (grabber.py)
  82
  83 You can run WebDL interactively to browse categories and episode lists and download TV episodes.
  84
  85 ```
  86 $ ./grabber.py
  87  1) ABC iView
  88  2) SBS
  89  0) Back
  90 Choose> 1
  91  1) ABC 4 Kids
  92  2) Arts & Culture
  93  3) Comedy
  94  4) Documentary
  95 <snipped>
  96 Choose> 4
  97  1) ABC Open Series 2012
  98  2) Art Of Germany
  99  3) Baby Beauty Queens
 100  4) Catalyst Series 13
 101 <snipped>
 102 Choose> 4
 103  1) Catalyst Series 13 Episode 15
 104  2) Catalyst Series 13 Episode 16
 105  0) Back
 106 Choose> 1
 107 RTMPDump v2.3
 108 (c) 2010 Andrej Stepanchuk, Howard Chu, The Flvstreamer Team; license: GPL
 109 Connecting ...
 110 INFO: Connected...
 111 Starting download at: 0.000 kB
 112 ```
 113
 114 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.
 115
 116
 117
 118 ## Cron scripted usage (autograbber.py)
 119
 120 You can schedule a regular download of your favourite shows. This example uses `chronic` from `moreutils`.
 121
 122 ```
 123 # m    h  dom mon dow   command
 124   0    1   *   *   *     timeout 6h chronic $HOME/webdl/autograbber-cron.sh /videos/ABC4Kids /videos/Insight
 125 ```
 126
 127 Each of these directories should contain a `.patterns.txt` with shell-style globs:
 128
 129 ```
 130 ABC iView/By Channel/ABC4Kids/*/*
 131 SBS/Channel/SBS1/Insight*
 132 ```
 133
 134 You may optionally created a `.excludes.txt` file with shell-style globs. This is matched against the episode title and can be used to filter out things you don't want. For example:
 135
 136 ```
 137 *(Mandarin)*
 138 *(Chinese)*
 139 ```
 140
 141 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.
 142
 143
 144 ## Bug reports
 145
 146 Please raise issues on the [Bitbucket project](https://bitbucket.org/delx/webdl/issues?status=new&status=open).