Pooch

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)

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)

This release contains contributions from:

* Daniel Shapero

🚨 Announcement: 🚨 We now have a [JOSS paper about Pooch](https://doi.org/10.21105/joss.01943)! Please cite it when you use Pooch for your research. (#116 with reviews in 132 and 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.

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)
* 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)

Maintenance:

* Change development status flag in `setup.py` to "stable" instead of "alpha". (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

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 by the author. (118)
* Support for file-like objects to Pooch.load_registry (opened either in binary or text mode). (117)

Maintenance:

* Testing and official support for Python 3.8. (113)
* 🚨 **Drop support for Python 2.7.** 🚨 Remove conditional dependencies and CI jobs. (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)
* 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)

This release contains contributions from:

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

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

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

New features:

* Add optional download progress bar to pooch.HTTPDownloader (97)

Maintenance:

* Warn that 0.6.0 is the last version to support Python 2.7 (108)

Documentation:

* Update contact information to point to our Slack channel (107)
* Add icepack to list of projects using Pooch (98)

This release contains contributions from:

* Daniel Shapero
* Leonardo Uieda

Maintenance:

* Add back support for Python 3.5 with continuous integration tests. No code changes were needed, only removing the restriction from `setup.py`. (93)

This release contains contributions from:

* Leonardo Uieda