Rename TOOLS_ROOT to RESOURCES_ROOT

Author: niklasmohrin

bapctools/config.py

@@ -9,6 +9,8 @@
 from pathlib import Path
 from typing import Any, Final, Literal, Optional, TypeVar
 
+import bapctools
+
 # Randomly generated uuid4 for BAPCtools
 BAPC_UUID: Final[str] = "8ee7605a-d1ce-47b3-be37-15de5acd757e"
 BAPC_UUID_PREFIX: Final[int] = 8
@@ -98,14 +100,14 @@
 
 SEED_DEPENDENCY_RETRIES: Final[int] = 10
 
-# The root directory of the BAPCtools repository.
-TOOLS_ROOT: Final[Path] = Path(__file__).absolute().parent.parent
+# The directory containing all non-python resources
+RESOURCES_ROOT: Final[Path] = Path(bapctools.__file__).parent / "resources"
 
 # The directory from which BAPCtools is invoked.
 current_working_directory: Final[Path] = Path.cwd().absolute()
 
 # Add third_party/ to the $PATH for checktestdata.
-os.environ["PATH"] += os.pathsep + str(TOOLS_ROOT / "third_party")
+os.environ["PATH"] += os.pathsep + str(RESOURCES_ROOT / "third_party")
 
 # Below here is some global state that will be filled in main().
 

bapctools/latex.py

@@ -236,7 +236,7 @@ def make_environment() -> dict[str, str]:
         Path.cwd() / "solve_stats",
         Path.cwd() / "solve_stats" / "activity",
         Path.cwd() / "latex",
-        config.TOOLS_ROOT / "latex",
+        config.RESOURCES_ROOT / "latex",
         # The default empty element at the end makes sure that the new TEXINPUTS ends with a path separator.
         # This is required to make LaTeX look in the default global paths: https://tex.stackexchange.com/a/410353
         env.get("TEXINPUTS", ""),
@@ -381,7 +381,7 @@ def build_problem_pdf(
 
     local_data = Path(main_file)
     copy_and_substitute(
-        local_data if local_data.is_file() else config.TOOLS_ROOT / "latex" / main_file,
+        local_data if local_data.is_file() else config.RESOURCES_ROOT / "latex" / main_file,
         builddir / main_file,
         problem_data(problem, language),
         bar=bar,
@@ -425,7 +425,7 @@ def find_logo() -> Path:
             logo = Path(directory + "logo." + extension)
             if logo.exists():
                 return logo
-    return config.TOOLS_ROOT / "latex" / "images" / "logo-not-found.pdf"
+    return config.RESOURCES_ROOT / "latex" / "images" / "logo-not-found.pdf"
 
 
 def build_contest_pdf(
@@ -467,7 +467,7 @@ def build_contest_pdf(
         (
             local_contest_data
             if local_contest_data.is_file()
-            else config.TOOLS_ROOT / "latex" / "contest_data.tex"
+            else config.RESOURCES_ROOT / "latex" / "contest_data.tex"
         ),
         builddir / "contest_data.tex",
         config_data,
@@ -489,7 +489,7 @@ def build_contest_pdf(
     per_problem_data_tex = (
         local_per_problem_data
         if local_per_problem_data.is_file()
-        else config.TOOLS_ROOT / "latex" / local_per_problem_data.name
+        else config.RESOURCES_ROOT / "latex" / local_per_problem_data.name
     ).read_text()
 
     for prob in problems:

bapctools/problem.py

@@ -1099,7 +1099,7 @@ def _validators(
             if problem.custom_output:
                 paths = [problem.path / validate.OutputValidator.source_dir]
             else:
-                paths = [config.TOOLS_ROOT / "support" / "default_output_validator.cpp"]
+                paths = [config.RESOURCES_ROOT / "support" / "default_output_validator.cpp"]
         else:
             paths = list(glob(problem.path / cls.source_dir, "*"))
 

bapctools/program.py

@@ -149,7 +149,7 @@ def languages() -> Sequence[Language]:
         if Path("languages.yaml").is_file():
             raw_languages = read_yaml(Path("languages.yaml"))
         else:
-            raw_languages = read_yaml(config.TOOLS_ROOT / "config/languages.yaml")
+            raw_languages = read_yaml(config.RESOURCES_ROOT / "config/languages.yaml")
         if not isinstance(raw_languages, dict):
             fatal("could not parse languages.yaml.")
 
@@ -372,7 +372,7 @@ def _get_language(self, bar: ProgressBar) -> bool:
                     self.tmpdir / "build" if (self.tmpdir / "build") in self.input_files else ""
                 ),
                 "run": self.tmpdir / "run",
-                "viva_jar": config.TOOLS_ROOT / "third_party/viva/viva.jar",
+                "viva_jar": config.RESOURCES_ROOT / "third_party/viva/viva.jar",
             }
 
             return True

bapctools/skel.py

@@ -62,15 +62,15 @@ def new_contest() -> None:
     rights_owner = f"rights_owner: {rights_owner}\n" if rights_owner else ""
     title = title.replace("_", "-")
 
-    skeldir = config.TOOLS_ROOT / "skel/contest"
+    skeldir = config.RESOURCES_ROOT / "skel/contest"
     log(f"Copying {skeldir} to {dirname}.")
     copytree_and_substitute(
         skeldir, Path(dirname), locals(), exist_ok=False, preserve_symlinks=False
     )
 
 
 def get_skel_dir(target_dir: Path) -> tuple[Path, bool]:
-    skeldir = config.TOOLS_ROOT / "skel/problem"
+    skeldir = config.RESOURCES_ROOT / "skel/problem"
     preserve_symlinks = False
     if (target_dir / "skel/problem").is_dir():
         skeldir = target_dir / "skel/problem"
@@ -311,12 +311,12 @@ def problem_source_dir(problem: Problem) -> Path:
         return problem.path.absolute().relative_to(git_root_path)
 
     if config.args.latest_bt:
-        header_yml = (config.TOOLS_ROOT / "skel/gitlab_ci/header_latest_bt.yaml").read_text()
+        header_yml = (config.RESOURCES_ROOT / "skel/gitlab_ci/header_latest_bt.yaml").read_text()
     else:
-        header_yml = (config.TOOLS_ROOT / "skel/gitlab_ci/header_docker_bt.yaml").read_text()
+        header_yml = (config.RESOURCES_ROOT / "skel/gitlab_ci/header_docker_bt.yaml").read_text()
     print(header_yml)
 
-    contest_yml = (config.TOOLS_ROOT / "skel/gitlab_ci/contest.yaml").read_text()
+    contest_yml = (config.RESOURCES_ROOT / "skel/gitlab_ci/contest.yaml").read_text()
     contest_path = Path(".").absolute().relative_to(git_root_path)
     changes = "".join(
         f"      - {problem_source_dir(problem)}/{pdf_type.path().parent}/**/*\n"
@@ -329,7 +329,7 @@ def problem_source_dir(problem: Problem) -> Path:
         )
     )
 
-    problem_yml = (config.TOOLS_ROOT / "skel/gitlab_ci/problem.yaml").read_text()
+    problem_yml = (config.RESOURCES_ROOT / "skel/gitlab_ci/problem.yaml").read_text()
     for problem_obj in problems:
         problem_path = problem_source_dir(problem_obj)
         problem = problem_obj.name
@@ -351,9 +351,9 @@ def create_forgejo_actions(contest: str, problems: list[Problem]) -> None:
         fatal(".git and ../.git not found after changing to contest directory.")
 
     if config.args.latest_bt:
-        src = config.TOOLS_ROOT / "skel/forgejo_actions_latest_bt"
+        src = config.RESOURCES_ROOT / "skel/forgejo_actions_latest_bt"
     else:
-        src = config.TOOLS_ROOT / "skel/forgejo_actions_docker_bt"
+        src = config.RESOURCES_ROOT / "skel/forgejo_actions_docker_bt"
 
     if config.args.latest_bt:
         # Copy the 'setup' action:
@@ -403,7 +403,7 @@ def create_github_actions(contest: str, problems: list[Problem]) -> None:
 
     # Copy the contest-level workflow.
     contest_workflow_source = (
-        config.TOOLS_ROOT / "skel/forgejo_actions_docker_bt/contest.yaml"
+        config.RESOURCES_ROOT / "skel/forgejo_actions_docker_bt/contest.yaml"
     ).read_text()
     contest_workflow = substitute(
         contest_workflow_source, {"contest": contest, "contest_path": str(contest_path)}
@@ -417,7 +417,7 @@ def create_github_actions(contest: str, problems: list[Problem]) -> None:
 
     # Copy the problem-level workflows.
     problem_workflow_source = (
-        config.TOOLS_ROOT / "skel/forgejo_actions_docker_bt/problem.yaml"
+        config.RESOURCES_ROOT / "skel/forgejo_actions_docker_bt/problem.yaml"
     ).read_text()
     for problem_obj in problems:
         problem = problem_obj.name