nougat-ocr-cli 0.1.0__tar.gz

nougat_ocr_cli-0.1.0/.gitignore

@@ -0,0 +1,51 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+env/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# UV
+.uv-cache/
+
+# Project specific
+prompts/
+ocr_output/
+test.pdf

nougat_ocr_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ruben Fernandez-Fuertes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nougat_ocr_cli-0.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: nougat-ocr-cli
+Version: 0.1.0
+Summary: Simple CLI wrapper for Nougat OCR with GPU acceleration support
+Project-URL: Homepage, https://github.com/rubenffuertes/nougat-ocr-cli
+Project-URL: Repository, https://github.com/rubenffuertes/nougat-ocr-cli
+Project-URL: Issues, https://github.com/rubenffuertes/nougat-ocr-cli/issues
+Author-email: Ruben Fernandez-Fuertes <fernandezfuertesruben@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: cli,document,extraction,gpu,nougat,ocr,pdf
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Text Processing :: General
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: albumentations==1.3.1
+Requires-Dist: nougat-ocr>=0.1.17
+Requires-Dist: torch>=2.0.0
+Requires-Dist: transformers>=4.30.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Nougat OCR CLI
+
+Simple, batteries-included CLI wrapper for [Nougat OCR](https://github.com/facebookresearch/nougat) with GPU acceleration.
+
+## Features
+
+- GPU acceleration (CUDA & Apple Metal)
+- Simple CLI interface
+- Batch processing support
+- Clean Markdown output
+- Automatic model downloading
+- Python API with type hints
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install nougat-ocr-cli
+```
+
+### From GitHub
+
+```bash
+pip install git+https://github.com/rubenffuertes/nougat-ocr-cli.git
+```
+
+### From source
+
+```bash
+git clone https://github.com/rubenffuertes/nougat-ocr-cli.git
+cd nougat-ocr-cli
+uv pip install -e .
+```
+
+## CLI Usage
+
+```bash
+# Basic usage - outputs to current directory
+nougat-ocr-cli document.pdf
+
+# Specify output directory
+nougat-ocr-cli document.pdf -o output/
+
+# Process specific pages (zero-indexed)
+nougat-ocr-cli document.pdf --pages 0-5
+nougat-ocr-cli document.pdf --pages 1,3,5,7
+
+# Use smaller model for faster processing
+nougat-ocr-cli document.pdf --model 0.1.0-small
+
+# Use full precision (FP32) for better accuracy
+nougat-ocr-cli document.pdf --full-precision
+
+# Set batch size manually
+nougat-ocr-cli document.pdf --batch-size 4
+```
+
+### CLI Options
+
+| Option | Description |
+|--------|-------------|
+| `input` | Input PDF file to process |
+| `-o, --output` | Output directory (default: current directory) |
+| `--model` | Model version (default: 0.1.0-base) |
+| `--batch-size` | Batch size for processing (auto-detected) |
+| `--full-precision` | Use FP32 instead of BF16 |
+| `--no-markdown` | Disable markdown post-processing |
+| `--pages` | Page range (e.g., '0-5' or '1,3,5') |
+
+## Python API
+
+```python
+from nougat_wrapper import NougatOCR
+from pathlib import Path
+
+# Initialize (loads model to GPU automatically)
+ocr = NougatOCR()
+
+# Extract text from PDF
+result = ocr.extract_text(Path("paper.pdf"))
+
+print(f"Extracted {result.pages} pages")
+print(f"Failed pages: {result.placeholder_pages}")
+print(result.text)  # Markdown output
+```
+
+### Advanced Usage
+
+```python
+ocr = NougatOCR(
+    model_tag="0.1.0-small",  # Use smaller model
+    batch_size=4,              # Process 4 pages at once
+    full_precision=True,       # Use FP32 instead of BF16
+)
+
+# Only OCR pages 0, 1, 2 (zero-indexed)
+result = ocr.extract_text(pdf_path, pages=[0, 1, 2])
+```
+
+## Requirements
+
+- Python 3.11+
+- GPU recommended (CUDA or Apple Metal)
+- ~1.3 GB for model weights (auto-downloaded)
+
+## License
+
+MIT

nougat_ocr_cli-0.1.0/README.md

@@ -0,0 +1,109 @@
+# Nougat OCR CLI
+
+Simple, batteries-included CLI wrapper for [Nougat OCR](https://github.com/facebookresearch/nougat) with GPU acceleration.
+
+## Features
+
+- GPU acceleration (CUDA & Apple Metal)
+- Simple CLI interface
+- Batch processing support
+- Clean Markdown output
+- Automatic model downloading
+- Python API with type hints
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install nougat-ocr-cli
+```
+
+### From GitHub
+
+```bash
+pip install git+https://github.com/rubenffuertes/nougat-ocr-cli.git
+```
+
+### From source
+
+```bash
+git clone https://github.com/rubenffuertes/nougat-ocr-cli.git
+cd nougat-ocr-cli
+uv pip install -e .
+```
+
+## CLI Usage
+
+```bash
+# Basic usage - outputs to current directory
+nougat-ocr-cli document.pdf
+
+# Specify output directory
+nougat-ocr-cli document.pdf -o output/
+
+# Process specific pages (zero-indexed)
+nougat-ocr-cli document.pdf --pages 0-5
+nougat-ocr-cli document.pdf --pages 1,3,5,7
+
+# Use smaller model for faster processing
+nougat-ocr-cli document.pdf --model 0.1.0-small
+
+# Use full precision (FP32) for better accuracy
+nougat-ocr-cli document.pdf --full-precision
+
+# Set batch size manually
+nougat-ocr-cli document.pdf --batch-size 4
+```
+
+### CLI Options
+
+| Option | Description |
+|--------|-------------|
+| `input` | Input PDF file to process |
+| `-o, --output` | Output directory (default: current directory) |
+| `--model` | Model version (default: 0.1.0-base) |
+| `--batch-size` | Batch size for processing (auto-detected) |
+| `--full-precision` | Use FP32 instead of BF16 |
+| `--no-markdown` | Disable markdown post-processing |
+| `--pages` | Page range (e.g., '0-5' or '1,3,5') |
+
+## Python API
+
+```python
+from nougat_wrapper import NougatOCR
+from pathlib import Path
+
+# Initialize (loads model to GPU automatically)
+ocr = NougatOCR()
+
+# Extract text from PDF
+result = ocr.extract_text(Path("paper.pdf"))
+
+print(f"Extracted {result.pages} pages")
+print(f"Failed pages: {result.placeholder_pages}")
+print(result.text)  # Markdown output
+```
+
+### Advanced Usage
+
+```python
+ocr = NougatOCR(
+    model_tag="0.1.0-small",  # Use smaller model
+    batch_size=4,              # Process 4 pages at once
+    full_precision=True,       # Use FP32 instead of BF16
+)
+
+# Only OCR pages 0, 1, 2 (zero-indexed)
+result = ocr.extract_text(pdf_path, pages=[0, 1, 2])
+```
+
+## Requirements
+
+- Python 3.11+
+- GPU recommended (CUDA or Apple Metal)
+- ~1.3 GB for model weights (auto-downloaded)
+
+## License
+
+MIT

nougat_ocr_cli-0.1.0/examples/basic_usage.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+"""Basic usage example for nougat-ocr-cli."""
+
+from nougat_wrapper import NougatOCR
+from pathlib import Path
+import sys
+
+
+def main():
+    if len(sys.argv) < 2:
+        print("Usage: python basic_usage.py <pdf_file>")
+        sys.exit(1)
+
+    pdf_path = Path(sys.argv[1])
+    if not pdf_path.exists():
+        print(f"Error: {pdf_path} not found")
+        sys.exit(1)
+
+    print(f"Initializing Nougat OCR...")
+    ocr = NougatOCR()
+
+    print(f"Processing {pdf_path.name}...")
+    result = ocr.extract_text(pdf_path)
+
+    print(f"\n{'='*60}")
+    print(f"Results:")
+    print(f"  Pages processed: {result.pages}")
+    print(f"  Pages with issues: {result.placeholder_pages}")
+    print(f"  Text length: {len(result.text):,} characters")
+    print(f"{'='*60}\n")
+
+    # Save to markdown file
+    output_path = pdf_path.with_suffix('.md')
+    output_path.write_text(result.text)
+    print(f"Saved to: {output_path}")
+
+
+if __name__ == "__main__":
+    main()

nougat_ocr_cli-0.1.0/examples/batch_processing.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python3
+"""Batch processing example for nougat-ocr-cli."""
+
+from nougat_wrapper import NougatOCR
+from pathlib import Path
+import sys
+
+
+def main():
+    if len(sys.argv) < 2:
+        print("Usage: python batch_processing.py <directory>")
+        print("Processes all PDF files in the specified directory.")
+        sys.exit(1)
+
+    input_dir = Path(sys.argv[1])
+    if not input_dir.is_dir():
+        print(f"Error: {input_dir} is not a directory")
+        sys.exit(1)
+
+    # Find all PDFs
+    pdf_files = list(input_dir.glob("*.pdf"))
+    if not pdf_files:
+        print(f"No PDF files found in {input_dir}")
+        sys.exit(1)
+
+    print(f"Found {len(pdf_files)} PDF files")
+    print(f"Initializing Nougat OCR...")
+    ocr = NougatOCR()
+
+    # Create output directory
+    output_dir = input_dir / "ocr_output"
+    output_dir.mkdir(exist_ok=True)
+
+    # Process each PDF
+    total_pages = 0
+    total_failed = 0
+
+    for i, pdf_path in enumerate(pdf_files, 1):
+        print(f"\n[{i}/{len(pdf_files)}] Processing {pdf_path.name}...")
+
+        try:
+            result = ocr.extract_text(pdf_path)
+
+            # Save output
+            output_path = output_dir / f"{pdf_path.stem}.md"
+            output_path.write_text(result.text)
+
+            total_pages += result.pages
+            total_failed += result.placeholder_pages
+
+            print(f"  ✓ Pages: {result.pages}, Failed: {result.placeholder_pages}")
+            print(f"  Saved to: {output_path}")
+
+        except Exception as e:
+            print(f"  ✗ Error: {e}")
+            continue
+
+    # Summary
+    print(f"\n{'='*60}")
+    print(f"Batch Processing Summary:")
+    print(f"  Files processed: {len(pdf_files)}")
+    print(f"  Total pages: {total_pages}")
+    print(f"  Failed pages: {total_failed}")
+    print(f"  Output directory: {output_dir}")
+    print(f"{'='*60}")
+
+
+if __name__ == "__main__":
+    main()

nougat_ocr_cli-0.1.0/pyproject.toml

@@ -0,0 +1,73 @@
+[project]
+name = "nougat-ocr-cli"
+version = "0.1.0"
+description = "Simple CLI wrapper for Nougat OCR with GPU acceleration support"
+authors = [
+    {name = "Ruben Fernandez-Fuertes", email = "fernandezfuertesruben@gmail.com"}
+]
+readme = "README.md"
+requires-python = ">=3.11"
+license = {text = "MIT"}
+keywords = ["ocr", "pdf", "nougat", "document", "extraction", "cli", "gpu"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Text Processing :: General",
+    "Topic :: Utilities",
+]
+
+dependencies = [
+    "torch>=2.0.0",
+    "nougat-ocr>=0.1.17",
+    "transformers>=4.30.0",
+    "albumentations==1.3.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "ruff>=0.1.0",
+]
+
+[project.scripts]
+nougat-ocr-cli = "nougat_wrapper.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/rubenffuertes/nougat-ocr-cli"
+Repository = "https://github.com/rubenffuertes/nougat-ocr-cli"
+Issues = "https://github.com/rubenffuertes/nougat-ocr-cli/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/nougat_wrapper"]
+
+[dependency-groups]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W"]
+ignore = []
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_functions = ["test_*"]

nougat_ocr_cli-0.1.0/src/nougat_wrapper/__init__.py

@@ -0,0 +1,6 @@
+"""Simple wrapper for Nougat OCR with GPU acceleration support."""
+
+from nougat_wrapper.core import NougatOCR, OCRResult
+
+__version__ = "0.1.0"
+__all__ = ["NougatOCR", "OCRResult", "__version__"]

nougat_ocr_cli-0.1.0/src/nougat_wrapper/__main__.py

@@ -0,0 +1,6 @@
+"""Allow running as `python -m nougat_wrapper`."""
+
+from nougat_wrapper.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())

nougat_ocr_cli-0.1.0/src/nougat_wrapper/cli.py

@@ -0,0 +1,109 @@
+"""Command-line interface for Nougat OCR."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+from nougat_wrapper.core import NougatOCR
+
+
+def main() -> int:
+    """Main entry point for the CLI."""
+    parser = argparse.ArgumentParser(
+        prog="nougat-ocr-cli",
+        description="Extract text from PDFs using Nougat OCR with GPU acceleration.",
+    )
+    parser.add_argument(
+        "input",
+        type=Path,
+        help="Input PDF file or image to process",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=Path,
+        help="Output directory for markdown files (default: current directory)",
+        default=Path.cwd(),
+    )
+    parser.add_argument(
+        "--model",
+        type=str,
+        default="0.1.0-base",
+        help="Model version to use (default: 0.1.0-base)",
+    )
+    parser.add_argument(
+        "--batch-size",
+        type=int,
+        default=None,
+        help="Batch size for processing (auto-detected if not specified)",
+    )
+    parser.add_argument(
+        "--full-precision",
+        action="store_true",
+        help="Use FP32 instead of BF16 (slower but more accurate)",
+    )
+    parser.add_argument(
+        "--no-markdown",
+        action="store_true",
+        help="Disable markdown post-processing",
+    )
+    parser.add_argument(
+        "--pages",
+        type=str,
+        default=None,
+        help="Page range to process (e.g., '0-5' or '1,3,5')",
+    )
+
+    args = parser.parse_args()
+
+    # Validate input
+    if not args.input.exists():
+        print(f"Error: Input file not found: {args.input}", file=sys.stderr)
+        return 1
+
+    # Parse pages if specified
+    pages = None
+    if args.pages:
+        pages = _parse_pages(args.pages)
+
+    # Initialize OCR
+    print(f"Loading Nougat model ({args.model})...")
+    ocr = NougatOCR(
+        model_tag=args.model,
+        batch_size=args.batch_size,
+        markdown=not args.no_markdown,
+        full_precision=args.full_precision,
+    )
+
+    # Process the file
+    print(f"Processing: {args.input}")
+    result = ocr.extract_text(args.input, pages=pages)
+
+    # Write output
+    args.output.mkdir(parents=True, exist_ok=True)
+    output_file = args.output / f"{args.input.stem}.md"
+    output_file.write_text(result.text, encoding="utf-8")
+
+    print(f"Extracted {result.pages} pages ({result.placeholder_pages} failed)")
+    print(f"Output: {output_file}")
+
+    return 0
+
+
+def _parse_pages(pages_str: str) -> list[int]:
+    """Parse page specification string into list of page numbers."""
+    pages = []
+    for part in pages_str.split(","):
+        part = part.strip()
+        if "-" in part:
+            start, end = part.split("-", 1)
+            pages.extend(range(int(start), int(end) + 1))
+        else:
+            pages.append(int(part))
+    return pages
+
+
+if __name__ == "__main__":
+    sys.exit(main())