Pooch Versions Save

Released on: 2024/02/19

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

Bug fixes:

• Use the ID instead of persistentID for Dataverse downloads since some repositories don't issue persistentIDs but all issue normal IDs (#355)
• Ensure all archive members are unpacked in subsequent uses of Untar/Unzip if the first call only asked for a few members (#365)

Documentation:

• Move "Projects using Pooch" further up the README (#386)
• Update the versions of sphinx and its plugins (#385)

Maintenance:

• Remove many deprecated pylint options (#329)
• Use Dependabot to manage GitHub Actions (#387)
• Simplify the test GitHub Actions workflow (#384)
• Update format for Black 24.1.1 (#383)

This release contains contributions from:

• Mark Harfouche
• Juan Nunez-Iglesias
• Santiago Soler
• Leonardo Uieda

Released on: 2023/10/24

doi: 10.5281/zenodo.10037888

Bug fixes:

• Fix bug: add support for old and new Zenodo APIs (#375)

New features:

• Only create local data directories if necessary (#370)
• Speed up import time by lazy loading requests (#328)

Maintenance:

• Add support for Python 3.11 (#348)
• Only run CI cron job for the upstream repository (#361)

Documentation:

• Add GemGIS to list of projects using Pooch (#349)
• Fix spelling of Dataverse (#353)
• Fix grammar on retrieve documentation (#359)

This release contains contributions from:

• Hugo van Kemenade
• AlexanderJuestel
• Mark Harfouche
• Philip Durbin
• Rob Luke
• Santiago Soler
• Stephan Hoyer

Released on: 2023/02/27

doi: 10.5281/zenodo.7678844

Bug fixes:

• Make archive extraction always take members into account (#316)
• Figshare downloaders fetch the correct version, instead of always the latest one. (#343)

New features:

• Allow spaces in filenames in registry files (#315)
• Refactor Pooch.is_available to use downloaders (#322)
• Add support for downloading files from Dataverse DOIs (#318)
• Add a new Pooch.load_registry_from_doi method that populates the Pooch registry using DOI-based data repositories (#325)
• Support urls for Zenodo repositories created through the GitHub integration service, which include slashes in the filename of the main zip files (#340)
• Automatically add a trailing slash to base_url on pooch.create (#344)

Maintenance:

• Drop support for Python 3.6 (#299)
• Port from deprecated appdirs to platformdirs (#339)
• Update version of Codecov's Action to v3 (#345)

Documentation:

• Update sphinx, theme, and sphinx-panels (#300)
• Add CITATION.cff for the JOSS article (#308)
• Use Markdown for the README (#311)
• Improve docstring of known_hash in retrieve function (#333)
• Replace link to Pooch's citation with a BibTeX code snippet (#335)

Projects that started using Pooch:

• Open AR-Sandbox (#305)
• climlab (#312)
• SciPy (#320)
• napari (#321)
• mne-python (#323)

This release contains contributions from:

• Alex Fikl
• Anirudh Dagar
• Björn Ludwig
• Brian Rose
• Dominic Kempf
• Florian Wellmann
• Gabriel Fu
• Kyle I S Harrington
• Leonardo Uieda
• myd7349
• Rowan Cockett
• Santiago Soler

Released on: 2022/01/24

doi: 10.5281/zenodo.5793074

Important:

• This is the last release with support for Python 3.6. The next major/minor release of Pooch will require Python >= 3.7.
• Pooch now specifies version bounds for our required dependencies and a plan for dropping support for older versions. Please revise it if you depend on Pooch.

Enhancements:

• Add option to disable updates on hash mismatch (#291 and #292)
• Allow enabling progress bars with an argument in Pooch.fetch and retrieve (#277)

Documentation:

• Use real data URLs in the README example code (#295)
• Tell users to import from the top-level namespace (#288)
• Update the contact link to fatiando.org/contact (#282)
• Refer the community guides to fatiando/community (#281)
• Mention in docs that figshare collections aren't supported (#275)

Maintenance:

• Replace Google Analytics for Plausible to make our docs more privacy-friendly (#293)
• Use Dependente to capture dependencies on CI (#289)
• Use build instead of setup.py (#287)
• Run the tests weekly on GitHub Actions (#286)
• Set minimum required version of dependencies (#280)
• Rename "master" to "main" throughout the project (#278)
• Remove trailing slash from GitHub handle in AUTHORS.md (#279)

This release contains contributions from:

• Santiago Soler
• Genevieve Buckley
• Ryan Abernathey
• Ryan May
• Leonardo Uieda

Released on: 2021/10/11

doi:10.5281/zenodo.5560923

Bug fixes:

• Fix bug when unpacking an entire subfolder from an archive. Now both unpacking processors (Untar and Unzip) handle members that are folders (not files) correctly. (#266)

Enhancements:

• Add support for Python 3.10 (#260)
• Point to the user's code for the file_hash warning instead of our internal code (which isn't very useful) (#259)

Documentation:

• Fix typo in a variable name of the examples in the documentation (#268)
• Fix typo when specifying the SFTP protocol in the about page (#267)

Maintenance:

• Remove old testing checks if running on TravisCI (#265)

This release contains contributions from:

• Santiago Soler
• Hugo van Kemenade
• Mark Harfouche
• Leonardo Uieda

Released on: 2021/08/24

doi: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)
• Use a mirror of the test data directory in tests that write to it. (#255)
• Add a pytest mark for tests accessing the network so that they can easily excluded when testing offline. (#254)

This release contains contributions from:

• Antonio Valentino
• Leonardo Uieda

Released on: 2021/08/23

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

Maintenance:

• Move hash functions to their own private module. No changes to the public API. (#244)
• Run CI jobs on Python version extremes instead of all supported versions (#243)

This release contains contributions from:

• Mark Harfouche
• Leonardo Uieda

Released on: 2021/06/08

Bug fixes:

• Fix bug in Untar and Unzip when the archive contains subfolders (#224)

Documentation:

• New theme (sphinx-book-theme) and layout of the documentation (#236 #237 #238)

Enhancements:

• Add support for non-tqdm progress bars on HTTPDownloader (#228)
• Allow custom unpack locations in Untar and Unzip (#224)

Maintenance:

• Replace versioneer with setuptools-scm (#235)
• Automatically check license notice on code files (#231)
• Don't store documentation HTML as CI build artifacts (#221)

This release contains contributions from:

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

Released on: 2020/11/27

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)

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

Documentation:

• Add seaborn-image to list of packages using Pooch (#218)

Maintenance:

• Add support for Python 3.9. (#220)
• Drop support for Python 3.5. (#204)
• Use pip instead of conda to speed up Actions (#216)
• Add license and copyright notice to every .py file (#213)

This release contains contributions from:

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

Released on: 2020/09/10

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)

New features:

• Add the SFTPDownloader class for secure FTP downloads (#165)
• Expose Pooch version as pooch.__version__ (#179)
• Allow line comments in registry files with # (#180)

Enhancements:

• Point to Unzip/tar from Decompress docs and errors (#200)

Documentation:

• Re-factor the documentation into separate pages (#202)
• Add warning to the docs about dropping Python 3.5 (#201)
• Add histolab to the Pooch-powered projects (#189)

Maintenance:

• Push documentation to GitHub Pages using Actions (#198)
• Add GitHub Actions workflow for publishing to PyPI (#196)
• Set up GitHub Actions for testing and linting (#194)
• Test FTP downloads using a local test server (#192)

This release contains contributions from:

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