#2646 - Added a custom pre-commit hook that ensure the copyright clause is added to .py and .rst files.

2024-06-05 09:11:37 +01:00
parent c705a15d00
commit 81bcf99855
332 changed files with 505 additions and 365 deletions
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,4 +1,10 @@
 repos:
+  - repo: local
+    hooks:
+      - id: ensure-copyright-clause
+        name: ensure copyright clause
+        entry: python copyright_clause_pre_commit_hook.py
+        language: python
  - repo: http://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
--- a/benchmark/primaite_benchmark.py
+++ b/benchmark/primaite_benchmark.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 # flake8: noqa
 raise DeprecationWarning(
    "Benchmarking depends on deprecated functionality and it has not been updated to primaite v3 yet."
--- a/copyright_clause_pre_commit_hook.py
+++ b/copyright_clause_pre_commit_hook.py
@@ -0,0 +1,154 @@
+# -*- coding: utf-8 -*-
+import datetime
+import sys
+from pathlib import Path
+
+# Constants
+CURRENT_YEAR = datetime.date.today().year
+COPYRIGHT_PY_STR = f"# © Crown-owned copyright {CURRENT_YEAR}, Defence Science and Technology Laboratory UK"
+COPYRIGHT_RST_LINES = [
+    ".. only:: comment",
+    "",
+    f"    © Crown-owned copyright {CURRENT_YEAR}, Defence Science and Technology Laboratory UK",
+]
+PATHS = {Path("./src"), Path("./tests"), Path("./docs"), Path("./benchmark")}
+EXTENSIONS = {".py", ".rst"}
+
+
+def _is_copyright_line(line: str) -> bool:
+    """
+    Check if a line is a copyright line.
+
+    :param line: The line to check.
+    :return: True if the line is a copyright line, False otherwise.
+    """
+    return line.startswith("#") and "copyright" in line.lower()
+
+
+def _is_rst_copyright_lines(lines: list) -> bool:
+    """
+    Check if the lines match the RST copyright format.
+
+    :param lines: The lines to check.
+    :return: True if the lines match the RST copyright format, False otherwise.
+    """
+    return len(lines) >= 3 and lines[0] == ".. only:: comment" and "copyright" in lines[2].lower()
+
+
+def process_py_file(file_path: Path) -> bool:
+    """
+    Process a Python file to check and add/update the copyright clause.
+
+    :param file_path: The path to the file to check and update.
+    :return: True if the file was modified, False otherwise.
+    """
+    modified = False
+    try:
+        content = file_path.read_text(encoding="utf-8")
+        lines = content.splitlines(keepends=True)  # Keep line endings
+
+        if lines and _is_copyright_line(lines[0]):
+            if lines[0].strip() != COPYRIGHT_PY_STR:
+                lines[0] = COPYRIGHT_PY_STR + "\n"
+                modified = True
+                print(f"Updated copyright clause in {file_path}")
+        else:
+            lines.insert(0, COPYRIGHT_PY_STR + "\n")
+            modified = True
+            print(f"Added copyright clause to {file_path}")
+
+        if modified:
+            file_path.write_text("".join(lines), encoding="utf-8")
+    except Exception as e:
+        print(f"Failed to process {file_path}: {e}")
+        return False
+
+    return modified
+
+
+def process_rst_file(file_path: Path) -> bool:
+    """
+    Process an RST file to check and add/update the copyright clause.
+
+    :param file_path: The path to the file to check and update.
+    :return: True if the file was modified, False otherwise.
+    """
+    modified = False
+    try:
+        content = file_path.read_text(encoding="utf-8")
+        lines = content.splitlines(keepends=True)  # Keep line endings
+
+        existing_block = any(".. only:: comment" in line for line in lines)
+
+        if existing_block:
+            # Check if the block is correct
+            for i, line in enumerate(lines):
+                if line.strip() == ".. only:: comment":
+                    if lines[i : i + 3] != [
+                        COPYRIGHT_RST_LINES[0] + "\n",
+                        COPYRIGHT_RST_LINES[1] + "\n",
+                        COPYRIGHT_RST_LINES[2] + "\n",
+                    ]:
+                        # Update the incorrect block
+                        lines[i : i + 3] = [
+                            COPYRIGHT_RST_LINES[0] + "\n",
+                            COPYRIGHT_RST_LINES[1] + "\n",
+                            COPYRIGHT_RST_LINES[2] + "\n",
+                        ]
+                        modified = True
+                        print(f"Updated copyright clause in {file_path}")
+                    break
+        else:
+            # Insert new copyright block
+            lines = [line + "\n" for line in COPYRIGHT_RST_LINES] + ["\n"] + lines
+            modified = True
+            print(f"Added copyright clause to {file_path}")
+
+        if modified:
+            file_path.write_text("".join(lines), encoding="utf-8")
+    except Exception as e:
+        print(f"Failed to process {file_path}: {e}")
+        return False
+
+    return modified
+
+
+def process_file(file_path: Path) -> bool:
+    """
+    Check if a file has the correct copyright clause and add or update it if necessary.
+
+    :param file_path: The path to the file to check and update.
+    :return: True if the file was modified, False otherwise.
+    """
+    if file_path.suffix == ".py":
+        return process_py_file(file_path)
+    elif file_path.suffix == ".rst":
+        return process_rst_file(file_path)
+    return False
+
+
+def main() -> int:
+    """
+    Main function to walk through the root directories, check files, and update the copyright clause.
+
+    :return: 1 if any file was modified, 0 otherwise.
+    """
+    files_checked = 0
+    files_modified = 0
+    any_file_modified = False
+    for path in PATHS:
+        for file_path in path.rglob("*"):
+            if file_path.suffix in EXTENSIONS:
+                files_checked += 1
+                if process_file(file_path):
+                    files_modified += 1
+                    any_file_modified = True
+
+    if any_file_modified:
+        print(f"Files Checked: {files_checked}. Files Modified: {files_modified}")
+        return 1
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())
--- a/docs/_templates/custom-class-template.rst
+++ b/docs/_templates/custom-class-template.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ..
    Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
--- a/docs/_templates/custom-module-template.rst
+++ b/docs/_templates/custom-module-template.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ..
    Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -2,7 +2,7 @@

 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ..
   DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 # Configuration file for the Sphinx documentation builder.
 #
 # For the full list of built-in configuration values, see the documentation:
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 Welcome to PrimAITE's documentation
 ====================================
--- a/docs/source/config.rst
+++ b/docs/source/config.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 PrimAITE |VERSION| Configuration
 ********************************
--- a/docs/source/configuration/agents.rst
+++ b/docs/source/configuration/agents.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK


 ``agents``
--- a/docs/source/configuration/game.rst
+++ b/docs/source/configuration/game.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK


 ``game``
--- a/docs/source/configuration/io_settings.rst
+++ b/docs/source/configuration/io_settings.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK


 ``io_settings``
--- a/docs/source/configuration/simulation.rst
+++ b/docs/source/configuration/simulation.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK


 ``simulation``
--- a/docs/source/configuration/simulation/nodes/common/common.rst
+++ b/docs/source/configuration/simulation/nodes/common/common.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _Node Attributes:

--- a/docs/source/configuration/simulation/nodes/common/common_host_node_attributes.rst
+++ b/docs/source/configuration/simulation/nodes/common/common_host_node_attributes.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _common_host_node_attributes:

--- a/docs/source/configuration/simulation/nodes/common/common_network_node_attributes.rst
+++ b/docs/source/configuration/simulation/nodes/common/common_network_node_attributes.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _common_network_node_attributes:

--- a/docs/source/configuration/simulation/nodes/common/common_node_attributes.rst
+++ b/docs/source/configuration/simulation/nodes/common/common_node_attributes.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _common_node_attributes:

--- a/docs/source/configuration/simulation/nodes/common/node_type_list.rst
+++ b/docs/source/configuration/simulation/nodes/common/node_type_list.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ``type``
 --------
--- a/docs/source/configuration/simulation/nodes/computer.rst
+++ b/docs/source/configuration/simulation/nodes/computer.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _computer_configuration:

--- a/docs/source/configuration/simulation/nodes/firewall.rst
+++ b/docs/source/configuration/simulation/nodes/firewall.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _firewall_configuration:

--- a/docs/source/configuration/simulation/nodes/network_examples.rst
+++ b/docs/source/configuration/simulation/nodes/network_examples.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _network_examples:

--- a/docs/source/configuration/simulation/nodes/router.rst
+++ b/docs/source/configuration/simulation/nodes/router.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _router_configuration:

--- a/docs/source/configuration/simulation/nodes/server.rst
+++ b/docs/source/configuration/simulation/nodes/server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _server_configuration:

--- a/docs/source/configuration/simulation/nodes/switch.rst
+++ b/docs/source/configuration/simulation/nodes/switch.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _switch_configuration:

--- a/docs/source/configuration/simulation/software/applications.rst
+++ b/docs/source/configuration/simulation/software/applications.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ``applications``
 ----------------
--- a/docs/source/configuration/simulation/software/services.rst
+++ b/docs/source/configuration/simulation/software/services.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ``services``
 ------------
--- a/docs/source/customising_scenarios.rst
+++ b/docs/source/customising_scenarios.rst
@@ -1,3 +1,7 @@
+.. only:: comment
+
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+
 Customising Agents
 ******************

--- a/docs/source/dependencies.rst
+++ b/docs/source/dependencies.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. role::  raw-html(raw)
    :format: html
--- a/docs/source/developer_tools.rst
+++ b/docs/source/developer_tools.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _Developer Tools:

--- a/docs/source/environment.rst
+++ b/docs/source/environment.rst
@@ -1,3 +1,7 @@
+.. only:: comment
+
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+
 RL Environments
 ***************

--- a/docs/source/example_notebooks.rst
+++ b/docs/source/example_notebooks.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 Example Jupyter Notebooks
 =========================
--- a/docs/source/game_layer.rst
+++ b/docs/source/game_layer.rst
@@ -1,3 +1,7 @@
+.. only:: comment
+
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+
 PrimAITE Game layer
 *******************

--- a/docs/source/getting_started.rst
+++ b/docs/source/getting_started.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _getting-started:

--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 Glossary
 =============
--- a/docs/source/notebooks/executed_notebooks.rst
+++ b/docs/source/notebooks/executed_notebooks.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _Executed Notebooks:

--- a/docs/source/primaite-dependencies.rst
+++ b/docs/source/primaite-dependencies.rst
@@ -1,3 +1,7 @@
+.. only:: comment
+
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+
 +-------------------+---------+------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------+
 | Name              | Version | License                            | Description                                                                                           | URL                                          |
 +===================+=========+====================================+=======================================================================================================+==============================================+
--- a/docs/source/request_system.rst
+++ b/docs/source/request_system.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 Request System
 **************
--- a/docs/source/simulation.rst
+++ b/docs/source/simulation.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK


 Simulation
--- a/docs/source/simulation_components/network/base_hardware.rst
+++ b/docs/source/simulation_components/network/base_hardware.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 #############
 Base Hardware
--- a/docs/source/simulation_components/network/network.rst
+++ b/docs/source/simulation_components/network/network.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _network:

--- a/docs/source/simulation_components/network/network_interfaces.rst
+++ b/docs/source/simulation_components/network/network_interfaces.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 #################################
 Network Interface Hierarchy Model
--- a/docs/source/simulation_components/network/nodes/firewall.rst
+++ b/docs/source/simulation_components/network/nodes/firewall.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ########
 Firewall
--- a/docs/source/simulation_components/network/nodes/host_node.rst
+++ b/docs/source/simulation_components/network/nodes/host_node.rst
@@ -1,3 +1,7 @@
+.. only:: comment
+
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+

 #########
 Host Node
--- a/docs/source/simulation_components/network/nodes/network_node.rst
+++ b/docs/source/simulation_components/network/nodes/network_node.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ############
 Network Node
--- a/docs/source/simulation_components/network/nodes/router.rst
+++ b/docs/source/simulation_components/network/nodes/router.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ######
 Router
--- a/docs/source/simulation_components/network/nodes/switch.rst
+++ b/docs/source/simulation_components/network/nodes/switch.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ######
 Switch
--- a/docs/source/simulation_components/network/nodes/wireless_router.rst
+++ b/docs/source/simulation_components/network/nodes/wireless_router.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ######
 Router
--- a/docs/source/simulation_components/network/transport_to_data_link_layer.rst
+++ b/docs/source/simulation_components/network/transport_to_data_link_layer.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 Transport Layer to Data Link Layer
 ==================================
--- a/docs/source/simulation_components/system/applications/data_manipulation_bot.rst
+++ b/docs/source/simulation_components/system/applications/data_manipulation_bot.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _DataManipulationBot:

--- a/docs/source/simulation_components/system/applications/database_client.rst
+++ b/docs/source/simulation_components/system/applications/database_client.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _DatabaseClient:

--- a/docs/source/simulation_components/system/applications/dos_bot.rst
+++ b/docs/source/simulation_components/system/applications/dos_bot.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _DoSBot:

--- a/docs/source/simulation_components/system/applications/web_browser.rst
+++ b/docs/source/simulation_components/system/applications/web_browser.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _WebBrowser:

--- a/docs/source/simulation_components/system/common/common_configuration.rst
+++ b/docs/source/simulation_components/system/common/common_configuration.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ``ref``
 =======
--- a/docs/source/simulation_components/system/common/db_payload_list.rst
+++ b/docs/source/simulation_components/system/common/db_payload_list.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _Database Payload List:

--- a/docs/source/simulation_components/system/internal_frame_processing.rst
+++ b/docs/source/simulation_components/system/internal_frame_processing.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _internal_frame_processing:

--- a/docs/source/simulation_components/system/list_of_applications.rst
+++ b/docs/source/simulation_components/system/list_of_applications.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. toctree::
    :maxdepth: 1
--- a/docs/source/simulation_components/system/list_of_services.rst
+++ b/docs/source/simulation_components/system/list_of_services.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. toctree::
    :maxdepth: 1
--- a/docs/source/simulation_components/system/list_of_system_applications.rst
+++ b/docs/source/simulation_components/system/list_of_system_applications.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ``system applications``
 """""""""""""""""""""""
--- a/docs/source/simulation_components/system/list_of_system_services.rst
+++ b/docs/source/simulation_components/system/list_of_system_services.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 ``system services``
 """""""""""""""""""
--- a/docs/source/simulation_components/system/pcap.rst
+++ b/docs/source/simulation_components/system/pcap.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 PCAP
 ====
--- a/docs/source/simulation_components/system/services/database_service.rst
+++ b/docs/source/simulation_components/system/services/database_service.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _DatabaseService:

--- a/docs/source/simulation_components/system/services/dns_client.rst
+++ b/docs/source/simulation_components/system/services/dns_client.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _DNSClient:

--- a/docs/source/simulation_components/system/services/dns_server.rst
+++ b/docs/source/simulation_components/system/services/dns_server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _DNSServer:

--- a/docs/source/simulation_components/system/services/ftp_client.rst
+++ b/docs/source/simulation_components/system/services/ftp_client.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _FTPClient:

--- a/docs/source/simulation_components/system/services/ftp_server.rst
+++ b/docs/source/simulation_components/system/services/ftp_server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _FTPServer:

--- a/docs/source/simulation_components/system/services/ntp_client.rst
+++ b/docs/source/simulation_components/system/services/ntp_client.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _NTPClient:

--- a/docs/source/simulation_components/system/services/ntp_server.rst
+++ b/docs/source/simulation_components/system/services/ntp_server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _NTPServer:

--- a/docs/source/simulation_components/system/services/web_server.rst
+++ b/docs/source/simulation_components/system/services/web_server.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 .. _WebServer:

--- a/docs/source/simulation_components/system/session_and_software_manager.rst
+++ b/docs/source/simulation_components/system/session_and_software_manager.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 Session and Software Manager
 ============================
--- a/docs/source/simulation_components/system/software.rst
+++ b/docs/source/simulation_components/system/software.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK


 Software
--- a/docs/source/simulation_components/system/sys_log.rst
+++ b/docs/source/simulation_components/system/sys_log.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 SysLog
 ======
--- a/docs/source/simulation_structure.rst
+++ b/docs/source/simulation_structure.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK


 Simulation Structure
--- a/docs/source/state_system.rst
+++ b/docs/source/state_system.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 Simulation State
 ================
--- a/docs/source/varying_config_files.rst
+++ b/docs/source/varying_config_files.rst
@@ -1,6 +1,6 @@
 .. only:: comment

-    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+    © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

 Defining variations in the config files
 ================
--- a/src/primaite/init.py
+++ b/src/primaite/init.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import datetime as datetime
 import logging
 import logging.config
--- a/src/primaite/cli.py
+++ b/src/primaite/cli.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Provides a CLI using Typer as an entry point."""
 import logging
 import os
--- a/src/primaite/config/init.py
+++ b/src/primaite/config/init.py
@@ -1,2 +1,2 @@
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Configuration parameters for running experiments."""
--- a/src/primaite/config/load.py
+++ b/src/primaite/config/load.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from pathlib import Path
 from typing import Dict, Final, Union

--- a/src/primaite/exceptions.py
+++ b/src/primaite/exceptions.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 class PrimaiteError(Exception):
    """The root PrimAITE Error."""

--- a/src/primaite/game/init.py
+++ b/src/primaite/game/init.py
@@ -1 +1,2 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """PrimAITE Game Layer."""
--- a/src/primaite/game/agent/init.py
+++ b/src/primaite/game/agent/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/src/primaite/game/agent/actions.py
+++ b/src/primaite/game/agent/actions.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """
 This module contains the ActionManager class which belongs to the Agent class.

--- a/src/primaite/game/agent/interface.py
+++ b/src/primaite/game/agent/interface.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Interface for agents."""
 from abc import ABC, abstractmethod
 from typing import Any, Dict, List, Optional, Tuple, TYPE_CHECKING
--- a/src/primaite/game/agent/observations/init.py
+++ b/src/primaite/game/agent/observations/init.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 # flake8: noqa
 # Pre-import all the observations when we load up the observations module so that they can be resolved by the parser.
 from primaite.game.agent.observations.acl_observation import ACLObservation
--- a/src/primaite/game/agent/observations/acl_observation.py
+++ b/src/primaite/game/agent/observations/acl_observation.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from ipaddress import IPv4Address
--- a/src/primaite/game/agent/observations/file_system_observations.py
+++ b/src/primaite/game/agent/observations/file_system_observations.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, Iterable, List, Optional
--- a/src/primaite/game/agent/observations/firewall_observation.py
+++ b/src/primaite/game/agent/observations/firewall_observation.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, List, Optional
--- a/src/primaite/game/agent/observations/host_observations.py
+++ b/src/primaite/game/agent/observations/host_observations.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, List, Optional
--- a/src/primaite/game/agent/observations/link_observation.py
+++ b/src/primaite/game/agent/observations/link_observation.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Any, Dict, List
--- a/src/primaite/game/agent/observations/nic_observations.py
+++ b/src/primaite/game/agent/observations/nic_observations.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, Optional
--- a/src/primaite/game/agent/observations/node_observations.py
+++ b/src/primaite/game/agent/observations/node_observations.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, List, Optional
--- a/src/primaite/game/agent/observations/observation_manager.py
+++ b/src/primaite/game/agent/observations/observation_manager.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Any, Dict, List, Optional
--- a/src/primaite/game/agent/observations/observations.py
+++ b/src/primaite/game/agent/observations/observations.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Manages the observation space for the agent."""
 from abc import ABC, abstractmethod
 from typing import Any, Dict, Iterable, Optional, Type, Union
--- a/src/primaite/game/agent/observations/router_observation.py
+++ b/src/primaite/game/agent/observations/router_observation.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict, List, Optional
--- a/src/primaite/game/agent/observations/software_observation.py
+++ b/src/primaite/game/agent/observations/software_observation.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations

 from typing import Dict
--- a/src/primaite/game/agent/rewards.py
+++ b/src/primaite/game/agent/rewards.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """
 Manages the reward function for the agent.

--- a/src/primaite/game/agent/scripted_agents/init.py
+++ b/src/primaite/game/agent/scripted_agents/init.py
@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
--- a/src/primaite/game/agent/scripted_agents/data_manipulation_bot.py
+++ b/src/primaite/game/agent/scripted_agents/data_manipulation_bot.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import random
 from typing import Dict, Tuple

--- a/src/primaite/game/agent/scripted_agents/probabilistic_agent.py
+++ b/src/primaite/game/agent/scripted_agents/probabilistic_agent.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Agents with predefined behaviours."""
 from typing import Dict, Optional, Tuple

--- a/src/primaite/game/agent/scripted_agents/random_agent.py
+++ b/src/primaite/game/agent/scripted_agents/random_agent.py
@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import random
 from typing import Dict, Optional, Tuple

--- a/Show More
+++ b/Show More
				`@@ -0,0 +1 @@`
				`# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK`