Pooch

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

Released on: 2024/06/06

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

Bug fixes:

* Use a variable to set the default request timeout (`418 <https://github.com/fatiando/pooch/pull/418>`__)

Documentation:

* Add HyperSpy, RosettaSciIO, eXSpy to projects using pooch (`408 <https://github.com/fatiando/pooch/pull/408>`__)
* Add more packages using Pooch (`403 <https://github.com/fatiando/pooch/pull/403>`__)

Maintenance:

* Add optional dependencies to environment.yml (`413 <https://github.com/fatiando/pooch/pull/413>`__)
* Run tests with oldest dependencies on x86 macos (`414 <https://github.com/fatiando/pooch/pull/414>`__)
* Mark additional tests requiring network (`412 <https://github.com/fatiando/pooch/pull/412>`__)
* Fix package description in pyproject.toml (`407 <https://github.com/fatiando/pooch/pull/407>`__)
* Setup Trusted Publisher deployment to PyPI (`406 <https://github.com/fatiando/pooch/pull/406>`__)
* Use Burocrata to check and add license notices (`402 <https://github.com/fatiando/pooch/pull/402>`__)
* Use pyproject.toml instead of setup.cfg (`401 <https://github.com/fatiando/pooch/pull/401>`__)

This release contains contributions from:

* Sandro
* Jonas Lähnemann
* Santiago Soler
* Leonardo Uieda

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

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 <https://github.com/fatiando/pooch/pull/355>`__)
* Ensure all archive members are unpacked in subsequent uses of ``Untar``/``Unzip`` if the first call only asked for a few members (`365 <https://github.com/fatiando/pooch/pull/365>`__)

Documentation:

* Move "Projects using Pooch" further up the README (`386 <https://github.com/fatiando/pooch/pull/386>`__)
* Update the versions of sphinx and its plugins (`385 <https://github.com/fatiando/pooch/pull/385>`__)

Maintenance:

* Remove many deprecated pylint options (`329 <https://github.com/fatiando/pooch/pull/329>`__)
* Use Dependabot to manage GitHub Actions (`387 <https://github.com/fatiando/pooch/pull/387>`__)
* Simplify the test GitHub Actions workflow (`384 <https://github.com/fatiando/pooch/pull/384>`__)
* Update format for Black 24.1.1 (`383 <https://github.com/fatiando/pooch/pull/383>`__)

This release contains contributions from:

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

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

Released on: 2023/10/24

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

Bug fixes:

* Fix bug: add support for old and new Zenodo APIs (`375 <https://github.com/fatiando/pooch/pull/375>`__)

New features:

* Only create local data directories if necessary (`370 <https://github.com/fatiando/pooch/pull/370>`__)
* Speed up import time by lazy loading requests (`328 <https://github.com/fatiando/pooch/pull/328>`__)

Maintenance:

* Add support for Python 3.11 (`348 <https://github.com/fatiando/pooch/pull/348>`__)
* Only run CI cron job for the upstream repository (`361 <https://github.com/fatiando/pooch/pull/361>`__)

Documentation:

* Add GemGIS to list of projects using Pooch (`349 <https://github.com/fatiando/pooch/pull/349>`__)
* Fix spelling of Dataverse (`353 <https://github.com/fatiando/pooch/pull/353>`__)
* Fix grammar on retrieve documentation (`359 <https://github.com/fatiando/pooch/pull/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: https://doi.org/10.5281/zenodo.7678844

Bug fixes:

* Make archive extraction always take members into account (`316 <https://github.com/fatiando/pooch/pull/316>`__)
* Figshare downloaders fetch the correct version, instead of always the latest one. (`343 <https://github.com/fatiando/pooch/pull/343>`__)

New features:

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

Maintenance:

* Drop support for Python 3.6 (`299 <https://github.com/fatiando/pooch/pull/299>`__)
* Port from deprecated ``appdirs`` to ``platformdirs`` (`339 <https://github.com/fatiando/pooch/pull/339>`__)
* Update version of Codecov's Action to v3 (`345 <https://github.com/fatiando/pooch/pull/345>`__)

Documentation:

* Update sphinx, theme, and sphinx-panels (`300 <https://github.com/fatiando/pooch/pull/300>`__)
* Add CITATION.cff for the JOSS article (`308 <https://github.com/fatiando/pooch/pull/308>`__)
* Use Markdown for the README (`311 <https://github.com/fatiando/pooch/pull/311>`__)
* Improve docstring of `known_hash` in `retrieve` function (`333 <https://github.com/fatiando/pooch/pull/333>`__)
* Replace link to Pooch's citation with a BibTeX code snippet (`335 <https://github.com/fatiando/pooch/pull/335>`__)

Projects that started using Pooch:

* Open AR-Sandbox (`305 <https://github.com/fatiando/pooch/pull/305>`__)
* ``climlab`` (`312 <https://github.com/fatiando/pooch/pull/312>`__)
* SciPy (`320 <https://github.com/fatiando/pooch/pull/320>`__)
* ``napari`` (`321 <https://github.com/fatiando/pooch/pull/321>`__)
* ``mne-python`` (`323 <https://github.com/fatiando/pooch/pull/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: https://doi.org/10.5281/zenodo.5793074

.. warning::

**Pooch v1.6.0 is the last release that is compatible with Python 3.6.**

Important notes:

* 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 <https://github.com/fatiando/pooch/pull/291>`__ and `#292 <https://github.com/fatiando/pooch/pull/292>`__)
* Allow enabling progress bars with an argument in ``Pooch.fetch`` and ``retrieve`` (`277 <https://github.com/fatiando/pooch/pull/277>`__)

Documentation:

* Use real data URLs in the README example code (`295 <https://github.com/fatiando/pooch/pull/295>`__)
* Tell users to import from the top-level namespace (`288 <https://github.com/fatiando/pooch/pull/288>`__)
* Update the contact link to `fatiando.org/contact <https://www.fatiando.org/contact/>`__ (`#282 <https://github.com/fatiando/pooch/pull/282>`__)
* Refer the community guides to `fatiando/community <https://github.com/fatiando/community>`__ (`#281 <https://github.com/fatiando/pooch/pull/281>`__)
* Mention in docs that figshare collections aren't supported (`275 <https://github.com/fatiando/pooch/pull/275>`__)

Maintenance:

* Replace Google Analytics for `Plausible <https://plausible.io>`__ to make our docs more privacy-friendly (`#293 <https://github.com/fatiando/pooch/pull/293>`__)
* Use `Dependente <https://github.com/fatiando/dependente>`__ to capture dependencies on CI (`#289 <https://github.com/fatiando/pooch/pull/289>`__)
* Use ``build`` instead of setup.py (`287 <https://github.com/fatiando/pooch/pull/287>`__)
* Run the tests weekly on GitHub Actions (`286 <https://github.com/fatiando/pooch/pull/286>`__)
* Set minimum required version of dependencies (`280 <https://github.com/fatiando/pooch/pull/280>`__)
* Rename "master" to "main" throughout the project (`278 <https://github.com/fatiando/pooch/pull/278>`__)
* Remove trailing slash from GitHub handle in ``AUTHORS.md`` (`279 <https://github.com/fatiando/pooch/pull/279>`__)

This release contains contributions from:

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

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

Released on: 2021/10/11

DOI: https://doi.org/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 <https://github.com/fatiando/pooch/pull/266>`__)

Enhancements:

* Add support for Python 3.10 (`260 <https://github.com/fatiando/pooch/pull/260>`__)
* Point to the user's code for the file_hash warning instead of our internal code (which isn't very useful) (`259 <https://github.com/fatiando/pooch/pull/259>`__)

Documentation:

* Fix typo in a variable name of the examples in the documentation (`268 <https://github.com/fatiando/pooch/pull/268>`__)
* Fix typo when specifying the SFTP protocol in the about page (`267 <https://github.com/fatiando/pooch/pull/267>`__)

Maintenance:

* Remove old testing checks if running on TravisCI (`265 <https://github.com/fatiando/pooch/pull/265>`__)

This release contains contributions from:

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