API Documentation

zippyshare_downloader.extract_info(url, download=True, unzip=False, **kwargs)

Extract all informations in Zippyshare url.

Parameters

  • url (str) – Zippyshare url.

  • download (bool) – Download given zippyshare url if True, default to True.

  • unzip (bool) – Unzip downloaded file once finished (if given file is zip or tar format extract it, otherwise ignore it), default to False.

  • **kwargs – These parameters will be passed to File.download()

Returns

Zippyshare file

Return type

File

zippyshare_downloader.download(*urls, zip=None, unzip=False, **kwargs)

Download multiple zippyshare urls

Parameters

  • *urls – Zippyshare urls.

  • zip (str) – Zip all downloaded files once finished. Zip filename will be taken from zip parameter, default to None. NOTE: You can’t mix zip and unzip options together with value True, it will raise error.

  • unzip (bool) – Unzip all downloaded files once finished (if given file is zip format extract it, otherwise ignore it), default to False. NOTE: You can’t mix zip and unzip options together with value True, it will raise error.

  • **kwargs – These parameters will be passed to File.download(), except for parameter filename.

Returns

a list of Zippyshare files

Return type

List[File]

async zippyshare_downloader.extract_info_coro(url, download=True, unzip=False, **kwargs)

“Coroutine Function”

Extract all informations in Zippyshare url.

Parameters

  • url (str) – Zippyshare url.

  • download (bool) – Download given zippyshare url if True, default to True.

  • unzip (bool) – Unzip downloaded file once finished (if given file is zip or tar format extract it, otherwise ignore it), default to False.

  • **kwargs – These parameters will be passed to File.download_coro()

Returns

Zippyshare file

Return type

File

async zippyshare_downloader.download_coro(*urls, zip=None, unzip=False, **kwargs)

“Coroutine Function”

Download multiple zippyshare urls

Parameters

  • *urls (str) – Zippyshare urls.

  • zip (str) – Zip all downloaded files once finished. Zip filename will be taken from zip, default to None. NOTE: You can’t mix zip and unzip options together with value True, it will raise error.

  • unzip (bool) – Unzip all downloaded files once finished (if given file is zip format extract it, otherwise ignore it), default to False. NOTE: You can’t mix zip and unzip options together with value True, it will raise error.

  • **kwargs – These parameters will be passed to File.download_coro(), except for parameter filename.

Returns

a list of Zippyshare files

Return type

List[File]

zippyshare_downloader.download_stdout(url)

Extract zippyshare download url and then download its content to stdout

Warning

This will print all its content to stdout, if you are not intend to use this for piping the content to media player (like vlc), then DO NOT DO THIS.

Example usage (Command-line)

# Let's say you want watching videos with vlc from zippyshare
# this can be done with piping the stdout from zippyshare-dl
$ zippyshare-dl "insert zippyshare url here" -pipe | vlc -

# or (for Linux / Mac OS)
$ python3 -m zippyshare_downloader "insert zippyshare url here" -pipe | vlc -

# or (for Windows)
$ py -3 -m zippyshar_downloader "insert zippyshare url here" -pipe | vlc -
class zippyshare_downloader.File(data)
property date_uploaded

Return date that this file uploaded.

Type

datetime.datetime

property date_uploaded_fmt

Return formatted date that this file uploaded.

Type

str

download(progress_bar=True, replace=False, folder=None, filename=None)

Download this file

Parameters

  • progress_bar (bool) – Enable/Disable progress bar, default to True

  • replace (bool) – Replace file if exist, default to False

  • folder (str) – Set a folder where to store downloaded file, default to None.

  • filename (str) – Set a replacement filename, default to None.

Returns

Zippyshare file downloaded

Return type

pathlib.Path

async download_coro(progress_bar=True, replace=False, folder=None, filename=None, fast=False)

Same like File.download() but for asynchronous process

Parameters

  • progress_bar (bool) – Enable/Disable progress bar, default to True

  • replace (bool) – Replace file if exist, default to False

  • folder (str) – Set a folder where to store downloaded file, default to None.

  • filename (str) – Set a replacement filename, default to None.

  • fast (bool) – Enable Fast download, default to False

Returns

Zippyshare file downloaded

Return type

pathlib.Path

property download_url

Return downloadable url

Type

download_url

property name

Return name of the file

Type

str

property size

Return size of the file, in bytes.

Type

float

property size_fmt

Return formatted size of the file

Type

str

to_JSON()

Return all zippyshare informations in JSON

to_dict()

Return all zippyshare informations in dict

property url

Return origin url

Type

str