#915 - Created app dirs and set as constants in the top-level init.

- renamed _config_values_main to training_config.py and renamed the ConfigValuesMain class to TrainingConfig.
Moved training_config.py to src/primaite/config/training_config.py
- Renamed all training config yaml file keys to make creating an instance of TrainingConfig easier.
Moved action_type and num_steps over to the training config.
- Decoupled the training config and lay down config.
- Refactored main.py so that it can be ran from CLI and can take a training config path and a lay down config path.
- refactored all outputs so that they save to the session dir.
- Added some necessary setup scripts that handle creating app dirs, fronting example config files to the user, fronting demo notebooks to the user, performing clean-up in between installations etc.
- Added functions that attempt to retrieve the file path of users example config files that have been fronted by the primaite setup.
- Added logging config and a getLogger function in the top-level init.
- Refactored all logs entries logged to use a logger using the primaite logging config.
- Added basic typer CLI for doing things like setup, viewing logs, viewing primaite version, running a basic session.
- Updated test to use new features and config structures.
- Began updating docs. More to do here.

src/primaite/setup/__init__.py

@@ -0,0 +1 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.

src/primaite/setup/old_installation_clean_up.py

@@ -0,0 +1,13 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+from primaite import getLogger
+
+_LOGGER = getLogger(__name__)
+
+
+def run():
+    """Perform the full clean-up."""
+    pass
+
+
+if __name__ == "__main__":
+    run()

src/primaite/setup/reset_demo_notebooks.py

@@ -0,0 +1,39 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+import filecmp
+import os
+import shutil
+from pathlib import Path
+
+import pkg_resources
+
+from primaite import NOTEBOOKS_DIR, getLogger
+
+_LOGGER = getLogger(__name__)
+
+
+def run(overwrite_existing: bool = True):
+    """
+    Resets the demo jupyter notebooks in the users app notebooks directory.
+
+    :param overwrite_existing: A bool to toggle replacing existing edited
+        notebooks on or off.
+    """
+    notebooks_package_data_root = pkg_resources.resource_filename(
+        "primaite", "notebooks/_package_data"
+    )
+    for subdir, dirs, files in os.walk(notebooks_package_data_root):
+        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.parent.mkdir(exist_ok=True, parents=True)
+            copy_file = not target_fp.is_file()
+
+            if overwrite_existing and not copy_file:
+                copy_file = (not filecmp.cmp(fp, target_fp)) and (
+                    ".ipynb_checkpoints" not in str(target_fp)
+                )
+
+            if copy_file:
+                shutil.copy2(fp, target_fp)
+                _LOGGER.info(f"Reset example notebook: {target_fp}")

src/primaite/setup/reset_example_configs.py

@@ -0,0 +1,37 @@
+import filecmp
+import os
+import shutil
+from pathlib import Path
+
+import pkg_resources
+
+from primaite import USERS_CONFIG_DIR, getLogger
+
+_LOGGER = getLogger(__name__)
+
+
+def run(overwrite_existing=True):
+    """
+    Resets the example config files in the users app config directory.
+
+    :param overwrite_existing: A bool to toggle replacing existing edited
+        config on or off.
+    """
+    configs_package_data_root = pkg_resources.resource_filename(
+        "primaite", "config/_package_data"
+    )
+
+    for subdir, dirs, files in os.walk(configs_package_data_root):
+        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.parent.mkdir(exist_ok=True, parents=True)
+            copy_file = not target_fp.is_file()
+
+            if overwrite_existing and not copy_file:
+                copy_file = not filecmp.cmp(fp, target_fp)
+
+            if copy_file:
+                shutil.copy2(fp, target_fp)
+                _LOGGER.info(f"Reset example config: {target_fp}")

src/primaite/setup/setup_app_dirs.py

@@ -0,0 +1,27 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+from primaite import _USER_DIRS, LOG_DIR, NOTEBOOKS_DIR, getLogger
+
+_LOGGER = getLogger(__name__)
+
+
+def run():
+    """
+    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()