Skip to main content

CLI/TUI tool to run OCR locally and overlay a searchable text layer on PDFs.

Project description

pdfembed

preview


CLI/TUI tool to run OCR locally and overlay a searchable text layer on PDFs. By default, a Textual-based TUI launches; use --cli for the classic CLI.

License: BSD-3-Clause (see LICENSE).

Quickstart

  • TUI (default):
    python -m pdfembed.cli or pdfembed

  • CLI:
    python -m pdfembed.cli --cli --file sample.pdf --dpi 300

TUI Controls

  • f: select PDF file(s) (opens a file dialog; multiple selection allowed)
  • o: select output folder (opens a folder dialog; defaults to the first PDF's directory)
  • v: toggle overlay visibility (debug)
  • s: start OCR
  • q: quit
  • DPI is fixed to the default in TUI; change via CLI --dpi if needed.

While OCR is running, a "Processing... please wait" indicator is shown and other keys are ignored until completion.

CLI Options (key ones)

  • --file <pdf1> [pdf2 ...] or --dir <folder>: input PDFs
  • --output <dir>: output directory (default: input location)
  • --dpi <int>: render DPI (default 300)
  • --visible: make overlay text visible (debug)
  • --font <path>: TTF font for overlay text
  • --log-level <LEVEL>: logging level (INFO by default)

Dependencies

  • Textual (TUI)
  • tkinter (file dialogs, stdlib)
  • onnxocr / pypdfium2 / pypdf / reportlab / opencv-python / numpy

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

pdfembed-0.1.1.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

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

pdfembed-0.1.1-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file pdfembed-0.1.1.tar.gz.

File metadata

  • Download URL: pdfembed-0.1.1.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for pdfembed-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3920061a2ebaf310fa5ced386de00fd1717cb1e56b5d71961fcbd68d486fb880
MD5 863ec52542d618bde42f9395c5b7b551
BLAKE2b-256 d53d3387b130d32610581f2de6822a21b86b07b1420867a1d0a14c3167a88b49

See more details on using hashes here.

File details

Details for the file pdfembed-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pdfembed-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for pdfembed-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bc4c5684d0b9bf4f0e5a35cc130046ec64ba21efcd7644eafd84f833609c46fd
MD5 b38eba5754ee2eb0f42e724e0300eb4f
BLAKE2b-256 0f413229385fc176ad505ca2f344f2e55260f1429cc5fa6862e63709c08f06a5

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