#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/cli.py

@@ -0,0 +1,125 @@
+# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
+"""Provides a CLI using Typer as an entry point."""
+import os
+import sys
+
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def build_dirs():
+    """Build the PrimAITE app directories."""
+    from primaite.setup import setup_app_dirs
+
+    setup_app_dirs.run()
+
+
+@app.command()
+def reset_notebooks(overwrite: bool = True):
+    """
+    Force a reset of the demo notebooks in the users notebooks directory.
+
+    :param overwrite: If True, will overwrite existing demo notebooks.
+    """
+    from primaite.setup import reset_demo_notebooks
+
+    reset_demo_notebooks.run(overwrite)
+
+
+@app.command()
+def logs(last_n: int = 10):
+    """
+    Print the PrimAITE log file.
+
+    :param last_n: The number of lines to print. Default value is 10.
+    """
+    import re
+
+    from platformdirs import PlatformDirs
+
+    yt_platform_dirs = PlatformDirs(appname="primaite")
+
+    if sys.platform == "win32":
+        log_dir = yt_platform_dirs.user_data_path / "logs"
+    else:
+        log_dir = yt_platform_dirs.user_log_path
+    log_path = os.path.join(log_dir, "primaite.log")
+
+    if os.path.isfile(log_path):
+        with open(log_path) as file:
+            lines = file.readlines()
+        for line in lines[-last_n:]:
+            print(re.sub(r"\n*", "", line))
+
+
+@app.command()
+def notebooks():
+    """Start Jupyter Lab in the users PrimAITE notebooks directory."""
+    from primaite.notebooks import start_jupyter_session
+
+    start_jupyter_session()
+
+
+@app.command()
+def version():
+    """Get the installed PrimAITE version number."""
+    import primaite
+
+    print(primaite.__version__)
+
+
+@app.command()
+def clean_up():
+    """Cleans up left over files from previous version installations."""
+    from primaite.setup import old_installation_clean_up
+
+    old_installation_clean_up.run()
+
+
+@app.command()
+def setup():
+    """
+    Perform the PrimAITE first-time setup.
+
+    WARNING: All user-data will be lost.
+    """
+    from primaite import getLogger
+    from primaite.setup import (
+        old_installation_clean_up,
+        reset_demo_notebooks,
+        reset_example_configs,
+        setup_app_dirs,
+    )
+
+    _LOGGER = getLogger(__name__)
+
+    _LOGGER.info("Performing the PrimAITE first-time setup...")
+
+    _LOGGER.info("Building the PrimAITE app directories...")
+    setup_app_dirs.run()
+
+    _LOGGER.info("Rebuilding the demo notebooks...")
+    reset_demo_notebooks.run(overwrite_existing=True)
+
+    _LOGGER.info("Rebuilding the example notebooks...")
+    reset_example_configs.run(overwrite_existing=True)
+
+    _LOGGER.info("Performing a clean-up of previous PrimAITE installations...")
+    old_installation_clean_up.run()
+
+    _LOGGER.info("PrimAITE setup complete!")
+
+
+@app.command()
+def session(tc: str, ldc: str):
+    """
+    Run a PrimAITE session.
+
+    :param tc: The training config filepath.
+    :param ldc: The lay down config file path.
+    """
+    from primaite.main import run
+
+    run(training_config_path=tc, lay_down_config_path=ldc)