X-Git-Url: https://code.delx.au/webdl/blobdiff_plain/027b8b4760a2a629bcba7b2ecdbcc3f0e03650fc..1e187809bf3e16a098cd31f4bf572a5e674cc9a7:/README.md diff --git a/README.md b/README.md index f358705..1dd4945 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,20 @@ WebDL is a set of Python scripts to grab video from online Free To Air Australian channels. -## Installation +## News + +### 2017-02-24 +* Now requires Python3, use the `python2` branch if you need the old version. +* Recommended installation is now with `virtualenv` and `pip` to install dependencies. +* Removed some custom logic in favour of the `requests` and `requests_cache` libraries. +* `autograbber.py` can write to multiple directories, previous command line args are still supported. + + +## Installation using pip Install the following packages using your package manager: -* Python 3.2+ +* Python 3.2+ (including dev package) * ffmpeg or libav-tools Clone the WebDL repository: @@ -23,6 +32,28 @@ virtualenv --python python3 .virtualenv pip install -r requirements.txt ``` +Whenever you want to run WebDL you must source the `.virtualenv/bin/activate` script from your shell. + + +## Installation on Debian/Ubuntu + +Install Python 3 and needed libraries: +``` +apt-get install python3 python3-lxml python3-requests python3-requests-cache +``` + + +Install Livestreamer and PyCrypto. Ubuntu packages this as Python 2: +``` +apt-get install livestreamer python-crypto +``` + + +Install ffmpeg: +``` +apt-get install ffmpeg +``` + ## Interactive usage (grabber.py) You can run WebDL interactively to browse categories and episode lists and download TV episodes. @@ -62,11 +93,11 @@ The bolded parts are what you type. Note that you can go back on any screen by t ## Cron scripted usage (autograbber.py) -You can schedule a regular download of your favourite shows. +You can schedule a regular download of your favourite shows. This example uses `chronic` from `moreutils`. ``` # m h dom mon dow command - 0 1 * * * ./autograbber.py /videos/ABC4Kids /videos/Insight + 0 1 * * * timeout 6h chronic $HOME/webdl/autograbber-cron.sh /videos/ABC4Kids /videos/Insight ``` Each of these directories should contain a `.patterns.txt` with shell-style globs: