gecko-dev/third_party/python/dlmanager
Sandor Molnar c8d4131030 Backed out 5 changesets (bug 1774569) because changes are incompatible with flake8. CLOSED TREE
Backed out changeset ac6c7441099b (bug 1774569)
Backed out changeset 1081432f3f97 (bug 1774569)
Backed out changeset 111d7f2021c3 (bug 1774569)
Backed out changeset 2cc0b2a54106 (bug 1774569)
Backed out changeset cb45ff55284c (bug 1774569)
2023-03-07 23:21:19 +02:00
..
dlmanager
doc
examples
tests
README.rst
check.py
requirements.txt
setup.cfg
setup.py
test-requirements.txt

README.rst

.. image:: https://badge.fury.io/py/dlmanager.svg
    :target: https://pypi.python.org/pypi/dlmanager

.. image:: https://readthedocs.org/projects/dlmanager/badge/?version=latest
    :target: http://dlmanager.readthedocs.org/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://travis-ci.org/parkouss/dlmanager.svg?branch=master
    :target: https://travis-ci.org/parkouss/dlmanager

.. image:: https://codecov.io/github/parkouss/dlmanager/coverage.svg?branch=master
    :target: https://codecov.io/github/parkouss/dlmanager?branch=master

dlmanager
=========

**dlmanager** is Python 2 and 3 download manager library, with the following
features:

- Download files in background and in parallel
- Cancel downloads
- store downloads in a given directory, avoiding re-downloading files
- Limit the size of this directory, removing oldest files


Example
-------

.. code-block:: python

  from dlmanager import DownloadManager, PersistLimit

  manager = DownloadManager(
      "dlmanager-destir",
      persist_limit=PersistLimit(
          size_limit=1073741824,  #  1 GB max
          file_limit=10,  # force to keep 10 files even if size_limit is reached
      )
  )

  # Start downloads in background
  # Note that if files are already present, this is a no-op.
  manager.download(url1)
  manager.download(url2)

  # Wait for completion
  try:
      manager.wait()
  except:
      manager.cancel()
      raise


Installation
------------

Use pip: ::

  pip install -U dlmanager