Skip to main content

Wget-compatible web downloader and crawler.

Project description

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wpull-2.0.1.tar.gz (666.8 kB view details)

Uploaded Source

File details

Details for the file wpull-2.0.1.tar.gz.

File metadata

  • Download URL: wpull-2.0.1.tar.gz
  • Upload date:
  • Size: 666.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for wpull-2.0.1.tar.gz
Algorithm Hash digest
SHA256 eaaa85f9755a5ee0ac63770e37713eb68f99a73c267abd4d1439057eedd5dca3
MD5 dc2f9b083877fd903f1b63f17c30fe4c
BLAKE2b-256 0dff70779b7cb3e25d173df641e7ae59c20e2597d687ad5e98e36c1429f12a7b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page