Liking cljdoc? Tell your friends :D

pdfplumber.attachments

Extract embedded files.

Extract embedded files.
raw docstring

pdfplumber.cli

Export PDF objects from the command line.

Export PDF objects from the command line.
raw docstring

pdfplumber.document

Load documents and handle errors. PDFBox parses documents here. Higher namespaces use the returned PDDocument handle.

Load documents and handle errors. PDFBox parses documents here. Higher
namespaces use the returned PDDocument handle.
raw docstring

pdfplumber.form

Extract AcroForm fields with top-left widget geometry.

Extract AcroForm fields with top-left widget geometry.
raw docstring

pdfplumber.geometry

Bounding-box math and coordinate conversion.

The public coordinate system has a top-left origin (matching Python pdfplumber): a bounding box is [x0 top x1 bottom] in PDF user-space points with x0 <= x1 and top <= bottom. PDFBox works in a bottom-left origin, so conversion happens here only. All extraction code must use these helpers.

Bounding-box math and coordinate conversion.

The public coordinate system has a top-left origin (matching Python
`pdfplumber`): a bounding box is `[x0 top x1 bottom]` in PDF user-space points
with `x0 <= x1` and `top <= bottom`. PDFBox works in a bottom-left origin, so
conversion happens here only. All extraction code must use these helpers.
raw docstring

pdfplumber.objects

Extract page objects with a PDFGraphicsStreamEngine subclass. Objects include lines, rectangles, curves, and images.

PDFBox delivers path coordinates already transformed by the CTM into page space (bottom-left origin); we collect painted subpaths and flip them to the public top-left coordinate system. Only painted paths (stroked/filled) yield objects; clip-only / no-paint paths are discarded.

Extract page objects with a PDFGraphicsStreamEngine subclass. Objects include
lines, rectangles, curves, and images.

PDFBox delivers path coordinates already transformed by the CTM into page
space (bottom-left origin); we collect painted subpaths and flip them to the
public top-left coordinate system. Only painted paths (stroked/filled) yield
objects; clip-only / no-paint paths are discarded.
raw docstring

pdfplumber.outline

Extract document outlines.

Extract document outlines.
raw docstring

pdfplumber.page

Composable page views for crop, bbox, outside, and predicate filters.

Composable page views for crop, bbox, outside, and predicate filters.
raw docstring

pdfplumber.permissions

Report document access permissions.

Report document access permissions.
raw docstring

pdfplumber.signature

Inspect digital-signature metadata and document coverage.

This namespace does not validate cryptographic signatures, certificate chains, revocation, or trust anchors. The coverage flag is an integrity signal. It shows whether a signature ByteRange spans the original PDF except for one signature-contents gap.

Inspect digital-signature metadata and document coverage.

This namespace does not validate cryptographic signatures, certificate chains,
revocation, or trust anchors. The coverage flag is an integrity signal. It
shows whether a signature ByteRange spans the original PDF except for one
signature-contents gap.
raw docstring

pdfplumber.structure

Extract tagged-PDF logical structures.

Extract tagged-PDF logical structures.
raw docstring

pdfplumber.table

Detect and extract tables from ruling lines, text alignments, or caller-supplied explicit lines. Public coordinates use [x0 top x1 bottom] in a top-left origin.

Detect and extract tables from ruling lines, text alignments, or
caller-supplied explicit lines. Public coordinates use
`[x0 top x1 bottom]` in a top-left origin.
raw docstring

pdfplumber.text

Extract characters, words, and text with PDFBox's PDFTextStripper.

PDFTextStripper already reports direction-adjusted coordinates in a top-left origin, so char maps are built directly from getXDirAdj/getYDirAdj without a page-height flip. Words are formed by clustering chars into lines (within :y-tolerance) and splitting on horizontal gaps wider than :x-tolerance.

Extract characters, words, and text with PDFBox's PDFTextStripper.

PDFTextStripper already reports direction-adjusted coordinates in a top-left
origin, so char maps are built directly from `getXDirAdj`/`getYDirAdj` without
a page-height flip. Words are formed by clustering chars into lines (within
`:y-tolerance`) and splitting on horizontal gaps wider than `:x-tolerance`.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close