Changelog

Version 0.7.0

Released on: 2019/11/19

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

Version 0.6.0

Released on: 2019/10/22

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

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

Version 0.5.2

Released on: 2019/06/24

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

Version 0.5.1

Released on: 2019/05/21

Documentation fixes:

• Fix formatting error in pooch.Decompress docstring. (#81)

• Fix wrong imports in the usage guide for post-processing hooks. (#84)

• Add section to the usage guide explaining when to use pooch.Decompress. (#85)

This release contains contributions from:

• Santiago Soler

• Leonardo Uieda

Version 0.5.0

Released on: 2019/05/20

New features:

• New processor pooch.Decompress saves a decompressed version of the downloaded file. Supports gzip, lzma/xz, and bzip2 compression. Note: Under Python 2.7, lzma and bzip2 require the backports.lzma and bz2file packages as well. These are soft dependencies and not required to use Pooch. See Installing. (#78)

• New processor pooch.Untar unpacks files contained in a downloaded tar archive (with or without compression). (#77)

This release contains contributions from:

• Matthew Turk

• Leonardo Uieda

Version 0.4.0

Released on: 2019/05/01

New features:

• Add customizable downloaders. Delegate file download into separate classes that can be passed to Pooch.fetch. Created the HTTPDownloader class (used by default) which can also be used to download files that require authentication/login. (#66)

• Add post-download processor hooks to Pooch.fetch. Allows users to pass in a function that is executed right before returning and can overwrite the file path that is returned by fetch. Use this, for example, to perform unpacking/decompression operations on larger files that can be time consuming and we only want to do once. (#59)

• Add the Unzip post-download processor to extract files from a downloaded zip archive. Unpacks files into a directory in the local store and returns a list of all unzipped files. (#72)

• Make the check_version function public. It’s used internally but will be useful in examples that want to download things from the pooch repository. (#69)

Maintenance:

• Pin sphinx to version 1.8.5. New versions of Sphinx (2.0.*) are messing up the numpydoc style docstrings. (#64)

This release contains contributions from:

• Santiago Soler

• Leonardo Uieda

Version 0.3.1

Released on: 2019/03/28

Minor patches:

• Add a project logo (#57)

• Replace http with https in the README.rst to avoid mixed content warnings in some browsers (#56)

Version 0.3.0

Released on: 2019/03/27

New features:

• Use the appdirs library to get the cache directory. Could change the default data location on all platforms. Locations are compatible with the XDG Base Directory Specification (#45)

• Add method Pooch.is_available to check remote file availability (#50)

• Add Pooch.registry_files property to get a name of all files in the registry (#42)

• Make Pooch.get_url a public method to get the download URL for a given file (#55)

Maintenance:

• Drop support for Python 3.5. Pooch now requires Python >= 3.6. (#52)

• Add a private method to check if a file is in the registry (#49)

• Fix typo in the Pooch.load_registry docstring (#41)

This release contains contributions from:

• Santiago Soler

• Rémi Rampin

• Leonardo Uieda

Version 0.2.1

Released on: 2018/11/15

Bug fixes:

• Fix unwanted ~ directory creation when not using a version in pooch.create (#37)

Version 0.2.0

Released on: 2018/10/31

Bug fixes:

• Avoid copying of files across the file system (#33)

• Correctly delete temporary downloads on error (#32)

New features:

• Allow custom download URLs for individual files (#30)

• Allow dataset versioning to be optional (#29)

Maintenance:

• Move URLs building to a dedicated method for easy subclassing (#31)

• Add testing and support for Python 3.7 (#25)

Version 0.1.1

Released on: 2018/08/30

Bug fixes:

• Check if the local data folder is writable and warn the user instead of crashing (#23)

Version 0.1

Released on: 2018/08/20

• Fist release of Pooch. Manages downloading sample data files over HTTP from a server and storing them in a local directory. Main features:

  • Download a file only if it’s not in the local storage.

  • Check the SHA256 hash to make sure the file is not corrupted or needs updating.

  • If the hash is different from the registry, Pooch will download a new version of the file.

  • If the hash still doesn’t match, Pooch will raise an exception warning of possible data corruption.