Pooch

-------------

Released on: 2021/08/24

DOI: https://doi.org/10.5281/zenodo.5242882

.. warning::

**Please use** ``from pooch import file_hash`` **instead of** ``from
pooch.utils import file_hash``. This is backwards compatible with all
previous versions of Pooch. We recommend importing all functions and
classes from the top-level namespace.

Bug fixes:

* Make ``file_hash`` accessible from the ``pooch.utils`` module again. Moving
this function to ``pooch.hashes`` caused crashes downstream. To prevent these
crashes, add a wrapper back to utils that issues a warning that users should
import from the top-level namespace instead.
(`257 <https://github.com/fatiando/pooch/pull/257>`__)
* Use a mirror of the test data directory in tests that write to it.
(`255 <https://github.com/fatiando/pooch/pull/255>`__)
* Add a pytest mark for tests accessing the network so that they can easily
excluded when testing offline. (`254 <https://github.com/fatiando/pooch/pull/254>`__)

This release contains contributions from:

* Antonio Valentino
* Leonardo Uieda

-------------

Released on: 2021/08/23

DOI: 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

DOI: 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

DOI: 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

DOI: https://doi.org/10.5281/zenodo.4022246

.. warning::

**Pooch v1.2.0 is the last release that is compatible with Python 3.5.**

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

-------------

Released on: 2020/05/14

DOI: https://doi.org/10.5281/zenodo.3826458

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