Deprecate pkg_resources

.github/workflows/py-check.yaml

@@ -18,12 +18,12 @@ jobs:
             fail-fast: false
             matrix:
                 os: [ubuntu-latest]
-                python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+                python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
                 include:
                     - os: macos-latest
-                      python-version: "3.11"
+                      python-version: "3.12"
                     - os: windows-latest
-                      python-version: "3.11"
+                      python-version: "3.12"
 
         env:
             SDKROOT: /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk

README.rst

@@ -123,15 +123,15 @@ Tool names in the **whitebox** Python package can be called either using the sna
 .. code:: python
 
     import os
-    import pkg_resources
+    from importlib_resources import files
     import whitebox
 
     wbt = whitebox.WhiteboxTools()
     print(wbt.version())
     print(wbt.help())
 
     # identify the sample data directory of the package
-    data_dir = os.path.dirname(pkg_resources.resource_filename("whitebox", 'testdata/'))
+    data_dir = str(files("whitebox").joinpath("testdata"))
 
     wbt.set_working_dir(data_dir)
     wbt.verbose = False

docs/usage.rst

@@ -11,15 +11,15 @@ For example:
 .. code:: python
 
     import os
-    import pkg_resources
+    from importlib_resources import files
     import whitebox
 
     wbt = whitebox.WhiteboxTools()
     print(wbt.version())
     print(wbt.help())
 
     # identify the sample data directory of the package
-    data_dir = os.path.dirname(pkg_resources.resource_filename("whitebox", 'testdata/'))
+    data_dir = str(files("whitebox").joinpath("testdata"))
 
     wbt.set_working_dir(data_dir)
     wbt.verbose = False

examples/whitebox.ipynb

@@ -249,13 +249,6 @@
                 "**Tool names in the whitebox Python package can be called either using the snake_case or CamelCase convention (e.g. lidar_info or LidarInfo). The example below uses snake_case.** "
             ]
         },
-        {
-            "cell_type": "code",
-            "execution_count": null,
-            "metadata": {},
-            "outputs": [],
-            "source": []
-        },
         {
             "cell_type": "code",
             "execution_count": null,
@@ -264,10 +257,11 @@
             },
             "outputs": [],
             "source": [
-                "import os, pkg_resources\n",
+                "import os\n",
+                "from importlib_resources import files\n",
                 "\n",
                 "# identify the sample data directory of the package\n",
-                "data_dir = os.path.dirname(pkg_resources.resource_filename(\"whitebox\", 'testdata/'))\n",
+                "data_dir = str(files(\"whitebox\").joinpath(\"testdata\"))\n",
                 "\n",
                 "# set whitebox working directory\n",
                 "wbt.set_working_dir(data_dir)\n",

whitebox/download_wbt.py

@@ -15,7 +15,7 @@ def download_wbt(linux_musl=False, reset=False, verbose=True):
     import tarfile
     import shutil
     import urllib.request
-    import pkg_resources
+    import importlib.resources
     import webbrowser
 
     if os.environ.get("WBT_PATH", None) is not None:
@@ -25,8 +25,9 @@ def download_wbt(linux_musl=False, reset=False, verbose=True):
     package_name = "whitebox"
     # Get package directory
     pkg_dir = os.path.dirname(
-        pkg_resources.resource_filename(package_name, "whitebox_tools.py")
+        importlib.resources.files(package_name) / "whitebox_tools.py"
     )
+
     exe_dir = os.path.join(
         pkg_dir, "WBT"
     )  # Get directory of WhiteboxTools executable file