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.3.tar.gz (4.2 MB 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.3-py3-none-any.whl (4.2 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pdfembed-0.1.3.tar.gz
Algorithm Hash digest
SHA256 ef63a2ec0dcbb79b172f091647ec55f19749aa990c2afb6b6eac43efb1d0091c
MD5 144f20ab064702260099890c876282f2
BLAKE2b-256 2904b8eeb3192d2ef30939c58df0b2145423df1f8899e88e3ab9e491da947baf

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pdfembed-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 806df122df7728f86dcc9e0d50df260c03a7e08dfdbc1642c1ad7bf8991eb9fb
MD5 24eb20b6f083b9119005c46c706e7307
BLAKE2b-256 c6fde397336be2ae17b87e05d5f2cd54f4e73198986bbbe4d786a35e2d24725d

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