Pooch

*Released on: 2021/08/23*

[](https://doi.org/10.5281/zenodo.5235242)

New features:

- Add support for non-cryptographic hashes from the xxhash package. They aren\'t as safe (but safe enough) and compute in fractions of the time from SHA or MD5. This makes it feasible to use hash checking on large datasets. ([242](https://github.com/fatiando/pooch/pull/242))
- Add support for using figshare and Zenodo DOIs as URLs (with the protocol `doi:{DOI}/{file name}`, which works out-of-the-box with `Pooch.fetch` and `retrieve`). Can only download 1 file from the archive (not the full archive) and the file name must be specified in the URL. ([241](https://github.com/fatiando/pooch/pull/241))

Maintenance:

- Move hash functions to their own private module. No changes to the public API. ([244](https://github.com/fatiando/pooch/pull/244))
- Run CI jobs on Python version extremes instead of all supported versions ([243](https://github.com/fatiando/pooch/pull/243))

This release contains contributions from:

- Mark Harfouche
- Leonardo Uieda

*Released on: 2021/06/08*

[](https://doi.org/10.5281/zenodo.4914758)

Bug fixes:

- Fix bug in `Untar` and `Unzip` when the archive contains subfolders ([\224](https://github.com/fatiando/pooch/pull/224))

Documentation:

- New theme (`sphinx-book-theme`) and layout of the documentation ([\236](https://github.com/fatiando/pooch/pull/236) [\#237](https://github.com/fatiando/pooch/pull/237) [\#238](https://github.com/fatiando/pooch/pull/238))

Enhancements:

- Add support for non-tqdm progress bars on HTTPDownloader ([\228](https://github.com/fatiando/pooch/pull/228))
- Allow custom unpack locations in `Untar` and `Unzip` ([\224](https://github.com/fatiando/pooch/pull/224))

Maintenance:

- Replace versioneer with setuptools-scm ([\235](https://github.com/fatiando/pooch/pull/235))
- Automatically check license notice on code files ([\231](https://github.com/fatiando/pooch/pull/231))
- Don't store documentation HTML as CI build artifacts ([\221](https://github.com/fatiando/pooch/pull/221))

This release contains contributions from:

- Leonardo Uieda
- Agustina Pesce
- Clément Robert
- Daniel McCloy

*Released on: 2020/11/27*

[](https://doi.org/10.5281/zenodo.4293216)

Bug fixes:

- Properly handle capitalized hashes. On Windows, users might sometimes get capitalized hashes from the system. To avoid false hash mismatches, convert stored and computed hashes to lowercase before doing comparisons. Convert hashes to lowercase when reading from the registry to make sure stored hashes are always lowercase. ([\214](https://github.com/fatiando/pooch/pull/214))

New features:

- Add option to retry downloads if they fail. The new `retry_if_failed` option to `pooch.create` and `pooch.Pooch` allows retrying the download the specified number of times in case of failures due to hash mismatches (coming from Pooch) or network issues (coming from `requests`). This is useful for running downloads on CI that tend to fail sporadically. Waits a period of time between consecutive downloads starting with 1s and increasing up to 10s in 1s increments. ([\215](https://github.com/fatiando/pooch/pull/215))
- Allow user defined decompressed file names. Introduce new `name` argument to `pooch.Decompress` to allow user defined file names. Defaults to the previous naming convention for backward compatibility. ([\203](https://github.com/fatiando/pooch/pull/203))

Documentation:

- Add seaborn-image to list of packages using Pooch ([\218](https://github.com/fatiando/pooch/pull/218))

Maintenance:

- Add support for Python 3.9. ([\220](https://github.com/fatiando/pooch/pull/220))
- Drop support for Python 3.5. ([\204](https://github.com/fatiando/pooch/pull/204))
- Use pip instead of conda to speed up Actions ([\216](https://github.com/fatiando/pooch/pull/216))
- Add license and copyright notice to every .py file ([\213](https://github.com/fatiando/pooch/pull/213))

This release contains contributions from:

- Leonardo Uieda
- Danilo Horta
- Hugo van Kemenade
- SarthakJariwala

*Released on: 2020/09/10*

[](https://doi.org/10.5281/zenodo.4022246)

Bug fixes:

- Fix FTP availability check when the file is in a directory. If the data file is not in the base directory, the `Pooch.is_available` test was broken since we were checking for the full path in `ftp.nlst` instead of just the file name. ([\191](https://github.com/fatiando/pooch/pull/191))

New features:

- Add the SFTPDownloader class for secure FTP downloads ([\165](https://github.com/fatiando/pooch/pull/165))
- Expose Pooch version as `pooch.__version__` ([\179](https://github.com/fatiando/pooch/pull/179))
- Allow line comments in registry files with `` ([\180](https://github.com/fatiando/pooch/pull/180))

Enhancements:

- Point to Unzip/tar from Decompress docs and errors ([\200](https://github.com/fatiando/pooch/pull/200))

Documentation:

- Re-factor the documentation into separate pages ([\202](https://github.com/fatiando/pooch/pull/202))
- Add warning to the docs about dropping Python 3.5 ([\201](https://github.com/fatiando/pooch/pull/201))
- Add [histolab](https://github.com/histolab/histolab) to the Pooch-powered projects ([\#189](https://github.com/fatiando/pooch/pull/189))

Maintenance:

- Push documentation to GitHub Pages using Actions ([\198](https://github.com/fatiando/pooch/pull/198))
- Add GitHub Actions workflow for publishing to PyPI ([\196](https://github.com/fatiando/pooch/pull/196))
- Set up GitHub Actions for testing and linting ([\194](https://github.com/fatiando/pooch/pull/194))
- Test FTP downloads using a local test server ([\192](https://github.com/fatiando/pooch/pull/192))

This release contains contributions from:

- Leonardo Uieda
- Hugo van Kemenade
- Alessia Marcolini
- Luke Gregor
- Mathias Hauser

Bug fixes:

- Delay data cache folder creation until the first download is attempted. As seen in [recent issues in scikit-image](https://github.com/scikit-image/scikit-image/issues/4719), creating the data folder in `pooch.create` can cause problems since this function is called at import time. This means that importing the package in parallel can cause race conditions and crashes. To prevent that from happening, delay the creation of the cache folder until `Pooch.fetch` or `retrieve` are called. ([\#173](https://github.com/fatiando/pooch/pull/173))
- Allow the data folder to already exist when creating it. This is can help cope with parallel execution as well. ([\171](https://github.com/fatiando/pooch/pull/171))

Documentation:

- Added scikit-image to list of Pooch users. ([\168](https://github.com/fatiando/pooch/pull/168))
- Fix typo in README and front page contributing section. ([\166](https://github.com/fatiando/pooch/pull/166))

This release contains contributions from:

- Leonardo Uieda
- Egor Panfilov
- Rowan Cockett

[](https://doi.org/10.5281/zenodo.3747184)

New features:

- New function `pooch.retrieve` to fetch single files This is much more convenient than setting up a `Pooch` while retaining the hash checks and use of downloaders and processors. It automatically selects a unique file name and saves files to a cache folder. ([\152](https://github.com/fatiando/pooch/pull/152))
- Allow to use of different hashing algorithms (other than SHA256). Optionally specify the hash as `alg:hash` and allow `pooch.Pooch` to recognize the algorithm when comparing hashes. Setting an algorithsm is optional and omiting it defaults to SHA256. This is particularly useful when data are coming from external sources and published hashes are already available. ([\133](https://github.com/fatiando/pooch/pull/133))

Documentation:

- Add example for fetching datasets that change on the server, for which the hash check would always fail. ([\144](https://github.com/fatiando/pooch/pull/144))
- Fix path examples in docstring of `pooch.os_cache`. The docstring mentioned the data path as examples instead of the cache path. ([\140](https://github.com/fatiando/pooch/pull/140))
- Add example of creating a registry when you don\'t have the data files locally and would have to download them manually. The example uses the `pooch.retrieve` function to automate the process. The example covers two cases: when all remote files share the same base URL and when every file has its own URL. ([\161](https://github.com/fatiando/pooch/pull/161))

Maintenance:

- A lot of general refactoring of the internals of Pooch to facilitate development of the new `pooch.retrieve` function ([\159](https://github.com/fatiando/pooch/pull/159) [\#157](https://github.com/fatiando/pooch/pull/157) [\#156](https://github.com/fatiando/pooch/pull/156) [\#151](https://github.com/fatiando/pooch/pull/151) [\#149](https://github.com/fatiando/pooch/pull/149))

This release contains contributions from:

- Leonardo Uieda
- Santiago Soler
- Kacper Kowalik
- Lucas Martin-King
- Zac Flamig