wpull 0.10.5

Wget-compatible web downloader.

Wpull is a Wget-compatible (or remake/clone/replacement/alternative) web downloader.

Features:

• Written in Python

• Modular

• Asynchronous

• Lua scripting support

Currently in beta quality! Some features are not implemented yet and the API is not considered stable.

Install

Requires:

• Python 2.6, 2.7, or 3.2+

• Tornado

• Toro

• lxml

• chardet

• Lunatic Python (bastibe version) (optional for Lua support)

Automatic Install

Install Wpull with dependencies automatically from PyPI:

pip3 install wpull

• Note: Python 2 users, please see note in the next subsection.

• Tip: Adding the --upgrade option will upgrade Wpull to the latest release.

• Tip: Adding the --user option will install Wpull into your home directory.

Python 2.6/2.7

Please ensure you have the latest lib3to2 from Bitbucket before installing Wpull:

pip install hg+https://bitbucket.org/amentajo/lib3to2#egg=3to2

Manual Install

Install the dependencies:

pip3 install -r https://raw2.github.com/chfoo/wpull/master/requirements.txt

Install Wpull from GitHub:

pip3 install git+https://github.com/chfoo/wpull.git#egg=wpull

Tip: Using git+https://github.com/chfoo/wpull.git@develop#egg=wpull as the path will install Wpull’s develop branch.

Python 2.6/2.7

Requires

• futures

• lib3to2 (the one on PyPI is very outdated!)

Install additional dependencies before installing Wpull:

pip install -r https://raw2.github.com/chfoo/wpull/master/requirements-py2.txt

Invoking setup.py will trigger the 3to2 process. The Python 2 compatible source code will be placed in py2src_noedit/.

Lua Scripting

To enable Lua scripting support, Lunatic Python (bastibe version) can be installed using pip:

pip3 install git+https://github.com/bastibe/lunatic-python.git#egg=lunatic-python

At time of writing, Lunatic Python uses Lua 5.2. If you desire a different version of Lua, please see below.

At time of writing, Lunatic Python does not support Python 3.2.

Specify Lua version

Download lunatic-python from https://github.com/bastibe/lunatic-python using the “Download ZIP” link or git clone.

Inside setup.py, edit LUAVERSION to reflect the current Lua library installed. On Ubuntu it is known by libluaX.Y-dev.

Run pip to install Lunatic Python with LOCATION replaced with the location of the Lunatic Python source code.:

pip install LOCATION

Run

To download the About page of Google.com:

python3 -m wpull google.com/about

To archive a website:

python3 -m wpull billy.blogsite.example --warc-file blogsite-billy \
--no-check-certificate \
--no-robots --user-agent "InconspiuousWebBrowser/1.0" \
--wait 0.5 --random-wait --waitretry 600 \
--page-requisites --recursive --level inf \
--span-hosts --domains blogsitecdn.example,cloudspeeder.example \
--hostnames billy.blogsite.example \
--reject-regex "/login\.php"  \
--tries inf --retry-connrefused --retry-dns-error \
--delete-after --database blogsite-billy.db \
--quiet --output-file blogsite-billy.log

To see all options:

python3 -m wpull --help

Documentation

Documentation is not yet written.

API Note: This library is not thread safe.

Help

Issues can be reported to the issue tracker: https://github.com/chfoo/wpull/issues. You can also use the issue tracker to ask questions.

Todo

• lot’s of TODO markers in code

• docstrings

• sphinx doc config

Credits

Copyright 2013-2014 by Christopher Foo. License GPL v3.

This project contains third-party source code licensed under different terms:

• backport

• wpull.backport.argparse

• wpull.backport.collections

• wpull.backport.functools

• wpull.backport.tempfile

• wpull.thirdparty.robotexclusionrulesparser

We would like to acknowledge the authors of GNU Wget as Wpull uses algorithms from Wget.