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)

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

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(), except for parameter filename.

Returns

a list of Zippyshare files

Return type

List[File]

class zippyshare_downloader.File(data)
property date_uploaded

Return date that this file uploaded.

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

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

Path

property download_url

Return downloadable url

property name

Return name of the file

property size

Return size of the file, in bytes.

to_JSON()

Return all zippyshare informations in JSON

to_dict()

Return all zippyshare informations in dict