ensure_gunzip
- ensure_gunzip(key, *subkeys, url, name=None, force=False, autoclean=True, download_kwargs=None)[source]
Ensure a file is downloaded and gunzipped.
- Parameters:
key (
str
) – The name of the module. No funny characters. The envvar <key>_HOME where key is uppercased is checked first before using the default home directory.subkeys (
str
) – A sequence of additional strings to join. If none are given, returns the directory for this module.url (
str
) – The URL to download.name (
Optional
[str
]) – Overrides the name of the file at the end of the URL, if given. Also useful for URLs that don’t have proper filenames with extensions.force (
bool
) – Should the download be done again, even if the path already exists? Defaults to false.autoclean (
bool
) – Should the zipped file be deleted?download_kwargs (
Optional
[Mapping
[str
,Any
]]) – Keyword arguments to pass through topystow.utils.download()
.
- Return type:
- Returns:
The path of the directory where the file that has been downloaded gets extracted to