#915 - Refactored documentation and included APi docs, dependencies.

- make files now re-build autosummary and deps file.
- Added typer and platformdirs to deps in pyproject.toml.
- Made root_is_pure = True in setup.py as platform/python specific wheels don't need to be built but the option is there should we need to.
-
Added an e2e test for primaite.main.run func.

src/primaite/config/lay_down_config.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from typing import Final
 
-from primaite import getLogger, USERS_CONFIG_DIR
+from primaite import USERS_CONFIG_DIR, getLogger
 
 _LOGGER = getLogger(__name__)
 
@@ -17,7 +17,7 @@ def ddos_basic_one_config_path() -> Path:
     """
     path = _EXAMPLE_LAY_DOWN / "lay_down_config_1_DDOS_basic.yaml"
     if not path.exists():
-        msg = f"Example config not found. Please run 'primaite setup'"
+        msg = "Example config not found. Please run 'primaite setup'"
         _LOGGER.critical(msg)
         raise FileNotFoundError(msg)
 
@@ -32,7 +32,7 @@ def ddos_basic_two_config_path() -> Path:
     """
     path = _EXAMPLE_LAY_DOWN / "lay_down_config_2_DDOS_basic.yaml"
     if not path.exists():
-        msg = f"Example config not found. Please run 'primaite setup'"
+        msg = "Example config not found. Please run 'primaite setup'"
         _LOGGER.critical(msg)
         raise FileNotFoundError(msg)
 
@@ -47,7 +47,7 @@ def dos_very_basic_config_path() -> Path:
     """
     path = _EXAMPLE_LAY_DOWN / "lay_down_config_3_DOS_very_basic.yaml"
     if not path.exists():
-        msg = f"Example config not found. Please run 'primaite setup'"
+        msg = "Example config not found. Please run 'primaite setup'"
         _LOGGER.critical(msg)
         raise FileNotFoundError(msg)
 
@@ -62,7 +62,7 @@ def data_manipulation_config_path() -> Path:
     """
     path = _EXAMPLE_LAY_DOWN / "lay_down_config_5_data_manipulation.yaml"
     if not path.exists():
-        msg = f"Example config not found. Please run 'primaite setup'"
+        msg = "Example config not found. Please run 'primaite setup'"
         _LOGGER.critical(msg)
         raise FileNotFoundError(msg)
 

src/primaite/config/training_config.py

@@ -1,17 +1,16 @@
 # Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Dict, Union, Final
+from typing import Any, Dict, Final, Union
 
 import yaml
 
-from primaite import getLogger, USERS_CONFIG_DIR
+from primaite import USERS_CONFIG_DIR, getLogger
 from primaite.common.enums import ActionType
 
 _LOGGER = getLogger(__name__)
 
-_EXAMPLE_TRAINING: Final[
-    Path] = USERS_CONFIG_DIR / "example_config" / "training"
+_EXAMPLE_TRAINING: Final[Path] = USERS_CONFIG_DIR / "example_config" / "training"
 
 
 @dataclass()
@@ -99,25 +98,37 @@ class TrainingConfig:
     file_system_restoring_limit: int  # The time take to restore a file
     file_system_scanning_limit: int  # The time taken to scan the file system
 
+    def to_dict(self, json_serializable: bool = True):
+        """
+        Serialise the ``TrainingConfig`` as dict.
+
+        :param json_serializable: If True, Enums are converted to their
+            string name.
+        :return: The ``TrainingConfig`` as a dict.
+        """
+        data = self.__dict__
+        if json_serializable:
+            data["action_type"] = self.action_type.value
+
+        return data
+
 
 def main_training_config_path() -> Path:
     """
-    The path to the example training_config_main.yaml file
+    The path to the example training_config_main.yaml file.
 
     :return: The file path.
     """
-
     path = _EXAMPLE_TRAINING / "training_config_main.yaml"
     if not path.exists():
-        msg = f"Example config not found. Please run 'primaite setup'"
+        msg = "Example config not found. Please run 'primaite setup'"
         _LOGGER.critical(msg)
         raise FileNotFoundError(msg)
 
     return path
 
 
-def load(file_path: Union[str, Path],
-         legacy_file: bool = False) -> TrainingConfig:
+def load(file_path: Union[str, Path], legacy_file: bool = False) -> TrainingConfig:
     """
     Read in a training config yaml file.
 
@@ -162,9 +173,7 @@ def load(file_path: Union[str, Path],
 
 
 def convert_legacy_training_config_dict(
-        legacy_config_dict: Dict[str, Any],
-        num_steps: int = 256,
-        action_type: str = "ANY"
+    legacy_config_dict: Dict[str, Any], num_steps: int = 256, action_type: str = "ANY"
 ) -> Dict[str, Any]:
     """
     Convert a legacy training config dict to the new format.