Skip to main content

document mover, for moving scans stable and merge pdfs

Project description

document-mover

A Python-based automated PDF merging and file movement workflow, particularly useful for scanning operations.

Features

PDF Merger (pdf-merger)

  • Merge two PDFs with alternating page order (page1, page2, page3, page4, etc.)
  • Delete source files after successful merge (optional)
  • Remove empty pages from the merged PDF (optional)
  • CLI interface for easy command-line usage

Consecutive PDF Merger (process_pdf_merge)

  • Auto-detect consecutive PDFs based on filename numbering
  • Merge pairs of consecutively numbered files automatically
  • Process entire folders with batch operations
  • Dry-run mode to preview operations before executing

Document Mover (document-mover)

  • File stability checking - ensures files are fully written before processing
  • Selective file movement - separate handling for regular and dual-sided files
  • Dual-sided file pairing - automatically pairs and merges dual-sided scans
  • Atomic operations - safe file movements with proper permission handling
  • Comprehensive logging - detailed tracking of all operations

Installation

pdm install

Usage

PDF Merger

Merge two PDF files:

pdm run pdf-merger file1.pdf file2.pdf output.pdf

With options:

pdm run pdf-merger file1.pdf file2.pdf output.pdf --delete-source --remove-empty-pages --verbose

Options:

  • --delete-source: Delete source PDF files after successful merge
  • --remove-empty-pages: Remove empty pages from the merged PDF
  • --verbose: Enable verbose logging

Consecutive PDF Merger

Process a folder and merge consecutive PDFs:

pdm run process_pdf_merge /path/to/folder

With options:

pdm run process_pdf_merge /path/to/folder --dest-folder /path/to/dest --dry-run --verbose

Options:

  • --dest-folder: Directory for merged PDF output (defaults to source folder)
  • --dry-run: Preview operations without executing
  • --verbose: Enable verbose logging

Document Mover

Move processed documents:

pdm run document-mover /path/to/source --dest /path/to/dest

With options:

pdm run document-mover /path/to/source --dest /path/to/dest --dual-dest /path/to/dual-dest --stability-wait 5 --min-age 30 --verbose

Options:

  • --dest: Destination folder for regular files (required)
  • --dual-dest: Destination folder for dual-sided files
  • --stability-wait: Seconds to wait before checking file stability (default: 2)
  • --min-age: Minimum file age in seconds before processing (default: 60)
  • --verbose: Enable verbose logging

Configuration

Ruff Formatting

The project is configured to use ruff with a line length of 120 characters. This is set in pyproject.toml:

[tool.ruff]
line-length = 120

The VS Code editor is also configured to display a ruler at column 120 for consistency.

Project Structure

document-mover/
├── src/
│   └── document_mover/
│       ├── __init__.py
│       ├── pdf_merger.py          # PDF merging utilities
│       ├── document_mover.py      # Main file movement system
│       └── file_lock.py           # File locking utilities
├── tests/
│   └── __init__.py
├── pyproject.toml                 # Project configuration & dependencies
└── README.md

Requirements

  • Python 3.13+
  • pypdf >= 6.4.1
  • ruff >= 0.14.8
  • mypy >= 1.19.0

Development

Running Tests

pdm run pytest

Code Quality

Format code with ruff:

pdm run ruff format .

Type checking with mypy:

pdm run mypy src/

Use Cases

Scanning Workflow

  1. Scan dual-sided documents as separate files (page 1, page 2, etc.)
  2. Run document-mover to automatically pair and merge dual-sided files
  3. Process results to final destination with proper organization

PDF Organization

  1. Use consecutive PDF merger to automatically merge numbered PDF sets
  2. Delete source files after successful merge to save space
  3. Remove empty pages for cleaner final documents

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

document_mover-0.3.0.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

document_mover-0.3.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file document_mover-0.3.0.tar.gz.

File metadata

  • Download URL: document_mover-0.3.0.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.26.2 CPython/3.13.2 Linux/6.18.1-1-cachyos-bore

File hashes

Hashes for document_mover-0.3.0.tar.gz
Algorithm Hash digest
SHA256 765baba3a40d36f7c6694859f4bd6d46e86cb9c3dffc1c9fa35bde583ce67f3f
MD5 f06e029b13a5c7dd8bf77cc4bcf51f55
BLAKE2b-256 0296e136d2ae67a6ec45b93041fb4be3b6d6486e74ec021dc2ac158857312140

See more details on using hashes here.

File details

Details for the file document_mover-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: document_mover-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.26.2 CPython/3.13.2 Linux/6.18.1-1-cachyos-bore

File hashes

Hashes for document_mover-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 650e9b778b49d8ef19c4f79dbe207c3a4bbfe0335aa467783a055537bfaa456d
MD5 a30a93de51c3f46257bb8fdd1135d988
BLAKE2b-256 98fb24c1968ccab04d71a90f3024823f9a9c2c542a5201e64cf73fb38c3fb206

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page