Skip to main content

A HTTP and FTP parallel file downloader.

Project description

Latest PyPI version

A parallel file downloader using asyncio. parfive can handle downloading multiple files in parallel as well as downloading each file in a number of chunks.

Usage

asciicast demo of parfive

parfive works by creating a downloader object, appending files to it and then running the download. parfive has a synchronous API, but uses asyncio to paralellise downloading the files.

A simple example is:

from parfive import Downloader
dl = Downloader()
dl.enqueue_file("http://data.sunpy.org/sample-data/predicted-sunspot-radio-flux.txt", path="./")
files = dl.download()

Parfive also bundles a CLI. The following example will download the two files concurrently.:

$ parfive 'http://212.183.159.230/5MB.zip' 'http://212.183.159.230/10MB.zip'
$ parfive --help
usage: parfive [-h] [--max-conn MAX_CONN] [--overwrite] [--no-file-progress]
              [--directory DIRECTORY] [--print-filenames]
              URLS [URLS ...]

Parfive, the python asyncio based downloader

positional arguments:
  URLS                  URLs of files to be downloaded.

optional arguments:
  -h, --help            show this help message and exit
  --max-conn MAX_CONN   Number of maximum connections.
  --overwrite           Overwrite if the file exists.
  --no-file-progress    Show progress bar for each file.
  --directory DIRECTORY
                        Directory to which downloaded files are saved.
  --print-filenames     Print successfully downloaded files's names to stdout.

Results

parfive.Downloader.download returns a parfive.Results object, which is a list of the filenames that have been downloaded. It also tracks any files which failed to download.

Handling Errors

If files fail to download, the urls and the response from the server are stored in the Results object returned by parfive.Downloader. These can be used to inform users about the errors. (Note, the progress bar will finish in an incomplete state if a download fails, i.e. it will show 4/5 Files Downloaded).

The Results object is a list with an extra attribute errors, this property returns a list of named tuples, where these named tuples contains the .url and the .response, which is a aiohttp.ClientResponse or a aiohttp.ClientError object.

Installation

parfive is available on PyPI, you can install it with pip:

pip install parfive

or if you want to use FTP downloads:

pip install parfive[ftp]

Requirements

  • Python 3.9 or above

  • aiohttp

  • tqdm

  • aioftp (for downloads over FTP)

Licence

MIT Licensed

Authors

parfive was written by Stuart Mumford.

Project details


Download files

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

Source Distribution

parfive-2.2.0.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

parfive-2.2.0-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

Details for the file parfive-2.2.0.tar.gz.

File metadata

  • Download URL: parfive-2.2.0.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for parfive-2.2.0.tar.gz
Algorithm Hash digest
SHA256 de07d148d898e3f8ad6d6514e1d28e13f51d80de153fa1918c346509a5002e9b
MD5 67c92f1b71ba2c919a0acdd65ee70570
BLAKE2b-256 099fd39648cf1c6e138fc93cd9a5c8696df782eef774f1d296824adfd82bf34b

See more details on using hashes here.

File details

Details for the file parfive-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: parfive-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 34.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for parfive-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32098212fca0624c3d3de798a0b0dff1e4c6fb1ee4aa57b104d8f5cae13c05d5
MD5 207238b6a6c2f0ba0715b21001662c8e
BLAKE2b-256 5997626f93ba97f25e42b7c769a6bf236c2865f1ff3ee5f4d5cae389ca99f019

See more details on using hashes here.

Supported by

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