https://github.com/takluyver/requests_download

Download to a local file using requests
https://github.com/takluyver/requests_download

Last synced: about 2 months ago
JSON representation

Download to a local file using requests

• Host: GitHub
• URL: https://github.com/takluyver/requests_download
• Owner: takluyver
• License: mit
• Created: 2016-01-05T18:03:05.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-05-16T08:54:38.000Z (over 1 year ago)
• Last Synced: 2024-10-11T19:19:00.199Z (3 months ago)
• Language: Python
• Size: 6.84 KB
• Stars: 10
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
A convenient function to download to a file using requests.

Basic usage:

.. code-block:: python

    url = "https://github.com/takluyver/requests_download/archive/master.zip"

    download(url, "requests_download.zip")

An optional ``headers=`` parameter is passed through to requests.

**Trackers** are a lightweight way to monitor the data being downloaded.

Two trackers are included:

- ``ProgressTracker`` - displays a progress bar, using the `progressbar2

  `_ package.

- ``HashTracker`` - wraps a hashlib object to calculate a hash (e.g. sha256 or

  md5) of the file as you download it.

Here's an example of using both of them:

.. code-block:: python

    import hashlib

    # progressbar is provided by progressbar2 on PYPI.

    from progressbar import DataTransferBar

    from requests_download import download, HashTracker, ProgressTracker

    hasher = HashTracker(hashlib.sha256())

    progress = ProgressTracker(DataTransferBar())

    download('https://github.com/takluyver/requests_download/archive/master.zip',

             'requests_download.zip', trackers=(hasher, progress))

    assert hasher.hashobj.hexdigest() == '...'

To make your own tracker, subclass TrackerBase and define any of these methods:

.. code-block:: python

    from requests_download import TrackerBase

    class MyTracker(TrackerBase):

        def on_start(self, response):

            """Called with requests.Response object, which has response headers"""

            pass

        def on_chunk(self, chunk):

            """Called multiple times, with bytestrings of data received"""

            pass

        def on_finish(self):

            """Called when the download has completed"""

            pass