Skip to main content

A wrapper around LangChain’s PDFPlumber integration with added support for image-aware data extraction.

Project description

Smart PDF Plumber

A lightweight wrapper over LangChain’s PDFPlumber integration that extends PDF parsing with image understanding—extracting not just text, but also contextual insights from embedded images.

It is designed for two common cases:

  • Extract plain text from PDFs page by page.
  • FEATURE: describe embedded images and include those descriptions in the page text.

Features

  • Page-level PDF parsing with pdfplumber.
  • Optional character deduplication for PDFs with repeated text.
  • Optional image description support using either Google Gemini or Hugging Face vision-language models.
  • LangChain-friendly output: a list of Document objects with metadata such as source path, page number, and total pages.

Installation

Install from PyPI:

pip install smartpdfplumber

The project currently targets Python 3.13 or newer.

Quick Start

from smartpdfplumber.loader import SmartPDFLoader

loader = SmartPDFLoader("path/to/file.pdf", describe_image=True, inference="groq_ai")
documents = loader.load()

for document in documents:
	print(document.metadata)
	print(document.page_content)

text_kwargs

Extra keyword arguments passed to pdfplumber.Page.extract_text().

dedupe

Set dedupe=True to call page.dedupe_chars() before extracting text. This can help with PDFs that repeat characters in the output.

describe_image

Set describe_image=True to include image descriptions inline in the page text.

When this is enabled, you must also provide inference.

inference

Supported values:

  • gemini
  • hf_transformers
  • groq_ai

Image Descriptions

from smartpdfplumber.loader import SmartPDFLoader

loader = SmartPDFLoader(
	"path/to/file.pdf",
	dedupe=True,
	describe_image=True,
	inference="huggingface",
	model="Qwen/Qwen3.5-0.8B" # Optional: Default("Qwen/Qwen3.5-0.8B")
)
documents = loader.load()

Notes

  • If you enable image descriptions without passing model, the parser raises a ValueError.
  • If you use model="hf_transformers", the model is loaded lazily and cached for reuse.

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

smartpdfplumber-0.1.7.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

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

smartpdfplumber-0.1.7-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file smartpdfplumber-0.1.7.tar.gz.

File metadata

  • Download URL: smartpdfplumber-0.1.7.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for smartpdfplumber-0.1.7.tar.gz
Algorithm Hash digest
SHA256 ba68e247f5d94bb2e6ab33836f4d30d7838e76abd4d9e6a17c597cff9e92198d
MD5 4800c808e61aa836a85838b2be1a635e
BLAKE2b-256 82631ebe3edbe6f7beac918be677fb274acbb2a29bec3c7d248b2f635bc46f1b

See more details on using hashes here.

File details

Details for the file smartpdfplumber-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for smartpdfplumber-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1c6d1ac4afa26aa764a825c5d0a2321106357b90fbaba622d550aab65e6ca70a
MD5 9f14af906326bf4dfda0247f6f36e5f1
BLAKE2b-256 499fecfc596ca2195236ca415de1e9523e84316cce60f084d56bc5f6599994f6

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