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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: article-cli
-Version: 1.0.3
+Version: 1.1.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
@@ -63,11 +63,15 @@ A command-line tool for managing LaTeX articles with git integration and Zotero
 
 ## Features
 
+- **Repository Initialization**: Complete setup for LaTeX article projects with one command
+- **LaTeX Compilation**: Compile documents with latexmk/pdflatex, watch mode, shell escape support
+- **GitHub Actions Workflows**: Automated PDF compilation, artifact upload, and GitHub releases
 - **Git Release Management**: Create, list, and delete releases with gitinfo2 support
 - **Zotero Integration**: Synchronize bibliography from Zotero with robust pagination and error handling
 - **LaTeX Build Management**: Clean build files and manage LaTeX compilation artifacts
 - **Git Hooks Setup**: Automated setup of git hooks for gitinfo2 integration
-- **Local Configuration**: Support for project-specific configuration files
+- **Project Configuration**: Auto-generates pyproject.toml with article-cli settings
+- **Documentation**: Creates README with build instructions and usage guide
 
 ## Installation
 
@@ -87,12 +91,43 @@ pip install -e .
 
 ## Quick Start
 
+### For New Projects
+
+1. **Initialize your LaTeX article repository**:
+   ```bash
+   cd your-article-repo
+   article-cli init --title "Your Article Title" --authors "Author One,Author Two"
+   ```
+
+   This creates:
+   - `.github/workflows/latex.yml` - Complete CI/CD pipeline
+   - `pyproject.toml` - Project configuration with article-cli settings
+   - `README.md` - Documentation and usage instructions
+   - `.gitignore` - LaTeX-specific ignore rules
+   - `.vscode/settings.json` - LaTeX Workshop configuration
+   - `.vscode/ltex.dictionary.en-US.txt` - Custom dictionary
+
+2. **Configure Zotero** (add as GitHub secret):
+   ```bash
+   export ZOTERO_API_KEY="your_api_key_here"
+   ```
+
+3. **Setup git hooks and update bibliography**:
+   ```bash
+   article-cli setup
+   article-cli update-bibtex
+   ```
+
+4. **Commit and push** to trigger automated PDF compilation!
+
+### For Existing Projects
+
 1. **Setup git hooks** (run once per repository):
    ```bash
    article-cli setup
    ```
 
-2. **Configure Zotero credentials** (one-time setup):
+2. **Configure Zotero credentials**:
    ```bash
    export ZOTERO_API_KEY="your_api_key_here"
    export ZOTERO_GROUP_ID="your_group_id"  # or ZOTERO_USER_ID
@@ -137,6 +172,29 @@ clean_extensions = [".aux", ".bbl", ".blg", ".log", ".out", ".synctex.gz"]
 
 ## Usage
 
+### Repository Initialization
+
+```bash
+# Initialize a new article repository (auto-detects main .tex file)
+article-cli init --title "My Article Title" --authors "John Doe,Jane Smith"
+
+# Specify custom Zotero group ID
+article-cli init --title "My Article" --authors "Author" --group-id 1234567
+
+# Specify main .tex file explicitly
+article-cli init --title "My Article" --authors "Author" --tex-file article.tex
+
+# Force overwrite existing files
+article-cli init --title "My Article" --authors "Author" --force
+```
+
+The `init` command sets up:
+- **GitHub Actions workflow** for automated PDF compilation and releases
+- **pyproject.toml** with dependencies and article-cli configuration
+- **README.md** with comprehensive documentation
+- **.gitignore** with LaTeX-specific patterns
+- **VS Code configuration** for LaTeX Workshop with auto-build and SyncTeX
+
 ### Git Release Management
 
 ```bash
@@ -163,6 +221,31 @@ article-cli update-bibtex --output my-refs.bib
 article-cli update-bibtex --no-backup
 ```
 
+### LaTeX Compilation
+
+```bash
+# Compile with latexmk (default engine)
+article-cli compile
+
+# Compile specific file with latexmk
+article-cli compile main.tex
+
+# Compile with pdflatex engine
+article-cli compile --engine pdflatex
+
+# Enable shell escape (for code highlighting, etc.)
+article-cli compile --shell-escape
+
+# Watch for changes and auto-recompile
+article-cli compile --watch
+
+# Clean before and after compilation
+article-cli compile --clean-first --clean-after
+
+# Specify output directory
+article-cli compile --output-dir build/
+```
+
 ### Project Setup
 
 ```bash

{article_cli-1.0.3 → article_cli-1.1.0}/README.md

@@ -8,11 +8,15 @@ A command-line tool for managing LaTeX articles with git integration and Zotero
 
 ## Features
 
+- **Repository Initialization**: Complete setup for LaTeX article projects with one command
+- **LaTeX Compilation**: Compile documents with latexmk/pdflatex, watch mode, shell escape support
+- **GitHub Actions Workflows**: Automated PDF compilation, artifact upload, and GitHub releases
 - **Git Release Management**: Create, list, and delete releases with gitinfo2 support
 - **Zotero Integration**: Synchronize bibliography from Zotero with robust pagination and error handling
 - **LaTeX Build Management**: Clean build files and manage LaTeX compilation artifacts
 - **Git Hooks Setup**: Automated setup of git hooks for gitinfo2 integration
-- **Local Configuration**: Support for project-specific configuration files
+- **Project Configuration**: Auto-generates pyproject.toml with article-cli settings
+- **Documentation**: Creates README with build instructions and usage guide
 
 ## Installation
 
@@ -32,12 +36,43 @@ pip install -e .
 
 ## Quick Start
 
+### For New Projects
+
+1. **Initialize your LaTeX article repository**:
+   ```bash
+   cd your-article-repo
+   article-cli init --title "Your Article Title" --authors "Author One,Author Two"
+   ```
+
+   This creates:
+   - `.github/workflows/latex.yml` - Complete CI/CD pipeline
+   - `pyproject.toml` - Project configuration with article-cli settings
+   - `README.md` - Documentation and usage instructions
+   - `.gitignore` - LaTeX-specific ignore rules
+   - `.vscode/settings.json` - LaTeX Workshop configuration
+   - `.vscode/ltex.dictionary.en-US.txt` - Custom dictionary
+
+2. **Configure Zotero** (add as GitHub secret):
+   ```bash
+   export ZOTERO_API_KEY="your_api_key_here"
+   ```
+
+3. **Setup git hooks and update bibliography**:
+   ```bash
+   article-cli setup
+   article-cli update-bibtex
+   ```
+
+4. **Commit and push** to trigger automated PDF compilation!
+
+### For Existing Projects
+
 1. **Setup git hooks** (run once per repository):
    ```bash
    article-cli setup
    ```
 
-2. **Configure Zotero credentials** (one-time setup):
+2. **Configure Zotero credentials**:
    ```bash
    export ZOTERO_API_KEY="your_api_key_here"
    export ZOTERO_GROUP_ID="your_group_id"  # or ZOTERO_USER_ID
@@ -82,6 +117,29 @@ clean_extensions = [".aux", ".bbl", ".blg", ".log", ".out", ".synctex.gz"]
 
 ## Usage
 
+### Repository Initialization
+
+```bash
+# Initialize a new article repository (auto-detects main .tex file)
+article-cli init --title "My Article Title" --authors "John Doe,Jane Smith"
+
+# Specify custom Zotero group ID
+article-cli init --title "My Article" --authors "Author" --group-id 1234567
+
+# Specify main .tex file explicitly
+article-cli init --title "My Article" --authors "Author" --tex-file article.tex
+
+# Force overwrite existing files
+article-cli init --title "My Article" --authors "Author" --force
+```
+
+The `init` command sets up:
+- **GitHub Actions workflow** for automated PDF compilation and releases
+- **pyproject.toml** with dependencies and article-cli configuration
+- **README.md** with comprehensive documentation
+- **.gitignore** with LaTeX-specific patterns
+- **VS Code configuration** for LaTeX Workshop with auto-build and SyncTeX
+
 ### Git Release Management
 
 ```bash
@@ -108,6 +166,31 @@ article-cli update-bibtex --output my-refs.bib
 article-cli update-bibtex --no-backup
 ```
 
+### LaTeX Compilation
+
+```bash
+# Compile with latexmk (default engine)
+article-cli compile
+
+# Compile specific file with latexmk
+article-cli compile main.tex
+
+# Compile with pdflatex engine
+article-cli compile --engine pdflatex
+
+# Enable shell escape (for code highlighting, etc.)
+article-cli compile --shell-escape
+
+# Watch for changes and auto-recompile
+article-cli compile --watch
+
+# Clean before and after compilation
+article-cli compile --clean-first --clean-after
+
+# Specify output directory
+article-cli compile --output-dir build/
+```
+
 ### Project Setup
 
 ```bash

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

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

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

@@ -8,7 +8,7 @@ This package provides tools for:
 - Git hooks setup
 """
 
-__version__ = "1.0.3"
+__version__ = "1.1.0"
 __author__ = "Christophe Prud'homme"
 __email__ = "prudhomm@cemosis.fr"
 
@@ -16,5 +16,7 @@ from .cli import main
 from .config import Config
 from .zotero import ZoteroBibTexUpdater
 from .git_manager import GitManager
+from .repository_setup import RepositorySetup
+from .latex_compiler import LaTeXCompiler
 
-__all__ = ["main", "Config", "ZoteroBibTexUpdater", "GitManager"]
+__all__ = ["main", "Config", "ZoteroBibTexUpdater", "GitManager", "RepositorySetup", "LaTeXCompiler"]

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

@@ -13,6 +13,7 @@ from . import __version__
 from .config import Config
 from .zotero import ZoteroBibTexUpdater, print_error, print_info
 from .git_manager import GitManager
+from .repository_setup import RepositorySetup
 
 
 def create_parser() -> argparse.ArgumentParser:
@@ -23,8 +24,13 @@ def create_parser() -> argparse.ArgumentParser:
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog="""
 Examples:
+  %(prog)s init --title "My Article" --authors "John Doe,Jane Smith"
   %(prog)s setup                          # Setup git hooks
   %(prog)s clean                          # Clean build files
+  %(prog)s compile main.tex               # Compile with latexmk
+  %(prog)s compile --engine pdflatex      # Compile with pdflatex
+  %(prog)s compile --shell-escape         # Enable shell escape
+  %(prog)s compile --watch                # Watch and auto-recompile
   %(prog)s create v1.0.0                  # Create release v1.0.0
   %(prog)s list --count 10                # List 10 recent releases
   %(prog)s delete v1.0.0                  # Delete release
@@ -46,12 +52,77 @@ Environment variables:
 
     subparsers = parser.add_subparsers(dest="command", help="Command to execute")
 
+    # Init command
+    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(
+        "--authors",
+        required=True,
+        help='Comma-separated list of authors (e.g., "John Doe,Jane Smith")',
+    )
+    init_parser.add_argument(
+        "--group-id",
+        default="4678293",
+        help="Zotero group ID (default: 4678293 for article.template)",
+    )
+    init_parser.add_argument(
+        "--tex-file",
+        help="Main .tex file (auto-detected if not specified)",
+    )
+    init_parser.add_argument(
+        "--force",
+        action="store_true",
+        help="Overwrite existing files",
+    )
+
     # Setup command
     subparsers.add_parser("setup", help="Setup git hooks for gitinfo2")
 
     # Clean command
     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.add_argument(
+        "tex_file", 
+        nargs="?", 
+        help="LaTeX file to compile (auto-detected if not specified)"
+    )
+    compile_parser.add_argument(
+        "--engine", 
+        choices=["latexmk", "pdflatex"], 
+        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.)"
+    )
+    compile_parser.add_argument(
+        "--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"
+    )
+    compile_parser.add_argument(
+        "--watch", 
+        action="store_true", 
+        help="Watch for changes and recompile automatically"
+    )
+    compile_parser.add_argument(
+        "--output-dir", 
+        help="Output directory for compiled files"
+    )
+
     # Create command
     create_parser = subparsers.add_parser("create", help="Create a new release")
     create_parser.add_argument("version", help="Version tag (e.g., v1.0.0)")
@@ -102,6 +173,29 @@ Environment variables:
     return parser
 
 
+def handle_init_command(args: argparse.Namespace, config: Config) -> int:
+    """Handle the init command"""
+    try:
+        # Parse comma-separated authors
+        authors = [a.strip() for a in args.authors.split(",")]
+
+        repo_setup = RepositorySetup()
+        return (
+            0
+            if repo_setup.init_repository(
+                title=args.title,
+                authors=authors,
+                group_id=args.group_id,
+                force=args.force,
+                main_tex_file=args.tex_file,
+            )
+            else 1
+        )
+    except Exception as e:
+        print_error(f"Failed to initialize repository: {e}")
+        return 1
+
+
 def handle_setup_command(config: Config) -> int:
     """Handle the setup command"""
     try:
@@ -125,6 +219,78 @@ def handle_clean_command(config: Config) -> int:
         return 1
 
 
+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")
+                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
+        )
+        
+        # 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
+
+
+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
+
+
 def handle_create_command(args: argparse.Namespace, config: Config) -> int:
     """Handle the create command"""
     try:
@@ -235,6 +401,9 @@ def handle_config_command(args: argparse.Namespace, config: Config) -> int:
                 f"  Clean Extensions: {len(latex_config['clean_extensions'])} extensions"
             )
             print(f"  Build Directory: {latex_config['build_dir']}")
+            print(f"  Engine: {latex_config['engine']}")
+            print(f"  Shell Escape: {latex_config['shell_escape']}")
+            print(f"  Timeout: {latex_config['timeout']}s")
 
             return 0
         except Exception as e:
@@ -271,12 +440,18 @@ def main(argv: Optional[list] = None) -> int:
 
     # Route to appropriate command handler
     try:
-        if args.command == "setup":
+        if args.command == "init":
+            return handle_init_command(args, config)
+
+        elif args.command == "setup":
             return handle_setup_command(config)
 
         elif args.command == "clean":
             return handle_clean_command(config)
 
+        elif args.command == "compile":
+            return handle_compile_command(args, config)
+
         elif args.command == "create":
             return handle_create_command(args, config)
 

{article_cli-1.0.3 → article_cli-1.1.0}/src/article_cli/config.py

@@ -169,6 +169,9 @@ class Config:
                 "latex", "clean_extensions", default_extensions
             ),
             "build_dir": self.get("latex", "build_dir", "."),
+            "engine": self.get("latex", "engine", "latexmk"),
+            "shell_escape": self.get("latex", "shell_escape", False),
+            "timeout": self.get("latex", "timeout", 300),
         }
 
     def validate_zotero_config(
@@ -261,6 +264,15 @@ clean_extensions = [
 
 # Build directory (relative to project root)
 build_dir = "."
+
+# Default LaTeX engine
+engine = "latexmk"  # Options: "latexmk", "pdflatex"
+
+# Enable shell escape by default
+shell_escape = false
+
+# Compilation timeout in seconds
+timeout = 300
 """
 
         try: