#1647 - Added _PrimaitePaths class that manages all the primaite locations using PlayformDirs. This class now creates new primaite locations for each version of primaite.

- Rolled the _PrimaitePaths class out throughout the code base.
- Updated the docs to reference the new version paths.
- Updated the author from qinetiq to dstl
- Bumped version number to 2.0.0rc2

src/primaite/setup/reset_demo_notebooks.py

@@ -7,7 +7,7 @@ from pathlib import Path
 
 import pkg_resources
 
-from primaite import getLogger, NOTEBOOKS_DIR
+from primaite import getLogger, PRIMAITE_PATHS
 
 _LOGGER: Logger = getLogger(__name__)
 
@@ -23,7 +23,7 @@ def run(overwrite_existing: bool = True) -> None:
         for file in files:
             fp = os.path.join(subdir, file)
             path_split = os.path.relpath(fp, notebooks_package_data_root).split(os.sep)
-            target_fp = NOTEBOOKS_DIR / Path(*path_split)
+            target_fp = PRIMAITE_PATHS.user_notebooks_path / Path(*path_split)
             target_fp.parent.mkdir(exist_ok=True, parents=True)
             copy_file = not target_fp.is_file()
 

src/primaite/setup/reset_example_configs.py

@@ -6,7 +6,7 @@ from pathlib import Path
 
 import pkg_resources
 
-from primaite import getLogger, USERS_CONFIG_DIR
+from primaite import getLogger, PRIMAITE_PATHS
 
 _LOGGER = getLogger(__name__)
 
@@ -23,7 +23,7 @@ def run(overwrite_existing: bool = True) -> None:
         for file in files:
             fp = os.path.join(subdir, file)
             path_split = os.path.relpath(fp, configs_package_data_root).split(os.sep)
-            target_fp = USERS_CONFIG_DIR / "example_config" / Path(*path_split)
+            target_fp = PRIMAITE_PATHS.user_config_path / "example_config" / Path(*path_split)
             target_fp.parent.mkdir(exist_ok=True, parents=True)
             copy_file = not target_fp.is_file()
 

src/primaite/setup/setup_app_dirs.py

@@ -1,29 +0,0 @@
-# Crown Owned Copyright (C) Dstl 2023. DEFCON 703. Shared in confidence.
-from logging import Logger
-
-from primaite import _USER_DIRS, getLogger, LOG_DIR, NOTEBOOKS_DIR
-
-_LOGGER: Logger = getLogger(__name__)
-
-
-def run() -> None:
-    """
-    Handles creation of application directories and user directories.
-
-    Uses `platformdirs.PlatformDirs` and `pathlib.Path` to create the required
-    app directories in the correct locations based on the users OS.
-    """
-    app_dirs = [
-        _USER_DIRS,
-        NOTEBOOKS_DIR,
-        LOG_DIR,
-    ]
-
-    for app_dir in app_dirs:
-        if not app_dir.is_dir():
-            app_dir.mkdir(parents=True, exist_ok=True)
-            _LOGGER.info(f"Created directory: {app_dir}")
-
-
-if __name__ == "__main__":
-    run()