article-cli 1.1.0__tar.gz → 1.2.0__tar.gz

{article_cli-1.1.0 → article_cli-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: article-cli
-Version: 1.1.0
+Version: 1.2.0
 Summary: CLI tool for managing LaTeX articles with git integration and Zotero bibliography
 Project-URL: Homepage, https://github.com/feelpp/article.cli
 Project-URL: Documentation, https://github.com/feelpp/article.cli#readme

{article_cli-1.1.0 → article_cli-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "article-cli"
-version = "1.1.0"
+version = "1.2.0"
 authors = [
     {name = "Christophe Prud'homme", email = "prudhomm@cemosis.fr"},
 ]

{article_cli-1.1.0 → article_cli-1.2.0}/src/article_cli/__init__.py

@@ -5,10 +5,10 @@ This package provides tools for:
 - Git release management with gitinfo2 support
 - Zotero bibliography synchronization
 - LaTeX build file cleanup
-- Git hooks setup
+    - Git hooks setup
 """
 
-__version__ = "1.1.0"
+__version__ = "1.2.0"
 __author__ = "Christophe Prud'homme"
 __email__ = "prudhomm@cemosis.fr"
 
@@ -19,4 +19,11 @@ from .git_manager import GitManager
 from .repository_setup import RepositorySetup
 from .latex_compiler import LaTeXCompiler
 
-__all__ = ["main", "Config", "ZoteroBibTexUpdater", "GitManager", "RepositorySetup", "LaTeXCompiler"]
+__all__ = [
+    "main",
+    "Config",
+    "ZoteroBibTexUpdater",
+    "GitManager",
+    "RepositorySetup",
+    "LaTeXCompiler",
+]

{article_cli-1.1.0 → article_cli-1.2.0}/src/article_cli/cli.py

@@ -56,9 +56,7 @@ Environment variables:
     init_parser = subparsers.add_parser(
         "init", help="Initialize repository with workflows and configuration"
     )
-    init_parser.add_argument(
-        "--title", required=True, help="Article title"
-    )
+    init_parser.add_argument("--title", required=True, help="Article title")
     init_parser.add_argument(
         "--authors",
         required=True,
@@ -86,41 +84,40 @@ Environment variables:
     subparsers.add_parser("clean", help="Clean LaTeX build files")
 
     # Compile command
-    compile_parser = subparsers.add_parser("compile", help="Compile LaTeX document using latexmk")
+    compile_parser = subparsers.add_parser(
+        "compile", help="Compile LaTeX document using latexmk"
+    )
     compile_parser.add_argument(
-        "tex_file", 
-        nargs="?", 
-        help="LaTeX file to compile (auto-detected if not specified)"
+        "tex_file",
+        nargs="?",
+        help="LaTeX file to compile (auto-detected if not specified)",
     )
     compile_parser.add_argument(
-        "--engine", 
-        choices=["latexmk", "pdflatex"], 
+        "--engine",
+        choices=["latexmk", "pdflatex"],
         default="latexmk",
-        help="LaTeX engine to use (default: latexmk)"
+        help="LaTeX engine to use (default: latexmk)",
     )
     compile_parser.add_argument(
-        "--shell-escape", 
-        action="store_true", 
-        help="Enable shell escape (for code highlighting, etc.)"
+        "--shell-escape",
+        action="store_true",
+        help="Enable shell escape (for code highlighting, etc.)",
     )
     compile_parser.add_argument(
-        "--clean-first", 
-        action="store_true", 
-        help="Clean build files before compilation"
+        "--clean-first",
+        action="store_true",
+        help="Clean build files before compilation",
     )
     compile_parser.add_argument(
-        "--clean-after", 
-        action="store_true", 
-        help="Clean build files after compilation"
+        "--clean-after", action="store_true", help="Clean build files after compilation"
     )
     compile_parser.add_argument(
-        "--watch", 
-        action="store_true", 
-        help="Watch for changes and recompile automatically"
+        "--watch",
+        action="store_true",
+        help="Watch for changes and recompile automatically",
     )
     compile_parser.add_argument(
-        "--output-dir", 
-        help="Output directory for compiled files"
+        "--output-dir", help="Output directory for compiled files"
     )
 
     # Create command
@@ -223,48 +220,50 @@ def handle_compile_command(args: argparse.Namespace, config: Config) -> int:
     """Handle the compile command"""
     try:
         from .latex_compiler import LaTeXCompiler
-        
+
         # Auto-detect tex file if not provided
         tex_file = args.tex_file
         if not tex_file:
             tex_file = _auto_detect_tex_file()
             if not tex_file:
-                print_error("No .tex file specified and none found in current directory")
+                print_error(
+                    "No .tex file specified and none found in current directory"
+                )
                 return 1
-        
+
         # Validate tex file exists
         tex_path = Path(tex_file)
         if not tex_path.exists():
             print_error(f"LaTeX file not found: {tex_file}")
             return 1
-        
+
         compiler = LaTeXCompiler(config)
-        
+
         # Clean before compilation if requested
         if args.clean_first:
             print_info("Cleaning build files before compilation...")
             git_manager = GitManager()
             latex_config = config.get_latex_config()
             git_manager.clean_latex_files(latex_config["clean_extensions"])
-        
+
         # Compile the document
         success = compiler.compile(
             tex_file=tex_file,
             engine=args.engine,
             shell_escape=args.shell_escape,
             output_dir=args.output_dir,
-            watch=args.watch
+            watch=args.watch,
         )
-        
+
         # Clean after compilation if requested
         if args.clean_after and success:
             print_info("Cleaning build files after compilation...")
             git_manager = GitManager()
             latex_config = config.get_latex_config()
             git_manager.clean_latex_files(latex_config["clean_extensions"])
-        
+
         return 0 if success else 1
-        
+
     except Exception as e:
         print_error(f"Compilation failed: {e}")
         return 1
@@ -274,18 +273,18 @@ def _auto_detect_tex_file() -> Optional[str]:
     """Auto-detect main .tex file in current directory"""
     current_dir = Path.cwd()
     tex_files = list(current_dir.glob("*.tex"))
-    
+
     if not tex_files:
         return None
-    
+
     if len(tex_files) == 1:
         return tex_files[0].name
-    
+
     # Multiple .tex files - prefer common patterns
     for pattern in ["main.tex", "article.tex", f"{current_dir.name}.tex"]:
         if (current_dir / pattern).exists():
             return pattern
-    
+
     # Return first .tex file found
     print_info(f"Multiple .tex files found, using: {tex_files[0].name}")
     return tex_files[0].name

{article_cli-1.1.0 → article_cli-1.2.0}/src/article_cli/latex_compiler.py

@@ -5,9 +5,7 @@ Provides compilation functionality that mimics LaTeX Workshop configuration
 with support for latexmk and pdflatex engines.
 """
 
-import os
 import subprocess
-import sys
 import time
 from pathlib import Path
 from typing import Dict, List, Optional
@@ -103,6 +101,8 @@ class LaTeXCompiler:
             # Stream output in real time
             try:
                 while True:
+                    if process.stdout is None:
+                        break
                     output = process.stdout.readline()
                     if output == "" and process.poll() is not None:
                         break
@@ -178,7 +178,7 @@ class LaTeXCompiler:
         try:
             # Run multiple passes for cross-references, bibliography, etc.
             passes = ["First pass", "Second pass", "Third pass"]
-            
+
             for i, pass_name in enumerate(passes):
                 print_info(f"{pass_name}...")
                 result = subprocess.run(
@@ -237,12 +237,14 @@ class LaTeXCompiler:
         # Core options (from LaTeX Workshop)
         if shell_escape:
             cmd.append("--shell-escape")
-        
-        cmd.extend([
-            "-pdf",
-            "-interaction=nonstopmode",
-            "-synctex=1",
-        ])
+
+        cmd.extend(
+            [
+                "-pdf",
+                "-interaction=nonstopmode",
+                "-synctex=1",
+            ]
+        )
 
         if output_dir:
             cmd.extend(["-outdir", output_dir])
@@ -264,11 +266,13 @@ class LaTeXCompiler:
         if shell_escape:
             cmd.append("--shell-escape")
 
-        cmd.extend([
-            "-synctex=1",
-            "-interaction=nonstopmode",
-            "-file-line-error",
-        ])
+        cmd.extend(
+            [
+                "-synctex=1",
+                "-interaction=nonstopmode",
+                "-file-line-error",
+            ]
+        )
 
         if output_dir:
             cmd.extend(["-output-directory", output_dir])
@@ -282,7 +286,10 @@ class LaTeXCompiler:
         base_name = tex_path.stem
 
         # Check if bibliography is needed
-        if "citation undefined" in latex_output.lower() or "rerun" in latex_output.lower():
+        if (
+            "citation undefined" in latex_output.lower()
+            or "rerun" in latex_output.lower()
+        ):
             # Check for .aux file to determine if we need bibtex
             aux_file = tex_path.with_suffix(".aux")
             if aux_file.exists():
@@ -306,12 +313,12 @@ class LaTeXCompiler:
             size = pdf_path.stat().st_size
             size_mb = size / (1024 * 1024)
             print_info(f"PDF size: {size_mb:.2f} MB")
-            
+
             # Show modification time
             mtime = pdf_path.stat().st_mtime
             mtime_str = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(mtime))
             print_info(f"Generated: {mtime_str}")
-            
+
         except Exception:
             pass  # Silently ignore errors getting file info
 
@@ -346,14 +353,16 @@ class LaTeXCompiler:
     def print_dependency_status(self) -> None:
         """Print status of LaTeX dependencies"""
         print_info("Checking LaTeX dependencies...")
-        
+
         deps = self.check_dependencies()
-        
+
         for tool, available in deps.items():
             status = "✅ Available" if available else "❌ Not found"
             print(f"  {tool}: {status}")
-        
+
         if not all(deps.values()):
-            print_info("\nSome LaTeX tools are missing. Install a LaTeX distribution like TeX Live.")
+            print_info(
+                "\nSome LaTeX tools are missing. Install a LaTeX distribution like TeX Live."
+            )
             print_info("On macOS: brew install --cask mactex")
-            print_info("On Ubuntu: sudo apt-get install texlive-full")
+            print_info("On Ubuntu: sudo apt-get install texlive-full")

{article_cli-1.1.0 → article_cli-1.2.0}/src/article_cli/repository_setup.py

@@ -8,10 +8,8 @@ Provides functionality to initialize LaTeX article repositories with:
 - Git hooks and configuration
 """
 
-import os
-import shutil
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import List, Optional
 
 from .zotero import print_error, print_info, print_success
 
@@ -47,23 +45,24 @@ class RepositorySetup:
         - .vscode/settings.json with LaTeX Workshop configuration
         - LTeX dictionary files for spell checking
         - hooks/post-commit for gitinfo2 integration
+        - main.tex if no .tex file exists
 
         Args:
             title: Article title
             authors: List of author names
             group_id: Zotero group ID
             force: Overwrite existing files if True
-            main_tex_file: Main .tex filename (auto-detected if None)
+            main_tex_file: Main .tex filename (auto-detected if None, created if missing)
 
         Returns:
             True if successful, False otherwise
         """
         print_info(f"Initializing repository at: {self.repo_path}")
 
-        # Detect or validate main .tex file
-        tex_file = self._detect_tex_file(main_tex_file)
+        # Detect or validate main .tex file, create if missing
+        tex_file = self._detect_or_create_tex_file(main_tex_file, title, authors, force)
         if not tex_file:
-            print_error("No main .tex file found or specified")
+            print_error("Failed to detect or create main .tex file")
             return False
 
         project_name = self.repo_path.name
@@ -113,27 +112,39 @@ class RepositorySetup:
             print_error(f"Failed to initialize repository: {e}")
             return False
 
-    def _detect_tex_file(self, specified: Optional[str]) -> Optional[str]:
+    def _detect_or_create_tex_file(
+        self, specified: Optional[str], title: str, authors: List[str], force: bool
+    ) -> Optional[str]:
         """
-        Detect main .tex file in repository
+        Detect main .tex file in repository or create one if missing
 
         Args:
             specified: User-specified filename (takes priority)
+            title: Article title (for creating new .tex file)
+            authors: List of author names (for creating new .tex file)
+            force: Overwrite existing file if True
 
         Returns:
-            Main .tex filename or None if not found
+            Main .tex filename or None on failure
         """
         if specified:
             tex_path = self.repo_path / specified
             if tex_path.exists():
                 return specified
-            print_error(f"Specified .tex file not found: {specified}")
+            # Specified file doesn't exist - create it
+            if self._create_tex_file(specified, title, authors, force):
+                return specified
             return None
 
         # Auto-detect .tex files
         tex_files = list(self.repo_path.glob("*.tex"))
 
         if not tex_files:
+            # No .tex files found - create main.tex
+            default_name = "main.tex"
+            print_info(f"No .tex file found, creating {default_name}")
+            if self._create_tex_file(default_name, title, authors, force):
+                return default_name
             return None
 
         if len(tex_files) == 1:
@@ -151,6 +162,94 @@ class RepositorySetup:
         )
         return tex_files[0].name
 
+    def _create_tex_file(
+        self, filename: str, title: str, authors: List[str], force: bool
+    ) -> bool:
+        """
+        Create a basic LaTeX article file
+
+        Args:
+            filename: Name of the .tex file to create
+            title: Article title
+            authors: List of author names
+            force: Overwrite if exists
+
+        Returns:
+            True if successful
+        """
+        tex_path = self.repo_path / filename
+
+        if tex_path.exists() and not force:
+            print_info(f"{filename} already exists (use --force to overwrite)")
+            return True
+
+        # Format authors for LaTeX
+        authors_latex = " \\and ".join(authors)
+
+        tex_content = f"""\\documentclass[a4paper,11pt]{{article}}
+
+% Essential packages
+\\usepackage[utf8]{{inputenc}}
+\\usepackage[T1]{{fontenc}}
+\\usepackage{{lmodern}}
+\\usepackage{{amsmath,amssymb,amsthm}}
+\\usepackage{{graphicx}}
+\\usepackage{{hyperref}}
+\\usepackage[margin=1in]{{geometry}}
+
+% Bibliography
+\\usepackage[style=numeric,sorting=none]{{biblatex}}
+\\addbibresource{{references.bib}}
+
+% Git version information
+\\usepackage{{gitinfo2}}
+
+% Title and authors
+\\title{{{title}}}
+\\author{{{authors_latex}}}
+\\date{{\\today}}
+
+\\begin{{document}}
+
+\\maketitle
+
+\\begin{{abstract}}
+    Your abstract goes here.
+\\end{{abstract}}
+
+\\section{{Introduction}}
+
+Your introduction goes here.
+
+\\section{{Methodology}}
+
+Your methodology goes here.
+
+\\section{{Results}}
+
+Your results go here.
+
+\\section{{Conclusion}}
+
+Your conclusion goes here.
+
+% Print bibliography
+\\printbibliography
+
+% Git information (optional - appears in footer)
+\\vfill
+\\hrule
+\\small
+\\noindent Git version: \\gitAbbrevHash{{}} (\\gitAuthorIsoDate) \\\\
+Branch: \\gitBranch
+
+\\end{{document}}
+"""
+
+        tex_path.write_text(tex_content)
+        print_success(f"Created: {tex_path.relative_to(self.repo_path)}")
+        return True
+
     def _create_directories(self) -> None:
         """Create necessary directory structure"""
         directories = [
@@ -163,9 +262,7 @@ class RepositorySetup:
             directory.mkdir(parents=True, exist_ok=True)
             print_info(f"Created directory: {directory.relative_to(self.repo_path)}")
 
-    def _create_workflow(
-        self, project_name: str, tex_file: str, force: bool
-    ) -> bool:
+    def _create_workflow(self, project_name: str, tex_file: str, force: bool) -> bool:
         """
         Create GitHub Actions workflow file
 
@@ -180,7 +277,9 @@ class RepositorySetup:
         workflow_path = self.repo_path / ".github" / "workflows" / "latex.yml"
 
         if workflow_path.exists() and not force:
-            print_info(f"Workflow already exists: {workflow_path.name} (use --force to overwrite)")
+            print_info(
+                f"Workflow already exists: {workflow_path.name} (use --force to overwrite)"
+            )
             return True
 
         # Extract base name (without .tex extension)
@@ -203,7 +302,7 @@ class RepositorySetup:
         Returns:
             Workflow YAML content
         """
-        return f'''name: Compile LaTeX and Release PDF
+        return f"""name: Compile LaTeX and Release PDF
 
 # This workflow uses article-cli for:
 # - Git hooks setup (article-cli setup)
@@ -639,7 +738,7 @@ jobs:
             echo "" >> $GITHUB_STEP_SUMMARY
             echo "Please check the workflow logs for details." >> $GITHUB_STEP_SUMMARY
           fi
-'''
+"""
 
     def _create_pyproject(
         self,
@@ -665,15 +764,13 @@ jobs:
         pyproject_path = self.repo_path / "pyproject.toml"
 
         if pyproject_path.exists() and not force:
-            print_info(
-                f"pyproject.toml already exists (use --force to overwrite)"
-            )
+            print_info(f"pyproject.toml already exists (use --force to overwrite)")
             return True
 
         # Format authors for TOML
         authors_toml = ",\n    ".join([f'{{name = "{author}"}}' for author in authors])
 
-        pyproject_content = f'''# Article Repository Dependency Management
+        pyproject_content = f"""# Article Repository Dependency Management
 # This file manages dependencies for the LaTeX article project
 
 [project]
@@ -709,7 +806,7 @@ clean_extensions = [
     ".fls", ".synctex.gz", ".toc", ".fdb_latexmk",
     ".idx", ".ilg", ".ind", ".lof", ".lot"
 ]
-'''
+"""
 
         pyproject_path.write_text(pyproject_content)
         print_success(f"Created: {pyproject_path.relative_to(self.repo_path)}")
@@ -744,7 +841,7 @@ clean_extensions = [
 
         authors_list = "\n".join([f"- {author}" for author in authors])
 
-        readme_content = f'''# {title}
+        readme_content = f"""# {title}
 
 ## Authors
 
@@ -867,7 +964,7 @@ article-cli config show
   url = {{https://github.com/feelpp/{project_name}}}
 }}
 ```
-'''
+"""
 
         readme_path.write_text(readme_content)
         print_success(f"Created: {readme_path.relative_to(self.repo_path)}")
@@ -958,10 +1055,12 @@ references.bib.backup
         vscode_settings_path = self.repo_path / ".vscode" / "settings.json"
 
         if vscode_settings_path.exists() and not force:
-            print_info(".vscode/settings.json already exists (use --force to overwrite)")
+            print_info(
+                ".vscode/settings.json already exists (use --force to overwrite)"
+            )
             return True
 
-        settings_content = '''{
+        settings_content = """{
     "latex-workshop.latex.recipes": [
         {
             "name": "latexmk-pdf",
@@ -1023,7 +1122,7 @@ references.bib.backup
     "ltex.enabled": true,
     "ltex.language": "en-US"
 }
-'''
+"""
 
         vscode_settings_path.write_text(settings_content)
         print_success(f"Created: {vscode_settings_path.relative_to(self.repo_path)}")
@@ -1059,7 +1158,9 @@ parametrical
             print_info(f"Created: {dictionary_path.relative_to(self.repo_path)}")
 
         # Hidden false positives file (empty initially)
-        false_positives_path = self.repo_path / ".vscode" / "ltex.hiddenFalsePositives.en-US.txt"
+        false_positives_path = (
+            self.repo_path / ".vscode" / "ltex.hiddenFalsePositives.en-US.txt"
+        )
         if not false_positives_path.exists() or force:
             false_positives_path.write_text("")
             print_info(f"Created: {false_positives_path.relative_to(self.repo_path)}")
@@ -1083,7 +1184,7 @@ parametrical
             return True
 
         # gitinfo2 post-commit hook
-        post_commit_content = '''#!/bin/sh
+        post_commit_content = """#!/bin/sh
 # Copyright 2015 Brent Longborough
 # Part of gitinfo2 package Version 2
 # Release 2.0.7 2015-11-22
@@ -1114,15 +1215,18 @@ git --no-pager log -1 --date=short --decorate=short \\
         firsttagdescribe={$FIRSTTAG},
         reltag={$RELTAG}
     ]{gitexinfo}" HEAD > .git/gitHeadInfo.gin
-'''
+"""
 
         post_commit_path.write_text(post_commit_content)
-        
+
         # Make the hook executable
         import stat
-        post_commit_path.chmod(post_commit_path.stat().st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
-        
+
+        post_commit_path.chmod(
+            post_commit_path.stat().st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
+        )
+
         print_success(f"Created: {post_commit_path.relative_to(self.repo_path)}")
         print_info("Made post-commit hook executable")
-        
+
         return True