Skip to content
Wget-compatible web downloader and crawler.
HTML Python JavaScript Haxe CSS Shell
Branch: develop
Clone or download
ivan Merge pull request #414 from PromyLOPh/fix-travis
Travis: Test with Python 3.6, 3.7, as well as -dev
Latest commit ddf051a Mar 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc changelog: Update latest to 2.0.1 Jun 21, 2016
freezer freezer: Install specific version of Pyinstaller. Add plain entry poi… Jun 17, 2016
icon Adds icons. Jan 27, 2014
test test: Run fuzzers with faulthandler enabled Apr 20, 2015
wpull Fix error in be96abc May 15, 2017
.gitignore freezer: Add WIP pyinstaller runner. Mar 13, 2015
.travis.yml Travis: Test with Python 3.6, 3.7, as well as -dev Mar 9, 2019
CONTRIBUTING.md doc: Add testing notes, how to help, update current year Jun 13, 2016
ISSUE_TEMPLATE.md github: Format and reword issue template a bit Jun 20, 2016
LICENSE.txt
MANIFEST.in freeze: Add some readmes Mar 13, 2015
PULL_REQUEST_TEMPLATE.md github: Fill in more contributing doc. Add issue/PR templates. Jun 3, 2016
README.rst doc: Add info on differences and intended use cases, update links Jun 2, 2016
autopep8.sh Reformat with autopep8. May 29, 2014
requirements-sphinx.txt Add stricter ranges to requirements.txt. Jun 9, 2016
requirements.txt Add stricter ranges to requirements.txt. Jun 9, 2016
setup.py setup.py: Use entry_points instead of providing scripts ourselves Jun 17, 2016

README.rst

Wpull

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

A dog pulling a box via a harness.

Notable Features:

  • Written in Python: lightweight, modifiable, robust, & scriptable
  • Graceful stopping; on-disk database resume
  • PhantomJS & youtube-dl integration (experimental)

Install

Wpull uses Python 3.

Once Python is installed, download Wpull from PyPI using pip:

pip3 install wpull

For detailed installation instructions and potential caveats, please see https://wpull.readthedocs.io/en/master/install.html.

Example Commands

To download the About page of Google.com:

wpull google.com/about

To archive a website:

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-allow linked-pages,page-requisites \
    --escaped-fragment --strip-session-id \
    --sitemaps \
    --reject-regex "/login\.php" \
    --tries 3 --retry-connrefused --retry-dns-error \
    --timeout 60 --session-timeout 21600 \
    --delete-after --database blogsite-billy.db \
    --quiet --output-file blogsite-billy.log

To see all options:

wpull --help

Documentation

Documentation is located at https://wpull.readthedocs.io/. Please have a look at it before using Wpull's advanced features.

Help

Need help? Please see our Help page which contains frequently asked questions and support information.

The issue tracker is located at https://github.com/chfoo/wpull/issues.

Dev

Travis CI build status Coveralls report

Contributions and feedback are greatly appreciated.

Credits

Copyright 2013-2016 by Christopher Foo and others. License GPL v3.

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

  • wpull.backport.logging
  • wpull.thirdparty.robotexclusionrulesparser
  • wpull.thirdparty.dammit

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

You can’t perform that action at this time.