]> code.delx.au - webdl/commitdiff
Added usage info to README.md
authordelx <jamesbunton@delx.net.au>
Tue, 12 Jan 2016 05:07:16 +0000 (05:07 +0000)
committerdelx <jamesbunton@delx.net.au>
Tue, 12 Jan 2016 05:07:16 +0000 (05:07 +0000)
README.md

index 2f34c997836904a61b836f23c8bcef2cba6f7bbb..bfff464c08c3af7c98a5dfe1c67a51590c7b3d2d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ WebDL is a set of Python scripts to grab video from online Free To Air Australia
 * python-lxml
 * ffmpeg / libav-tools
 
-## Instructions
+## Installation
 
 ### Arch Linux
     pacman -S livestreamer python-crypto python-lxml ffmpeg
@@ -31,6 +31,62 @@ Warning, this is untested!
     python3 ./grabber.py
 
 
+## Interactive usage (grabber.py)
+
+You can run WebDL interactively to browse categories and episode lists and download TV episodes.
+
+```
+$ ./grabber.py
+ 1) ABC iView
+ 2) SBS
+ 0) Back
+Choose> 1
+ 1) ABC 4 Kids
+ 2) Arts & Culture
+ 3) Comedy
+ 4) Documentary
+<snipped>
+Choose> 4
+ 1) ABC Open Series 2012
+ 2) Art Of Germany
+ 3) Baby Beauty Queens
+ 4) Catalyst Series 13
+<snipped>
+Choose> 4
+ 1) Catalyst Series 13 Episode 15
+ 2) Catalyst Series 13 Episode 16
+ 0) Back
+Choose> 1
+RTMPDump v2.3
+(c) 2010 Andrej Stepanchuk, Howard Chu, The Flvstreamer Team; license: GPL
+Connecting ...
+INFO: Connected...
+Starting download at: 0.000 kB
+```
+
+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.
+
+
+
+## Cron scripted usage (autograbber.py)
+
+I have a shell script which looks something like this, I run it daily from crontab.
+
+```
+# m    h  dom mon dow   command
+  0    1   *   *   *     ./autograbber.py /path/to/video-dir/ /path/to/patterns.txt
+```
+
+The patterns.txt file should contain shell-style globs, something like:
+
+```
+ABC iView/*/QI*/*
+SBS/Programs/Documentary/*/*
+```
+
+The above will download all episodes of QI from ABC as well as every SBS documentary. 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.
+
+
 ## Bug reports
 
 Log an issue on the [Bitbucket project](https://bitbucket.org/delx/webdl/issues?status=new&status=open)