Merge branch 'main' into members-no-members

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/docs.yml

@@ -36,7 +36,7 @@ jobs:
       # We pin the commit hash corresponding to v0.5.0, and not pinning the tag
       # because we are giving full access through the github.token.
       - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@148d9a848c6acaf90a3ec30bc5062f646f8a4163
+        uses: styfle/cancel-workflow-action@0.12.1
         with:
           access_token: ${{ github.token }}
 
@@ -137,7 +137,7 @@ jobs:
           path: doc/_build/html
 
       - name: Checkout the gh-pages branch in a separate folder
-        uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+        uses: actions/checkout@v3
         with:
           ref: gh-pages
           # Checkout to this folder instead of the current one

.github/workflows/pypi.yml

@@ -110,7 +110,7 @@ jobs:
       - name: Publish to Test PyPI
         # Only publish to TestPyPI when a PR is merged (pushed to main)
         if: success() && github.event_name == 'push'
-        uses: pypa/gh-action-pypi-publish@bce3b74dbf8cc32833ffba9d15f83425c1a736e0
+        uses: pypa/gh-action-pypi-publish@v1.8.11
         with:
           user: __token__
           password: ${{ secrets.TEST_PYPI_TOKEN}}
@@ -122,7 +122,7 @@ jobs:
       - name: Publish to PyPI
         # Only publish to PyPI when a release triggers the build
         if: success() && github.event_name == 'release'
-        uses: pypa/gh-action-pypi-publish@bce3b74dbf8cc32833ffba9d15f83425c1a736e0
+        uses: pypa/gh-action-pypi-publish@v1.8.11
         with:
           user: __token__
           password: ${{ secrets.PYPI_TOKEN}}

.github/workflows/test.yml

@@ -17,10 +17,6 @@ on:
   release:
     types:
       - published
-  schedule:
-    # Run every Monday at 12:00 UTC
-    # * is a special character in YAML so you have to quote this string
-    - cron: "00 12 * * 1"
 
 # Use bash by default in all jobs
 defaults:
@@ -43,13 +39,17 @@ jobs:
           - ubuntu
           - macos
           - windows
-        python:
-          - "3.7"
-          - "3.11"
         dependencies:
+          - oldest
           - latest
           - optional
-          - oldest
+        include:
+          - dependencies: oldest
+            python: "3.7"
+          - dependencies: latest
+            python: "3.11"
+          - dependencies: optional
+            python: "3.11"
     env:
       REQUIREMENTS: env/requirements-build.txt env/requirements-test.txt
       # Used to tag codecov submissions
@@ -62,7 +62,7 @@ jobs:
       # We pin the commit hash corresponding to v0.5.0, and not pinning the tag
       # because we are giving full access through the github.token.
       - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@148d9a848c6acaf90a3ec30bc5062f646f8a4163
+        uses: styfle/cancel-workflow-action@0.12.1
         with:
           access_token: ${{ github.token }}
 

README.md

@@ -21,35 +21,41 @@ Part of the <a href="https://www.fatiando.org"><strong>Fatiando a Terra</strong>
 
 ## About
 
-*Does your Python package include sample datasets?
-Are you shipping them with the code?
-Are they getting too big?*
+> Just want to download a file without messing with `requests` and `urllib`?
+> Trying to add sample datasets to your Python package?
+> **Pooch is here to help!**
 
-**Pooch** is here to help! It will manage a data *registry* by downloading your
-data files from a server only when needed and storing them locally in a data
-*cache* (a folder on your computer).
-
-Here are Pooch's main features:
+*Pooch* is a **Python library** that can manage data by **downloading files**
+from a server (only when needed) and storing them locally in a data **cache**
+(a folder on your computer).
 
 * Pure Python and minimal dependencies.
-* Download a file only if necessary (it's not in the data cache or needs to be
-  updated).
-* Verify download integrity through SHA256 hashes (also used to check if a file
-  needs to be updated).
-* Designed to be extended: plug in custom download (FTP, scp, etc) and
-  post-processing (unzip, decompress, rename) functions.
-* Includes utilities to unzip/decompress the data upon download to save loading
-  time.
-* Can handle basic HTTP authentication (for servers that require a login) and
-  printing download progress bars.
-* Easily set up an environment variable to overwrite the data cache location.
-
-*Are you a scientist or researcher? Pooch can help you too!*
-
-* Automatically download your data files so you don't have to keep them in your
-  GitHub repository.
-* Make sure everyone running the code has the same version of the data files
-  (enforced through the SHA256 hashes).
+* Download files over HTTP, FTP, and from data repositories like Zenodo and figshare.
+* Built-in post-processors to unzip/decompress the data after download.
+* Designed to be extended: create custom downloaders and post-processors.
+
+Are you a **scientist** or researcher? Pooch can help you too!
+
+* Host your data on a repository and download using the DOI.
+* Automatically download data using code instead of telling colleagues to do it themselves.
+* Make sure everyone running the code has the same version of the data files.
+
+## Projects using Pooch
+
+[SciPy](https://github.com/scipy/scipy), 
+[scikit-image](https://github.com/scikit-image/scikit-image),
+[Ensaio](https://github.com/fatiando/ensaio),
+[MetPy](https://github.com/Unidata/MetPy),
+[napari](https://github.com/napari/napari),
+[icepack](https://github.com/icepack/icepack),
+[histolab](https://github.com/histolab/histolab),
+[seaborn-image](https://github.com/SarthakJariwala/seaborn-image),
+[Open AR-Sandbox](https://github.com/cgre-aachen/open_AR_Sandbox),
+[climlab](https://github.com/climlab/climlab),
+[mne-python](https://github.com/mne-tools/mne-python),
+[GemGIS](https://github.com/cgre-aachen/gemgis)
+
+> If you're using Pooch, **send us a pull request** adding your project to the list.
 
 ## Example
 
@@ -136,23 +142,6 @@ def fetch_gravity_data():
     return data
 ```
 
-## Projects using Pooch
-
-* [SciPy](https://github.com/scipy/scipy)
-* [scikit-image](https://github.com/scikit-image/scikit-image)
-* [MetPy](https://github.com/Unidata/MetPy)
-* [icepack](https://github.com/icepack/icepack)
-* [histolab](https://github.com/histolab/histolab)
-* [seaborn-image](https://github.com/SarthakJariwala/seaborn-image)
-* [Ensaio](https://github.com/fatiando/ensaio)
-* [Open AR-Sandbox](https://github.com/cgre-aachen/open_AR_Sandbox)
-* [climlab](https://github.com/climlab/climlab)
-* [napari](https://github.com/napari/napari)
-* [mne-python](https://github.com/mne-tools/mne-python)
-* [GemGIS](https://github.com/cgre-aachen/gemgis)
-
-*If you're using Pooch, send us a pull request adding your project to the list.*
-
 ## Getting involved
 
 🗨️ **Contact us:**

doc/_templates/layout.html

@@ -8,7 +8,7 @@
 
 
 {% block htmltitle %}
-    {% if title == '' or title == 'Home' %}
+    {% if title == '' or 'no title' in title or title == 'Home' %}
         <title>{{ docstitle|striptags|e }}</title>
     {% else %}
         <title>{{ title|striptags|e }} | {{ docstitle|striptags|e }}</title>

doc/about.rst

@@ -6,42 +6,43 @@ Why use Pooch?
 Use cases
 ---------
 
+.. tab-set::
 
-.. tabbed:: Just download a file
+    .. tab-item:: Just download a file
 
-    **Who**: Scientists/researchers/developers looking to simply download a
-    file.
+        **Who**: Scientists/researchers/developers looking to simply download a
+        file.
 
-    Pooch makes it easy to download a file (one function call).
-    On top of that, it also comes with some bonus features:
+        Pooch makes it easy to download a file (one function call).
+        On top of that, it also comes with some bonus features:
 
-    * Download and cache your data files locally (so it's only downloaded
-      once).
-    * Make sure everyone running the code has the same version of the data
-      files by verifying cryptographic hashes.
-    * Multiple download protocols HTTP/FTP/SFTP and basic authentication.
-    * Download from Digital Object Identifiers (DOIs) issued by repositories
-      like figshare and Zenodo.
-    * Built-in utilities to unzip/decompress files upon download
+        * Download and cache your data files locally (so it's only downloaded
+          once).
+        * Make sure everyone running the code has the same version of the data
+          files by verifying cryptographic hashes.
+        * Multiple download protocols HTTP/FTP/SFTP and basic authentication.
+        * Download from Digital Object Identifiers (DOIs) issued by repositories
+          like figshare and Zenodo.
+        * Built-in utilities to unzip/decompress files upon download
 
-    **Start here:** :ref:`retrieve`
+        **Start here:** :ref:`retrieve`
 
-.. tabbed:: Use by another library
+    .. tab-item::  Manage sample data for a Python program
 
-    **Who**: Package developers wanting to include sample data for use in
-    tutorials and tests.
+        **Who**: Package developers wanting to include sample data for use in
+        tutorials and tests.
 
-    Pooch was designed for this! It offers:
+        Pooch was designed for this! It offers:
 
-    * Pure Python and :ref:`minimal dependencies <dependencies>`.
-    * Download a file only if necessary.
-    * Verification of download integrity through cryptographic hashes.
-    * Extensible design: plug in custom download and post-processing functions.
-    * Built-in utilities to unzip/decompress files upon download
-    * Multiple download protocols HTTP/FTP/SFTP and basic authentication.
-    * User control of data cache location through environment variables.
+        * Pure Python and :ref:`minimal dependencies <dependencies>`.
+        * Download a file only if necessary.
+        * Verification of download integrity through cryptographic hashes.
+        * Extensible design: plug in custom download and post-processing functions.
+        * Built-in utilities to unzip/decompress files upon download
+        * Multiple download protocols HTTP/FTP/SFTP and basic authentication.
+        * User control of data cache location through environment variables.
 
-    **Start here:** :ref:`intermediate`
+        **Start here:** :ref:`intermediate`
 
 History
 -------

doc/conf.py

@@ -32,16 +32,9 @@
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
-    "sphinx_panels",
+    "sphinx_design",
 ]
 
-# Disable including boostrap CSS for sphinx_panels since it's already included
-# with sphinx-book-theme
-panels_add_bootstrap_css = False
-panels_css_variables = {
-    "tabs-color-label-inactive": "hsla(231, 99%, 66%, 0.5)",
-}
-
 # Configuration to include links to other project docs when referencing
 # functions/classes
 intersphinx_mapping = {
@@ -75,7 +68,9 @@
 # -----------------------------------------------------------------------------
 html_title = f'{project} <span class="project-version">{version}</span>'
 html_short_title = project
-html_logo = "_static/pooch-logo.png"
+# Don't use the logo since it gets in the way of the project name and is
+# repeated in the front page.
+# html_logo = "_static/pooch-logo.png"
 html_favicon = "_static/favicon.png"
 html_last_updated_fmt = "%b %d, %Y"
 html_copy_source = True