Installation

Requirements

Wpull requires the following:

The following are optional:

  • psutil for monitoring disk space
  • Manhole for a REPL debugging socket
  • PhantomJS 1.9.8, 2.1 for capturing interactive JavaScript pages
  • youtube-dl for downloading complex video streaming sites

For installing Wpull, it is recommended to use pip installer.

Wpull is officially supported in a Unix-like environment.

Automatic Install

Once you have installed Python, lxml, and pip, install Wpull with dependencies automatically from PyPI:

pip3 install wpull

Tip

Adding the --upgrade option will upgrade Wpull to the latest release. Use --no-dependencies to only upgrade Wpull.

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

Automatic install is usually the best option. However, there may be outstanding fixes to bugs that are not yet released to PyPI. In this case, use the manual install.

Manual Install

Install the dependencies known to work with Wpull:

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.

psutil

psutil is required for the disk and memory monitoring options but may not be available. To install:

pip3 install psutil

Pre-built Binaries

Wpull has pre-built binaries located at https://launchpad.net/wpull/+download. These are unsupported and may not be up to date.

Caveats

Python

Please obtain the latest Python release from http://python.org/download/ or your package manager. It is recommended to use Python 3.4.3 or greater. Versions 3.4 and 3.4 are officially supported.

Python 2 and PyPy are not supported.

lxml

It is recommended that lxml is obtained through an installer or pre-built package. Windows packages are provided on https://pypi.python.org/pypi/lxml. Debian/Ubuntu users should install python3-lxml. For more information, see http://lxml.de/installation.html.

pip

If pip is not installed on your system yet, please follow the instructions at http://www.pip-installer.org/en/latest/installing.html to install pip. Note for Linux users, ensure you are executing the appropriate Python version when installing pip.

PhantomJS (Optional)

It is recommended to download a prebuilt binary build from http://phantomjs.org/download.html.