Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deepjyoti30/downloader-cli
A simple downloader written in Python with an awesome customizable progressbar.
https://github.com/deepjyoti30/downloader-cli
cli downloader progressbar python
Last synced: 2 days ago
JSON representation
A simple downloader written in Python with an awesome customizable progressbar.
- Host: GitHub
- URL: https://github.com/deepjyoti30/downloader-cli
- Owner: deepjyoti30
- License: mit
- Created: 2019-11-12T12:07:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T15:58:06.000Z (12 months ago)
- Last Synced: 2024-05-22T21:27:37.694Z (6 months ago)
- Topics: cli, downloader, progressbar, python
- Language: Python
- Homepage:
- Size: 370 KB
- Stars: 350
- Watchers: 12
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
downloader-cli
A simple downloader written in Python with an awesome progressbar.
Installation | Requirements | Usage | Use It | Other examples
[](https://www.python.org/)
[](LICENSE) [](https://img.shields.io/badge/dynamic/json?style=for-the-badge&maxAge=86400&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fdownloader-cli)   [](http://makeapullrequest.com)
# Installation
- [PyPI](#pypi)
- [Arch](#arch)
- [Gentoo](#gentoo)
- [Conda-Forge](#conda-forge)
- [Manual](#manual)
> NOTE: The following packages (except installing manually) will get you the latest release. If you want to try out the latest development stuff, install manually.
### PyPI
The package is available in PyPI [here](https://pypi.org/project/downloader-cli/)
Install it using
```sh
pip install downloader-cli
```
### Arch
The package is available in the AUR [here](https://aur.archlinux.org/packages/downloader-cli/)
Install it using `yay`
```console
yay -S downloader-cli
```
### Gentoo
The package is also available in src_prepare Gentoo overlay [here](https://gitlab.com/src_prepare/src_prepare-overlay/-/tree/master/net-misc/downloader-cli/)
First set up src_prepare-overlay
```sh
sudo emerge -anv --noreplace app-eselect/eselect-repository
sudo eselect repository enable src_prepare-overlay
sudo emaint sync -r src_prepare-overlay
```
Install it using
```sh
sudo emerge -anv --autounmask net-misc/downloader-cli
```
### Conda-Forge
Installing `downloader-cli` from the `conda-forge` channel can be achieved by adding `conda-forge` to your channels with:
```
conda config --add channels conda-forge
conda config --set channel_priority strict
```
Once the `conda-forge` channel has been enabled, `downloader-cli` can be installed with:
```
conda install downloader-cli
```
It is possible to list all of the versions of `downloader-cli` available on your platform with:
```
conda search downloader-cli --channel conda-forge
```
### Manual
If you want to manuall install, clone the repo and run the following command
```sh
sudo python setup.py install
```
# Requirements
**downloader-cli** requires just one external module.
- [urllib3](https://pypi.org/project/urllib3/)
# Usage
The script also allows some other values from the commandline.
```console
usage: dw [-h] [-f | -c] [-e] [-q] [-b] [-v] [--done DONE] [--left LEFT]
[--current CURRENT] [--color-done COLOR_DONE]
[--color-left COLOR_LEFT] [--color-current COLOR_CURRENT]
[--icon-border ICON_BORDER]
SOURCE [TARGET]
positional arguments:
SOURCE URL of the file
TARGET target filepath (existing directories will be treated
as the target location)
optional arguments:
-h, --help show this help message and exit
-f, -o, --force overwrite if the file already exists
-c, --resume resume failed or cancelled download (partial sanity
check)
-e, --echo print the filepath to stdout after downloading (other
output will be redirected to stderr)
-q, --quiet suppress filesize and progress info
-b, --batch Download files in batch. If this flag is passed the
passed source will be considered as a file with
download links seperated by a newline. This flag will
be ignored if source is a valid URL.
-v, --version show the program version number and exit
UI Group:
--done DONE Icon indicating the percentage done of the downloader
--left LEFT Icon indicating the percentage remaining to download
--current CURRENT Icon indicating the current percentage in the progress
bar
--color-done COLOR_DONE
Color for the done percentage icon
--color-left COLOR_LEFT
Color for the remaining percentage icon
--color-current COLOR_CURRENT
Color for the current indicator icon in the progress
bar
--icon-border ICON_BORDER
Icon for the border of the progress bar
```
# Use It
**Want to use it in your project?**
Import the `Download` class using the following.
```python
from downloader_cli.download import Download
Download(url).download()
```
Above is the simplest way to use it in your app. The other arguments are optional.
## Arguments
The module takes various arguments. Only **one** is required though.
| Name | required | default |
|------|----------|---------|
| URL/file | Yes | |
| des | No | None (Current directory is selected and the name is extracted from the URL)|
| overwrite| No | False |
| continue_download| No | False |
| echo | No | False |
| quiet | No | False |
| batch | No | False |
| icon_done| No | ▓ |
| icon_left| No | ░ |
| icon_current | No | ▓ |
| icon_border| No | \| (If a single char is passed, it will be used for both the right and left border. If a string of 2 chars are passed, 1st char will be used as left border and the 2nd as the right border) |
| color_done | No | blue |
| color_left | No | blue |
| color_current | No | blue |
> **NOTE** For details regarding the arguments, check [Usage](#usage)
> **NOTE** In case the file size is not available, the bar is shown as indefinite, in which case the icon_left
> by default space(`" "`).
# Other examples
### In case you want to experiment with the progress bar's icons, here's some examples.
- This is when I passed `icon_done` as `#` and `icon_left` as space.
- In case a file's size is not available from the server, the progressbar is indefinite.
