pdf_extractor CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

PDF Extractor

PDFを markdownに展開する (Convert PDF files to Markdown format)

Project Overview

A command-line tool that converts PDF files to Markdown format using pymupdf4llm. The tool supports both single file and batch processing of entire directories.

Development Commands

Setup and Dependencies

# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create virtual environment and install dependencies
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install pymupdf4llm

# Add new dependencies
uv pip install <package-name>

# Install markdownlint globally for markdown validation
npm install -g markdownlint-cli

Running the Application

# Convert a single PDF file
python -m src.pdf_extractor document.pdf -o output_folder

# Convert multiple PDF files
python -m src.pdf_extractor doc1.pdf doc2.pdf doc3.pdf -o output_folder

# Convert all PDFs in a directory
python -m src.pdf_extractor /path/to/pdf/folder -o output_folder

# Use default output directory (creates 'md' subfolder)
python -m src.pdf_extractor document.pdf

# Or use the installed command (after pip install)
pdf-extractor document.pdf

Testing

# Run all tests (once test framework is set up)
# TODO: Add test command once testing framework is chosen

# Run specific test file
# TODO: Add specific test command

Code Quality

# Format code with ruff
uv run ruff format .

# Check linting
uv run ruff check .

# Type checking with mypy
uv run mypy src/

# Validate markdown files with markdownlint
markdownlint "**/*.md"

# Fix auto-fixable markdown issues
markdownlint --fix "**/*.md"

Architecture

Core Components

1. src/pdf_extractor/ - PDF conversion module
   • cli.py: Main entry point
   • converter.py: Core conversion logic
     • Handles command-line argument parsing
     • Manages file/directory input processing
     • Coordinates the conversion workflow