Skip to main content

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

Project description

pdfembed

Image

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.0.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.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pdfembed-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 dfdb128d2955e50a2900400a5f92d141efbe9274cf94ecb8290f931b787425ac
MD5 8f866fdceb10694c03d2430ce1e9dfb4
BLAKE2b-256 29aa41e87204d61e498a34e14e5b48dd03476fb29e2b5309803c346752ea4577

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pdfembed-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b302401849a43cbc7243bbcabcd4ac7993de37e8898e8d1409ec833509e5930f
MD5 651108b904c8d1f2bc047496db39a263
BLAKE2b-256 33381121c80ab999b5ddc1da1f9c59df67ac4be282c3fc92d6eaa9639df325ad

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