Skip to main content

PyPI-Status PyPI-Versions Build-Status Codecov LICENCE

requests-based file downloads with tqdm progress bars.

from tqdl import download
download(file_url, target_file_path)
 19%|█▊        | 20.5M/110M [00:06<00:29, 2.98MiB/s]

1 Installation

pip install tqdl

2 Features

  • Simple and straightforward API.

  • Installable from PyPI with pip install tqdl.

  • Tested on TravisCI against Linux, Windows and macOS, and Python versions 3.5 through 3.7.

  • The name - تقدّل - can be traslated as “get ahead”, which is awesome.

3 Use

tqdl contains a single funcion, aptly named download, which you can use to download files with a nice progress bar by providing it with a URL and a file path. Obviously, this is only useful for downloads of large files, and where you cae about showing the user (of your code/script/whatever) the progress of the ongoing download.

Here is a very straightforward example:

from tqdl import download
download(file_url, target_file_path)
 19%|█▊        | 20.5M/110M [00:06<00:29, 2.98MiB/s]

4 Contributing

Package author and current maintainer is Shay Palachy (shay.palachy@gmail.com); You are more than welcome to approach him for help. Contributions are very welcomed.

4.1 Installing for development

Clone:

git clone git@github.com:shaypal5/tqdl.git

Install in development mode, including test dependencies:

cd tqdl
pip install -e '.[test]'

4.2 Running the tests

To run the tests use:

cd tqdl
pytest

4.3 Adding documentation

The project is documented using the numpy docstring conventions, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings. When documenting code you add to this project, follow these conventions.

Additionally, if you update this README.rst file, use python setup.py checkdocs to validate it compiles.

5 Credits

Created by Shay Palachy (shay.palachy@gmail.com).

Based on a stackoverflow answer by user leovp.

Metadata

Release files for tqdl 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tqdl 0.0.4
File Size Uploaded
tqdl-0.0.4.tar.gz 20.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tqdl 0.0.4
File Interpreter ABI Platform
tqdl-0.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 24.9 kB

Release files / tqdl-0.0.4.tar.gz

Download URL tqdl-0.0.4.tar.gz
Size 20.1 kB
Tags Source
SHA-256 checksum
How to use checksums
60d95cf53e9f3d9617d0d5b54585d6bd6d79ff9dfcfc10965d351b06e7617931
BLAKE2b-256 checksum
How to use checksums
b9e67c7b02481932aaa579fb33b8f567b5735b9a1d1b8ba3895d5cbad6faeafc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

Release files / tqdl-0.0.4-py3-none-any.whl

Download URL tqdl-0.0.4-py3-none-any.whl
Size 4.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a385e300a0a02903b266c1b737486c9580cedafa6de9a0d686cb02de43a2e0a4
BLAKE2b-256 checksum
How to use checksums
a17275ef3450112c6f82ee80e58a1c7eafac2e355790f81c941f2ea9a775951b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 release files

0.0.3

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page