Added version command and revamped a few things

Author: MOBergeron

ctf/__init__.py

@@ -1 +1,45 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python3
+import importlib.metadata
+import logging
+import os
+
+import coloredlogs
+
+ENV = {}
+for k, v in os.environ.items():
+    ENV[k] = v
+
+VERSION = importlib.metadata.version("ctf-script")
+
+LOG = logging.getLogger()
+LOG.setLevel(level=logging.DEBUG)
+coloredlogs.install(level="DEBUG", logger=LOG)
+
+
+def find_ctf_root_directory() -> str:
+    path = os.path.join(os.getcwd(), ".")
+
+    while path != (path := os.path.dirname(p=path)):
+        dir = os.listdir(path=path)
+
+        if ".git" not in dir:
+            continue
+        if ".deploy" not in dir:
+            continue
+        if "challenges" not in dir:
+            continue
+        break
+
+    if path == "/":
+        if "CTF_ROOT_DIR" not in os.environ:
+            LOG.critical(
+                msg='Could not automatically find the root directory nor the "CTF_ROOT_DIR" environment variable.'
+            )
+            exit(1)
+        return os.environ.get("CTF_ROOT_DIR", default=".")
+
+    LOG.debug(msg=f"Found root directory: {path}")
+    return path
+
+
+CTF_ROOT_DIRECTORY = find_ctf_root_directory()

ctf/__main__.py

@@ -3,7 +3,6 @@
 import csv
 import io
 import json
-import logging
 import os
 import re
 import secrets
@@ -14,17 +13,16 @@
 from enum import Enum, unique
 
 import argcomplete
-import coloredlogs
 import jinja2
 import yaml
 from tabulate import tabulate
 
+from ctf import CTF_ROOT_DIRECTORY, ENV, LOG, VERSION
 from ctf.utils import (
     add_tracks_to_terraform_modules,
     available_incus_remotes,
     check_git_lfs,
     create_terraform_modules_file,
-    find_ctf_root_directory,
     get_all_available_tracks,
     get_ctf_script_schemas_directory,
     get_ctf_script_templates_directory,
@@ -47,13 +45,6 @@
 except ImportError:
     _has_pybadges = False
 
-LOG = logging.getLogger()
-LOG.setLevel(level=logging.DEBUG)
-coloredlogs.install(level="DEBUG", logger=LOG)
-
-ENV = {}
-
-CTF_ROOT_DIRECTORY = find_ctf_root_directory()
 TEMPLATES_ROOT_DIRECTORY = get_ctf_script_templates_directory()
 SCHEMAS_ROOT_DIRECTORY = get_ctf_script_schemas_directory()
 AVAILABLE_INCUS_REMOTES = available_incus_remotes()
@@ -1145,6 +1136,11 @@ def write_badge(name: str, svg: str) -> None:
         f.write(svg)
 
 
+def version(args: argparse.Namespace) -> None:
+    print(VERSION)
+    exit(code=0)
+
+
 def main():
     # Command line parsing.
     parser = argparse.ArgumentParser(
@@ -1154,6 +1150,12 @@ def main():
 
     subparsers = parser.add_subparsers(required=True)
 
+    parser_version = subparsers.add_parser(
+        "version",
+        help="Script version.",
+    )
+    parser_version.set_defaults(func=version)
+
     parser_flags = subparsers.add_parser(
         "flags",
         help="Get flags from tracks",
@@ -1365,8 +1367,8 @@ def main():
 
     args = parser.parse_args()
 
-    for k, v in os.environ.items():
-        ENV[k] = v
+    if args.func.__name__ == "version":
+        args.func(args=args)
 
     if "remote" in args and args.remote:
         ENV["INCUS_REMOTE"] = args.remote

ctf/utils.py

@@ -1,18 +1,14 @@
-import logging
 import os
 import re
 import subprocess
 import textwrap
 from typing import Any, Generator
 
-import coloredlogs
 import jinja2
+import tomllib
 import yaml
 
-LOG = logging.getLogger()
-LOG.addHandler(hdlr=logging.StreamHandler())
-LOG.setLevel(level=logging.DEBUG)
-coloredlogs.install(level="DEBUG", logger=LOG)
+from ctf import CTF_ROOT_DIRECTORY
 
 
 def available_incus_remotes() -> list[str]:
@@ -31,35 +27,6 @@ def check_git_lfs() -> bool:
     return not bool(subprocess.run(args=["git", "lfs"], capture_output=True).returncode)
 
 
-def find_ctf_root_directory() -> str:
-    path = os.path.join(os.getcwd(), ".")
-
-    while path != (path := os.path.dirname(p=path)):
-        dir = os.listdir(path=path)
-
-        if ".git" not in dir:
-            continue
-        if ".deploy" not in dir:
-            continue
-        if "challenges" not in dir:
-            continue
-        break
-
-    if path == "/":
-        if "CTF_ROOT_DIR" not in os.environ:
-            LOG.critical(
-                msg='Could not automatically find the root directory nor the "CTF_ROOT_DIR" environment variable.'
-            )
-            exit(1)
-        return os.environ.get("CTF_ROOT_DIR", default=".")
-
-    LOG.debug(msg=f"Found root directory: {path}")
-    return path
-
-
-CTF_ROOT_DIRECTORY = find_ctf_root_directory()
-
-
 def get_all_available_tracks() -> set[str]:
     tracks = set()
 

ctf/validators.py

@@ -4,16 +4,14 @@
 import re
 from dataclasses import dataclass
 
+from ctf import CTF_ROOT_DIRECTORY
 from ctf.utils import (
-    find_ctf_root_directory,
     get_all_file_paths_recursively,
     parse_post_yamls,
     parse_track_yaml,
     remove_ctf_script_root_directory_from_path,
 )
 
-CTF_ROOT_DIRECTORY = find_ctf_root_directory()
-
 
 @dataclass
 class ValidationError:

pyproject.toml

@@ -18,7 +18,7 @@ dependencies = [
     "black",
     "tabulate==0.9.0",
 ]
-version = "1.0.0"
+version = "2025.5.0"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",