Pooch

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

Released on: 2020/04/13

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

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

Released on: 2020/01/28

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

This release marks the stabilization of the Pooch API. Further changes to the
1.* line will be fully backwards compatible (meaning that updating Pooch should
not break existing code). If there is great need to make backwards incompatible
changes, we will release a 2.* line. In that case, bug fixes will still be
ported to the 1.* line for a period of time.

Improvements:

* Allow blank lines in registry files. Previously, they would cause an error.
(`138 <https://github.com/fatiando/pooch/pull/138>`__)

**Backwards incompatible changes**:

* Using Python's ``logging`` module to instead of ``warnings`` to inform users
of download, update, and decompression/unpacking actions. This allows
messages to be logged with different priorities and the user filter out log
messages or silence Pooch entirely. Introduces the function
``pooch.get_logger`` to access the ``logging`` object used by Pooch. **Users
who relied on Pooch issuing warnings will need to update to capturing logs
instead.** All other parts of the API remain unchanged.
(`115 <https://github.com/fatiando/pooch/pull/115>`__)

This release contains contributions from:

* Daniel Shapero

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

Released on: 2020/01/17

🚨 **Announcement:** 🚨
We now have a `JOSS paper about Pooch <https://doi.org/10.21105/joss.01943>`__!
Please :ref:`cite it <citing>` when you use Pooch for your research.
(`116 <https://github.com/fatiando/pooch/pull/116>`__ with reviews in
`132 <https://github.com/fatiando/pooch/pull/132>`__ and
`134 <https://github.com/fatiando/pooch/pull/134>`__)

This is minor release which only updates the citation information to
the new JOSS paper. No DOI was issued for this release since there are
no code or documentation changes.

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

Released on: 2020/01/17

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

Improvements:

* Better error messages when hashes don't match. Include the file name in the
exception for a hash mismatch between a downloaded file and the registry.
Before, we included the name of temporary file, which wasn't very
informative.
(`128 <https://github.com/fatiando/pooch/pull/128>`__)
* Better error message for malformed registry files. When loading a registry
file, inform the name of the file and include the offending content in the
error message instead of just the line number.
(`129 <https://github.com/fatiando/pooch/pull/129>`__)

Maintenance:

* Change development status flag in ``setup.py`` to "stable" instead of
"alpha".
(`127 <https://github.com/fatiando/pooch/pull/127>`__)

This release was reviewed at the `Journal of Open Source Software
<https://github.com/openjournals/joss-reviews/issues/1943>`__. The code and
software paper contain contributions from:

* Anderson Banihirwe
* Martin Durant
* Mark Harfouche
* Hugo van Kemenade
* John Leeman
* Rémi Rampin
* Daniel Shapero
* Santiago Rubén Soler
* Matthew Turk
* Leonardo Uieda

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

Released on: 2019/11/19

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

New features:

* New ``pooch.FTPDownloader`` class for downloading files over FTP. Uses the
standard library ``ftplib``. The appropriate downloader is automatically
selected by ``pooch.Pooch.fetch`` based on the URL (for anonymous FTP only),
so no configuration is required.
If authentication is required, ``pooch.FTPDownloader`` provides the need
support. Ported from
`NCAR/aletheia-data <https://github.com/NCAR/aletheia-data>`__ by the author.
(`118 <https://github.com/fatiando/pooch/pull/118>`__)
* Support for file-like objects to ``Pooch.load_registry`` (opened either in
binary or text mode).
(`117 <https://github.com/fatiando/pooch/pull/117>`__)

Maintenance:

* Testing and official support for Python 3.8.
(`113 <https://github.com/fatiando/pooch/pull/113>`__)
* 🚨 **Drop support for Python 2.7.** 🚨 Remove conditional dependencies and CI
jobs.
(`100 <https://github.com/fatiando/pooch/pull/100>`__)

Documentation:

* In the tutorial, use ``pkg_resources.resource_stream()`` from setuptools to
load the ``registry.txt`` file. It's less error-prone than using ``os.path``
and ``__file__`` and allows the package to work from zip files.
(`120 <https://github.com/fatiando/pooch/pull/120>`__)
* Docstrings formatted to 79 characters (instead of 88) for better rendering in
Jupyter notebooks and IPython. These displays are limited to 80 chars so the
longer lines made the docstring unreadable.
(`123 <https://github.com/fatiando/pooch/pull/123>`__)

This release contains contributions from:

* Anderson Banihirwe
* Hugo van Kemenade
* Remi Rampin
* Leonardo Uieda

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

Released on: 2019/10/22

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

🚨 **Pooch v0.6.0 is the last release to support Python 2.7** 🚨

New features:

* Add optional download progress bar to ``pooch.HTTPDownloader``
(`97 <https://github.com/fatiando/pooch/pull/97>`__)

Maintenance:

* Warn that 0.6.0 is the last version to support Python 2.7
(`108 <https://github.com/fatiando/pooch/pull/108>`__)

Documentation:

* Update contact information to point to our Slack channel
(`107 <https://github.com/fatiando/pooch/pull/107>`__)
* Add icepack to list of projects using Pooch
(`98 <https://github.com/fatiando/pooch/pull/98>`__)

This release contains contributions from:

* Daniel Shapero
* Leonardo Uieda