Add platformdirs as an optional dependency

Author: mwouts

.github/workflows/continuous-integration.yml

@@ -114,7 +114,7 @@ jobs:
 
       - name: Uninstall non-essential dependencies
         if: matrix.uninstall_non_essential_dependencies
-        run: pip uninstall polars jinja2 dash anywidget streamlit shiny shinywidgets -y
+        run: pip uninstall polars jinja2 dash anywidget streamlit shiny shinywidgets platformdirs -y
 
       - name: Install a Jupyter Kernel
         run: python -m ipykernel install --name itables --user

docs/changelog.md

@@ -1,6 +1,13 @@
 ITables ChangeLog
 =================
 
+2.5.2-dev (2025-09-02)
+------------------
+
+**Changed**
+- `platformdirs` is an optional dependency of ITables ([#437](https://github.com/mwouts/itables/issues/437))
+
+
 2.5.1 (2025-08-31)
 ------------------
 

docs/options/options.md

@@ -42,7 +42,9 @@ itables.options.maxBytes = "128KB"
 
 ## Configuration File
 
-Since v2.5.0, ITable can load its default options from a configuration file. The configuration file is identified using `get_config_file` from [`itables.config`](https://github.com/mwouts/itables/blob/main/src/itables/config.py). It can be:
+Since v2.5.0, ITable can load its default options from a configuration file. This requires two dependencies: either `tomllib` or `tomli`, and `platformdirs`, which can be installed with `pip install itables[config]`.
+
+The configuration file is identified using `get_config_file` from [`itables.config`](https://github.com/mwouts/itables/blob/main/src/itables/config.py). It can be:
 
 - The file pointed to by the environment variable `ITABLES_CONFIG`, if set and non-empty (if the variable is an empty string, no configuration file is used)
 - An `itables.toml` file in the current or a parent directory

docs/py/options/options.py

@@ -44,7 +44,9 @@
 #
 # ## Configuration File
 #
-# Since v2.5.0, ITable can load its default options from a configuration file. The configuration file is identified using `get_config_file` from [`itables.config`](https://github.com/mwouts/itables/blob/main/src/itables/config.py). It can be:
+# Since v2.5.0, ITable can load its default options from a configuration file. This requires two dependencies: either `tomllib` or `tomli`, and `platformdirs`, which can be installed with `pip install itables[config]`.
+#
+# The configuration file is identified using `get_config_file` from [`itables.config`](https://github.com/mwouts/itables/blob/main/src/itables/config.py). It can be:
 #
 # - The file pointed to by the environment variable `ITABLES_CONFIG`, if set and non-empty (if the variable is an empty string, no configuration file is used)
 # - An `itables.toml` file in the current or a parent directory

pyproject.toml

@@ -31,7 +31,7 @@ dependencies = ["IPython", "pandas", "numpy"]
 dynamic = ["version"]
 
 [project.optional-dependencies]
-config = ["tomli;python_version<\"3.11\""]
+config = ["tomli;python_version<\"3.11\"", "platformdirs"]
 polars = ["polars", "pyarrow"]
 check_type = ["typeguard>=4.4.1"]
 style = ["matplotlib"]

src/itables/config.py

@@ -21,7 +21,10 @@
     except ImportError:
         tomllib = None  # type: ignore[assignment]
 
-from platformdirs import user_config_path
+try:
+    from platformdirs import user_config_path
+except ImportError:
+    user_config_path = None
 
 from itables.typing import ITableOptions, check_itable_arguments
 
@@ -62,9 +65,10 @@ def get_config_file(path: Path = Path.cwd()) -> Optional[Path]:
         if parent in ceiling_directories:
             break
 
-    config_file = user_config_path("itables") / "itables.toml"
-    if config_file.exists():
-        return config_file
+    if user_config_path is not None:
+        config_file = user_config_path("itables") / "itables.toml"
+        if config_file.exists():
+            return config_file
 
     return None
 

src/itables/show_config.py

@@ -6,13 +6,19 @@
 
 from pathlib import Path
 
-from itables.config import get_config_file, load_config_file
+from itables.config import get_config_file, load_config_file, tomllib, user_config_path
 
 
 def show_config(path: Path):
     """
     Show the ITables config file location and content.
     """
+    if (tomllib is None) or (user_config_path is None):
+        print(
+            "Missing itables[config] dependencies. Please install them with 'pip install itables[config]"
+        )
+        return
+
     if (config_file := get_config_file(path)) is None:
         print("No ITables config file found")
         return

src/itables/version.py

@@ -1,3 +1,3 @@
 """ITables' version number"""
 
-__version__ = "2.5.1"
+__version__ = "2.5.2-dev"