namingpaper 0.1.0

CLI tool to rename academic papers using AI-extracted metadata

namingpaper

A CLI tool that renames academic PDF papers using AI-extracted metadata.

Before: 1-s2.0-S0304405X13000044-main.pdf

After: Fama, French, (1993, JFE), Common risk factors in the returns....pdf

Features

• Extracts metadata (authors, year, journal, title) from PDFs using AI
• Supports multiple AI providers: Claude, OpenAI, Gemini, and Ollama (local)
• Batch processing - rename entire directories at once
• Custom templates - flexible filename formatting
• Dry-run mode by default for safety
• Copy to output directory (keeps original file)
• Handles filename collisions (skip, increment, or overwrite)
• Common journal abbreviations (JFE, AER, QJE, etc.)

Installation

# Install from source
git clone https://github.com/DanTsai0903/namingpaper.git
cd namingpaper
uv sync

# With optional providers
uv sync --extra openai    # OpenAI support
uv sync --extra gemini    # Gemini support

Quick Start

# Default uses Ollama (local, no API key needed)
# Make sure Ollama is running with the required models
ollama pull deepseek-ocr
ollama pull llama3.1:8b

# Preview the rename (dry run)
namingpaper rename paper.pdf

# Actually rename the file
namingpaper rename paper.pdf --execute

# Batch rename all PDFs in a directory
namingpaper batch ~/Downloads/papers --execute

Using Cloud Providers

If you want to use Claude, OpenAI, or Gemini instead of local Ollama:

# Option 1: Set environment variable (temporary, current session only)
export NAMINGPAPER_ANTHROPIC_API_KEY=sk-ant-api03-xxxxx
namingpaper rename paper.pdf -p claude

# Option 2: Add to shell profile (permanent)
# For zsh (macOS default):
echo 'export NAMINGPAPER_ANTHROPIC_API_KEY=sk-ant-api03-xxxxx' >> ~/.zshrc
source ~/.zshrc

# For bash:
echo 'export NAMINGPAPER_ANTHROPIC_API_KEY=sk-ant-api03-xxxxx' >> ~/.bashrc
source ~/.bashrc

# Option 3: Use config file (~/.namingpaper/config.toml)
mkdir -p ~/.namingpaper
cat > ~/.namingpaper/config.toml << EOF
ai_provider = "claude"
anthropic_api_key = "sk-ant-api03-xxxxx"
EOF

Usage

Rename Command

Rename a single PDF file.

namingpaper rename <pdf_path> [OPTIONS]

Options:
  -x, --execute              Actually rename (default is dry-run)
  -y, --yes                  Skip confirmation prompt
  -p, --provider TEXT        AI provider (claude, openai, gemini, ollama)
  -o, --output-dir DIR       Copy to directory (keeps original)
  -c, --collision STRATEGY   Handle collisions: skip, increment, overwrite

Batch Command

Rename multiple PDF files in a directory.

namingpaper batch <directory> [OPTIONS]

Options:
  -x, --execute              Actually rename (default is dry-run)
  -y, --yes                  Skip confirmation prompt
  -r, --recursive            Scan subdirectories
  -f, --filter PATTERN       Only process files matching pattern (e.g., '2023*')
  -p, --provider TEXT        AI provider (claude, openai, gemini, ollama)
  -t, --template TEXT        Filename template or preset name
  -o, --output-dir DIR       Copy to directory (keeps originals)
  -c, --collision STRATEGY   Handle collisions: skip, increment, overwrite
  --parallel N               Concurrent extractions (default: 1)
  --json                     Output results as JSON

Templates Command

Show available filename templates.

namingpaper templates

Examples

Single File

# Dry run with Ollama (default)
namingpaper rename paper.pdf

# Execute rename
namingpaper rename paper.pdf --execute

# Copy to a different folder (keeps original)
namingpaper rename paper.pdf -o ~/Papers --execute

# Use Claude
namingpaper rename paper.pdf -p claude --execute

# Use OpenAI
namingpaper rename paper.pdf -p openai --execute

# Auto-increment on collision
namingpaper rename paper.pdf -c increment --execute

# Skip confirmation
namingpaper rename paper.pdf -xy

Batch Processing

# Preview all renames in a directory
namingpaper batch ~/Downloads/papers

# Execute batch rename
namingpaper batch ~/Downloads/papers --execute

# Recursive scan with subdirectories
namingpaper batch ~/Downloads/papers -r --execute

# Filter by pattern (only 2023 papers)
namingpaper batch ~/Downloads/papers -f "2023*" --execute

# Use compact template
namingpaper batch ~/Downloads/papers -t compact --execute

# Custom template
namingpaper batch ~/Downloads/papers -t "{year} - {authors} - {title}" --execute

# Copy to organized folder
namingpaper batch ~/Downloads -o ~/Papers/Organized --execute

# Parallel processing (faster)
namingpaper batch ~/Downloads/papers --parallel 4 --execute

# Output as JSON (for scripting)
namingpaper batch ~/Downloads/papers --json

View Configuration

namingpaper config --show

Filename Templates

Templates control how the output filename is formatted.

Preset Templates

Name	Pattern	Example
default	{authors}, ({year}, {journal}), {title}	Fama, French, (1993, JFE), Common risk....pdf
compact	{authors} ({year}) {title}	Fama, French (1993) Common risk....pdf
full	{authors}, ({year}, {journal_full}), {title}	Fama, French, (1993, Journal of Financial Economics), Common....pdf
simple	{authors}_{year}_{title}	Fama, French_1993_Common risk....pdf

Template Placeholders

Placeholder	Description
{authors}	Author surnames (comma-separated, "et al" if >3)
{year}	Publication year
{journal}	Journal abbreviation (or full name if no abbrev)
{journal_abbrev}	Journal abbreviation only
{journal_full}	Full journal name
{title}	Paper title (truncated)

Custom Templates

# Year-first format
namingpaper batch ~/papers -t "{year} - {authors} - {title}"

# Minimal format
namingpaper batch ~/papers -t "{authors} {year}"

# Full journal name
namingpaper batch ~/papers -t "{authors}, ({year}, {journal_full}), {title}"

Configuration

Environment Variables

Variable	Description
NAMINGPAPER_ANTHROPIC_API_KEY	Anthropic API key (for Claude)
NAMINGPAPER_OPENAI_API_KEY	OpenAI API key
NAMINGPAPER_GEMINI_API_KEY	Google Gemini API key
NAMINGPAPER_AI_PROVIDER	Provider: ollama (default), claude, openai, gemini
NAMINGPAPER_MODEL_NAME	Override default model for provider
NAMINGPAPER_OLLAMA_BASE_URL	Ollama API URL (default: http://localhost:11434)
NAMINGPAPER_MAX_AUTHORS	Max authors before "et al" (default: 3)
NAMINGPAPER_MAX_FILENAME_LENGTH	Max filename length (default: 200)

Config File

Create ~/.namingpaper/config.toml:

# Default provider (ollama requires no API key)
ai_provider = "ollama"
ollama_base_url = "http://localhost:11434"

# Or use cloud providers
# ai_provider = "claude"
# anthropic_api_key = "sk-ant-..."

# Formatting options
max_authors = 3
max_filename_length = 200

AI Providers

Ollama (Default)

Local LLM, no API key needed. Just have Ollama running.

# Pull a vision model
ollama pull llama3.2-vision

# Use it (default provider)
namingpaper rename paper.pdf

# Or specify a different model
NAMINGPAPER_MODEL_NAME=deepseek-ocr namingpaper rename paper.pdf

Claude (included by default)

export NAMINGPAPER_ANTHROPIC_API_KEY=sk-ant-...
namingpaper rename paper.pdf -p claude

OpenAI

uv sync --extra openai
export NAMINGPAPER_OPENAI_API_KEY=sk-...
namingpaper rename paper.pdf -p openai

Gemini

uv sync --extra gemini
export NAMINGPAPER_GEMINI_API_KEY=...
namingpaper rename paper.pdf -p gemini

Development

# Clone and setup
git clone https://github.com/DanTsai0903/namingpaper.git
cd namingpaper
uv sync --extra dev

# Run tests
uv run pytest -v

# Run a specific test
uv run pytest tests/test_formatter.py -v

License

MIT