]> code.delx.au - webdl/blob - README.md
Improved README
[webdl] / 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 ## Installation
7
8 Install the following packages using your package manager:
9
10 * Python 3.2+
11 * ffmpeg or libav-tools
12
13 Clone the WebDL repository:
14 ```
15 git clone https://bitbucket.org/delx/webdl
16 cd webdl
17 ```
18
19 Set up a Python virtualenv and use pip to install the other dependencies:
20 ```
21 virtualenv --python python3 .virtualenv
22 . .virtualenv/bin/activate
23 pip install -r requirements.txt
24 ```
25
26 ## Interactive usage (grabber.py)
27
28 You can run WebDL interactively to browse categories and episode lists and download TV episodes.
29
30 ```
31 $ ./grabber.py
32 1) ABC iView
33 2) SBS
34 0) Back
35 Choose> 1
36 1) ABC 4 Kids
37 2) Arts & Culture
38 3) Comedy
39 4) Documentary
40 <snipped>
41 Choose> 4
42 1) ABC Open Series 2012
43 2) Art Of Germany
44 3) Baby Beauty Queens
45 4) Catalyst Series 13
46 <snipped>
47 Choose> 4
48 1) Catalyst Series 13 Episode 15
49 2) Catalyst Series 13 Episode 16
50 0) Back
51 Choose> 1
52 RTMPDump v2.3
53 (c) 2010 Andrej Stepanchuk, Howard Chu, The Flvstreamer Team; license: GPL
54 Connecting ...
55 INFO: Connected...
56 Starting download at: 0.000 kB
57 ```
58
59 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.
60
61
62
63 ## Cron scripted usage (autograbber.py)
64
65 You can schedule a regular download of your favourite shows.
66
67 ```
68 # m h dom mon dow command
69 0 1 * * * ./autograbber.py /videos/ABC4Kids /videos/Insight
70 ```
71
72 Each of these directories should contain a `.patterns.txt` with shell-style globs:
73
74 ```
75 ABC iView/By Channel/ABC4Kids/*/*
76 SBS/Channel/SBS1/Insight*
77 ```
78
79 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.
80
81
82 ## Bug reports
83
84 Please raise issues on the [Bitbucket project](https://bitbucket.org/delx/webdl/issues?status=new&status=open).