feat(cli): make file paths multiplatform in various scripts

Author: raestrada

resumecraftr/cli/agent.py

@@ -38,7 +38,15 @@ def delete_all_resumecraftr_agents():
         console.print(f"[bold red]Error deleting agents: {e}[/bold red]")
 
 def get_vector_store_id_by_name(agent_name: str) -> str:
-    """Retrieve the vector store ID by the agent's name."""
+    """
+    Retrieve the vector store ID by the agent's name.
+
+    Args:
+        agent_name (str): The name of the agent.
+
+    Returns:
+        str: The ID of the vector store.
+    """
     vector_stores = client.beta.vector_stores.list()
     expected_name = f"{agent_name} Docs"
 
@@ -51,20 +59,36 @@ def get_vector_store_id_by_name(agent_name: str) -> str:
     )
     return None
 
-
 def load_supported_files(directory: str) -> list:
-    """Load all supported document files from the given directory and subdirectories."""
+    """
+    Load all supported document files from the given directory and subdirectories.
+
+    Args:
+        directory (str): The directory to search for files.
+
+    Returns:
+        list: A list of file paths.
+    """
     console.print(f"[bold blue]Loading documents from '{directory}'...[/bold blue]")
     files = []
     for ext in SUPPORTED_EXTENSIONS:
         files.extend(glob.glob(f"{directory}/**/*{ext}", recursive=True))
     return files
 
-
 def upload_files_to_vector_store(
     vector_store_id: str, progress: Progress = None, task=None
 ):
-    """Upload all supported files to the specified vector store."""
+    """
+    Upload all supported files to the specified vector store.
+
+    Args:
+        vector_store_id (str): The ID of the vector store.
+        progress (Progress, optional): The progress object for displaying progress.
+        task (optional): The task object for updating progress.
+
+    Returns:
+        None
+    """
     files = load_supported_files(CV_WORKSPACE)
 
     if not files:
@@ -88,9 +112,16 @@ def upload_files_to_vector_store(
         f"[bold green]Files uploaded successfully to vector store '{vector_store_id}'.[/bold green]"
     )
 
-
 def create_or_get_agent(name=None):
-    """Create or retrieve an assistant for document processing."""
+    """
+    Create or retrieve an assistant for document processing.
+
+    Args:
+        name (str, optional): The name of the agent. Defaults to None.
+
+    Returns:
+        assistant: The created or retrieved assistant.
+    """
     if not os.path.exists(CONFIG_FILE):
         console.print(
             "[bold red]Configuration file not found. Run 'resumecraftr init' first.[/bold red]"
@@ -135,11 +166,17 @@ def create_or_get_agent(name=None):
     )
     return assistant
 
-
 def execute_prompt(prompt: str, name=None) -> str:
     """
     Execute a given prompt using the AI agent, ensuring the vector database is refreshed.
     Provides real-time feedback to the user using Rich.
+
+    Args:
+        prompt (str): The prompt to send to the AI agent.
+        name (str, optional): The name of the agent. Defaults to None.
+
+    Returns:
+        str: The response from the AI agent.
     """
     assistant = create_or_get_agent(name)
     thread = client.beta.threads.create()

resumecraftr/cli/cmd/jobs_desc.py

@@ -5,9 +5,8 @@
 from rich.prompt import Prompt
 
 console = Console()
-CONFIG_FILE = "cv-workspace/resumecraftr.json"
-JOBS_DIR = "cv-workspace/job_descriptions"
-
+CONFIG_FILE = os.path.join("cv-workspace", "resumecraftr.json")
+JOBS_DIR = os.path.join("cv-workspace", "job_descriptions")
 
 @click.command()
 @click.argument("job_name")
@@ -54,6 +53,5 @@ def add_job_description(job_name, content, file):
         f"[bold green]Updated {CONFIG_FILE} with job description reference.[/bold green]"
     )
 
-
 if __name__ == "__main__":
     add_job_description()

resumecraftr/cli/cmd/latex.py

@@ -13,8 +13,6 @@
 LATEX_TEMPLATE = "cv-workspace/resume_template.tex"
 CUSTOM_PROMPT = "cv-workspace/custom.md"
 
-
-
 def check_xelatex():
     """Check if xelatex is installed and provide installation instructions if not."""
     try:
@@ -28,7 +26,6 @@ def check_xelatex():
     except (FileNotFoundError, subprocess.CalledProcessError):
         return False
 
-
 def print_xelatex_installation_guide():
     """Prints installation instructions for XeLaTeX in Markdown format using rich."""
     instructions = """
@@ -77,7 +74,6 @@ def print_xelatex_installation_guide():
 """
     console.print(Markdown(instructions))
 
-
 @click.command()
 def generate_pdf():
     """Generate a PDF resume using the optimized LaTeX template with OpenAI."""
@@ -219,12 +215,12 @@ def generate_pdf():
             check=True,
         )
         console.print(
-            f"[bold green]PDF successfully generated: {output_pdf_file}[/bold green]"
+            f"[bold green]PDF successfully generated: {output_pdf_file}[bold green]"
         )
     except subprocess.CalledProcessError as e:
         console.print(f"[bold red]Error during LaTeX compilation: {e}[bold red]")
         console.print(
-            "[bold yellow]Attempting automatic LaTeX correction...[/bold yellow]"
+            "[bold yellow]Attempting automatic LaTeX correction...[bold yellow]"
         )
 
         # Use OpenAI to correct the LaTeX document
@@ -240,7 +236,7 @@ def generate_pdf():
                 f.write(corrected_latex.replace("```latex", "").replace("```", ""))
 
             console.print(
-                f"[bold cyan]Re-compiling corrected LaTeX file: {output_tex_file}[/bold cyan]"
+                f"[bold cyan]Re-compiling corrected LaTeX file: {output_tex_file}[bold cyan]"
             )
             try:
                 subprocess.run(
@@ -253,17 +249,16 @@ def generate_pdf():
                     check=True,
                 )
                 console.print(
-                    f"[bold green]PDF successfully generated after correction: {output_pdf_file}[/bold green]"
+                    f"[bold green]PDF successfully generated after correction: {output_pdf_file}[bold green]"
                 )
             except subprocess.CalledProcessError:
                 console.print(
-                    "[bold red]Final LaTeX compilation failed. Please review the LaTeX file manually.[/bold red]"
+                    "[bold red]Final LaTeX compilation failed. Please review the LaTeX file manually.[bold red]"
                 )
         else:
             console.print(
-                "[bold red]OpenAI could not correct the LaTeX document. Manual intervention required.[/bold red]"
+                "[bold red]OpenAI could not correct the LaTeX document. Manual intervention required.[bold red]"
             )
 
-
 if __name__ == "__main__":
     generate_pdf()

resumecraftr/cli/cmd/pdf.py

@@ -9,11 +9,18 @@
 CONFIG_FILE = "cv-workspace/resumecraftr.json"
 LATEX_TEMPLATE = "cv-workspace/resume_template.tex"
 
-
 @click.command()
 @click.argument("pdf_path", type=click.Path(exists=True))
 def extract_text(pdf_path):
-    """Extract text from a PDF and save it in the workspace directory, updating the config file."""
+    """
+    Extract text from a PDF and save it in the workspace directory, updating the config file.
+
+    Args:
+        pdf_path (str): The path to the PDF file.
+
+    Returns:
+        None
+    """
     workspace_dir = "cv-workspace"
     os.makedirs(workspace_dir, exist_ok=True)
 

resumecraftr/cli/cmd/resume.py

@@ -9,8 +9,8 @@
 from resumecraftr.cli.utils.json import clean_json_response, merge_json_files
 
 console = Console()
-CONFIG_FILE = "cv-workspace/resumecraftr.json"
-OUTPUT_FILE = "cv-workspace/{0}.optimized_sections.json"
+CONFIG_FILE = os.path.join("cv-workspace", "resumecraftr.json")
+OUTPUT_FILE = os.path.join("cv-workspace", "{0}.optimized_sections.json")
 
 
 def optimize_section(config, section_name, content, job_description):

resumecraftr/cli/cmd/sections.py

@@ -12,7 +12,7 @@
 
 
 console = Console()
-CONFIG_FILE = "cv-workspace/resumecraftr.json"
+CONFIG_FILE = os.path.join("cv-workspace", "resumecraftr.json")
 try:
     with importlib.resources.path(
         "resumecraftr.templates", "sections.json"
@@ -22,7 +22,7 @@
     console.print(
         "[bold red]Error: Could not locate the sections file inside the installed package.[/bold red]"
     )
-OUTPUT_FILE = "cv-workspace/{0}.extracted_sections.json"
+OUTPUT_FILE = os.path.join("cv-workspace", "{0}.extracted_sections.json")
 
 
 def process_section(config, section_name, text_content, language):
@@ -129,7 +129,7 @@ def extract_sections():
         json.dump(extracted_data, f, indent=4, ensure_ascii=False)
 
     console.print(
-        f"[bold green]Extracted sections saved to: {OUTPUT_FILE}[/bold green]"
+        f"[bold green]Extracted sections saved to: {output_path}[/bold green]"
     )
 
 

resumecraftr/cli/main.py

@@ -14,8 +14,8 @@
 
 console = Console()
 
-CONFIG_FILE = "cv-workspace/resumecraftr.json"
-CUSTOM_FILE = "cv-workspace/custom.md"
+CONFIG_FILE = os.path.join("cv-workspace", "resumecraftr.json")
+CUSTOM_FILE = os.path.join("cv-workspace", "custom.md")
 
 try:
     with importlib.resources.path(
@@ -28,7 +28,7 @@
     )
     TEMPLATE_SRC = None
 
-TEMPLATE_DEST = "cv-workspace/resume_template.tex"
+TEMPLATE_DEST = os.path.join("cv-workspace", "resume_template.tex")
 
 DEFAULT_CONFIG = {
     "primary_language": "EN",
@@ -70,9 +70,7 @@ def init(language, gpt_model):
     config = DEFAULT_CONFIG.copy()
     config["primary_language"] = language
     config["chat_gpt"] = {
-        "model": gpt_model,
-        "temperature": 0.7,
-        "top_p": 1.0
+        "model": gpt_model
     }
 
     # Save configuration
@@ -110,7 +108,7 @@ def init(language, gpt_model):
         with open(CUSTOM_FILE, "w", encoding="utf-8") as config_file:
             config_file.writelines("PUT HERE YOUR COMPLEMENTARY INFO AND INSTRUCTIONS")
         console.print(
-            f"[bold green]CUSTOM initialized with empty:[/bold green] {CONFIG_FILE}"
+            f"[bold green]CUSTOM initialized with empty:[/bold green] {CUSTOM_FILE}"
         )
 
     # Copy LaTeX template if it doesn't exist
@@ -159,4 +157,4 @@ def delete_agents():
 cli.add_command(generate_pdf, name="toPdf")
 
 if __name__ == "__main__":
-    cli()
+    cli()