fix(skore-local-project)!: Change default workspace location (#2086)

From "cache dir" to "data dir"

Author: auguste-probabl

skore-local-project/src/skore_local_project/project.py

@@ -79,12 +79,12 @@ class Project:
         | The workspace can be shared between all the projects.
         | The workspace can be set using kwargs or the environment variable
           ``SKORE_WORKSPACE``.
-        | If not, it will be by default set to a ``skore/`` directory in the USER
+        | If not, it will be by default set to a ``skore/`` directory in the user
           cache directory:
 
         - on Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
-        - on Linux, usually ``${HOME}/.cache/skore``,
-        - on macOS, usually ``${HOME}/Library/Caches/skore``.
+        - on Linux, usually ``${HOME}/.local/share/skore``,
+        - on macOS, usually ``${HOME}/Library/Application Support/skore``.
     """
 
     @staticmethod
@@ -100,7 +100,7 @@ def __setup_diskcache(
             if "SKORE_WORKSPACE" in os.environ:
                 workspace = Path(os.environ["SKORE_WORKSPACE"])
             else:
-                workspace = Path(platformdirs.user_cache_dir()) / "skore"
+                workspace = Path(platformdirs.user_data_dir()) / "skore"
 
         for directory in ("projects", "metadata", "artifacts"):
             (workspace / directory).mkdir(parents=True, exist_ok=True)

skore-local-project/tests/unit/test_project.py

@@ -111,7 +111,7 @@ def monkeypatch_metrics(monkeypatch, Datetime):
 class TestProject:
     def test_init(self, monkeypatch, tmp_path):
         monkeypatch.setattr(
-            "skore_local_project.project.platformdirs.user_cache_dir",
+            "skore_local_project.project.platformdirs.user_data_dir",
             lambda: str(tmp_path),
         )
 

skore/src/skore/project/project.py

@@ -47,12 +47,12 @@ class Project:
     | The workspace can be shared between all the projects.
     | The workspace can be set using kwargs or the environment variable
       ``SKORE_WORKSPACE``.
-    | If not, it will be by default set to a ``skore/`` directory in the USER
+    | If not, it will be by default set to a ``skore/`` directory in the user
       cache directory:
 
     - on Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
-    - on Linux, usually ``${HOME}/.cache/skore``,
-    - on macOS, usually ``${HOME}/Library/Caches/skore``.
+    - on Linux, usually ``${HOME}/.local/share/skore``,
+    - on macOS, usually ``${HOME}/Library/Application Support/skore``.
 
     Refer to the :ref:`project` section of the user guide for more details.
 
@@ -71,16 +71,6 @@ class Project:
         workspace : Path, mode:local only.
             The directory where the local project is persisted.
 
-            | The workspace can be shared between all the projects.
-            | The workspace can be set using kwargs or the environment variable
-              ``SKORE_WORKSPACE``.
-            | If not, it will be by default set to a ``skore/`` directory in the USER
-              cache directory:
-
-            - on Windows, usually ``C:\Users\%USER%\AppData\Local\skore``,
-            - on Linux, usually ``${HOME}/.cache/skore``,
-            - on macOS, usually ``${HOME}/Library/Caches/skore``.
-
     Attributes
     ----------
     name : str