allow local commands

Author: sinaatalay

rendercv_tinytex/__init__.py

@@ -4,6 +4,6 @@
 
 __version__ = "0.1.0"
 
-from .run import run_pdftex
+from .run import run_latex
 
-__all__ = ["run_pdftex"]
+__all__ = ["run_latex"]

rendercv_tinytex/run.py

@@ -1,13 +1,19 @@
 import pathlib
 import subprocess
 import sys
+from typing import Optional
 
 
-def run_pdftex(latex_file_path: pathlib.Path) -> pathlib.Path:
-    """Run TinyTeX with the given $\\LaTeX$ file to render the PDF.
+def run_latex(
+    latex_file_path: pathlib.Path, local_latex_command: Optional[str] = None
+) -> pathlib.Path:
+    """Run `pdftex` with the given $\\LaTeX$ file to render the PDF. If a local LaTeX
+    command is provided, it will be called instead of `pdftex` of TinyTeX.
 
     Args:
         latex_file_path: The path to the $\\LaTeX$ file.
+        local_latex_command: The local LaTeX command to use. If provided, it will be
+            called instead of `pdftex` of TinyTeX.
 
     Returns:
         The path to the rendered PDF file.
@@ -17,21 +23,49 @@ def run_pdftex(latex_file_path: pathlib.Path) -> pathlib.Path:
         message = f"The file {latex_file_path} doesn't exist!"
         raise FileNotFoundError(message)
 
-    tinytex_binaries_directory = (
-        pathlib.Path(__file__).parent / "tinytex-release" / "TinyTeX" / "bin"
-    )
+    if local_latex_command:
+        executable = local_latex_command
 
-    executables = {
-        "win32": tinytex_binaries_directory / "windows" / "pdflatex.exe",
-        "linux": tinytex_binaries_directory / "x86_64-linux" / "pdflatex",
-        "darwin": tinytex_binaries_directory / "universal-darwin" / "pdflatex",
-    }
+        # check if the command is working:
+        try:
+            subprocess.run(
+                [executable, "--version"],
+                stdout=subprocess.DEVNULL,  # don't capture the output
+                stderr=subprocess.DEVNULL,  # don't capture the error
+                check=True,
+            )
+        except FileNotFoundError as e:
+            message = (
+                f"{executable} isn't installed! Please install LaTeX and try again (or"
+                " don't use the [bright_black]--use-local-latex-command[/bright_black]"
+                " option)."
+            )
+            raise FileNotFoundError(message) from e
+    else:
+        tinytex_binaries_directory = (
+            pathlib.Path(__file__).parent / "tinytex-release" / "TinyTeX" / "bin"
+        )
+
+        executables = {
+            "win32": tinytex_binaries_directory / "windows" / "pdflatex.exe",
+            "linux": tinytex_binaries_directory / "x86_64-linux" / "pdflatex",
+            "darwin": tinytex_binaries_directory / "universal-darwin" / "pdflatex",
+        }
 
-    if sys.platform not in executables:
-        message = f"TinyTeX doesn't support the platform {sys.platform}!"
-        raise OSError(message)
+        if sys.platform not in executables:
+            message = f"TinyTeX doesn't support the platform {sys.platform}!"
+            raise OSError(message)
 
-    executable = executables[sys.platform]
+        executable = executables[sys.platform]
+
+        # check if the executable exists:
+        if not executable.is_file():
+            message = (
+                f"The TinyTeX executable ({executable}) doesn't exist! If you are"
+                " cloning the repository, make sure to clone it recursively to get the"
+                " TinyTeX binaries. See the developer guide for more information."
+            )
+            raise FileNotFoundError(message)
 
     # Before running LaTeX, make sure the PDF file is not open in another program,
     # that wouldn't allow LaTeX to write to it. Remove the PDF file if it exists,
@@ -63,6 +97,17 @@ def run_pdftex(latex_file_path: pathlib.Path) -> pathlib.Path:
         if latex_process.returncode != 0:
             latex_file_path_log = latex_file_path.with_suffix(".log").read_text()
 
+            if local_latex_command:
+                message = (
+                    f"The local LaTeX command {local_latex_command} couldn't render"
+                    " this LaTeX file into a PDF. Check out the log file"
+                    f" {latex_file_path.with_suffix('.log')} in the output directory"
+                    " for more information. It is printed below:\n\n"
+                )
+
+                message = message + latex_file_path_log
+                raise RuntimeError(message)
+
             message = (
                 "Failed to render the PDF file. Check out the details in the log file:"
                 f" {latex_file_path.with_suffix('.log')} \n\n"

tests/test_rendercv_tinytex.py

@@ -1,4 +1,4 @@
-from rendercv_tinytex import run_pdftex
+from rendercv_tinytex import run_latex
 
 
 def test_run_pdftex(tmp_path):
@@ -14,6 +14,6 @@ def test_run_pdftex(tmp_path):
         "\\end{document}\n"
     )
 
-    pdf_file_path = run_pdftex(latex_file_path)
+    pdf_file_path = run_latex(latex_file_path)
 
     assert pdf_file_path.is_file()