API Documentation¶
Extract all informations in Zippyshare url.
- Parameters
url (
str
) – Zippyshare url.download (
bool
) – Download given zippyshare url ifTrue
, default toTrue
.unzip (
bool
) – Unzip downloaded file once finished (if given file is zip or tar format extract it, otherwise ignore it), default toFalse
.**kwargs – These parameters will be passed to
File.download()
- Returns
Zippyshare file
- Return type
Download multiple zippyshare urls
- Parameters
*urls – Zippyshare urls.
zip (
str
) – Zip all downloaded files once finished. Zip filename will be taken fromzip
parameter, default toNone
. NOTE: You can’t mixzip
andunzip
options together with valueTrue
, it will raise error.unzip (
bool
) – Unzip all downloaded files once finished (if given file is zip format extract it, otherwise ignore it), default toFalse
. NOTE: You can’t mixzip
andunzip
options together with valueTrue
, it will raise error.**kwargs – These parameters will be passed to
File.download()
, except for parameterfilename
.
- Returns
a list of Zippyshare files
- Return type
List[
File
]
Extract all informations in Zippyshare url.
- Parameters
url (
str
) – Zippyshare url.download (
bool
) – Download given zippyshare url ifTrue
, default toTrue
.unzip (
bool
) – Unzip downloaded file once finished (if given file is zip or tar format extract it, otherwise ignore it), default toFalse
.**kwargs – These parameters will be passed to
File.download_coro()
- Returns
Zippyshare file
- Return type
“Coroutine Function”
Download multiple zippyshare urls
- Parameters
*urls (
str
) – Zippyshare urls.zip (
str
) – Zip all downloaded files once finished. Zip filename will be taken fromzip
, default toNone
. NOTE: You can’t mixzip
andunzip
options together with valueTrue
, it will raise error.unzip (
bool
) – Unzip all downloaded files once finished (if given file is zip format extract it, otherwise ignore it), default toFalse
. NOTE: You can’t mixzip
andunzip
options together with valueTrue
, it will raise error.**kwargs – These parameters will be passed to
File.download_coro()
, except for parameterfilename
.
- Returns
a list of Zippyshare files
- Return type
List[
File
]
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.
# 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 -
Return date that this file uploaded.
Download this file
- Parameters
- Returns
Zippyshare file downloaded
- Return type
Path
Same like
File.download()
but for asynchronous process- Parameters
progress_bar (
bool
) – Enable/Disable progress bar, default to Truereplace (
bool
) – Replace file if exist, default to Falsefolder (
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 toFalse
- Returns
Zippyshare file downloaded
- Return type
Path
Return downloadable url
Return name of the file
Return size of the file, in bytes.
Return all zippyshare informations in JSON
Return all zippyshare informations in dict