Metadata-Version: 2.4
Name: pypdfbox
Version: 1.0.0rc1
Summary: Python-native port of Apache PDFBox-compatible APIs (Apache 2.0)
Project-URL: Homepage, https://github.com/mehdyhaghy/pypdfbox
Project-URL: Repository, https://github.com/mehdyhaghy/pypdfbox
Project-URL: Documentation, https://github.com/mehdyhaghy/pypdfbox#readme
Project-URL: Bug Tracker, https://github.com/mehdyhaghy/pypdfbox/issues
Project-URL: Changelog, https://github.com/mehdyhaghy/pypdfbox/blob/main/CHANGES.md
Author: pypdfbox contributors
Author-email: Mehdy Haghy <mehdy@haghy.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for describing the origin of the Work and
              reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Support. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or support.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2026 pypdfbox contributors
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
           implied. See the License for the specific language governing
           permissions and limitations under the License.
License-File: LICENSE
License-File: NOTICE
Keywords: accessibility,fontbox,pdf,pdf-a,pdf-parser,pdf-rendering,pdf-ua,pdf-writer,pdfbox,tagged-pdf,xmp
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Markup
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: cryptography>=42
Requires-Dist: fonttools>=4
Requires-Dist: imagecodecs>=2026
Requires-Dist: numpy>=2
Requires-Dist: pillow>=12.2.0
Requires-Dist: skia-python>=144
Provides-Extra: cjk
Description-Content-Type: text/markdown

# pypdfbox

`pypdfbox` is an Apache 2.0-licensed, Python-native port of
[Apache PDFBox](https://pdfbox.apache.org/) 3.0.x. It mirrors PDFBox's
package layout (`org.apache.pdfbox.cos` → `pypdfbox.cos`), preserves
class names verbatim (`COSDictionary`, `PDDocument`, `PDFParser`,
`PDFRenderer`, `PDStructureTreeRoot`, …), keeps inheritance hierarchies
intact, and maps Java `camelCase` methods one-for-one to Python
`snake_case` — so the API a PDFBox developer already knows is the API
you call here. No JVM, no JPype, no Java subprocess: parser, writer,
content-stream engine, font subsystem, renderer, tagged-PDF model,
signature pipeline, XMP, and CLI tools are all reimplemented in pure
Python. This project is a community port, not an official Apache
release; the underlying design and the test corpus that drives it are
the work of the Apache PDFBox project, tracked centrally in
[`PROVENANCE.md`](PROVENANCE.md).

## Quick start

```sh
pip install pypdfbox
```

```python
from pypdfbox import PDDocument

with PDDocument.load("input.pdf") as doc:
    info = doc.get_document_information()
    info.set_title("Annual Report")
    info.set_author("Engineering")
    print(f"{doc.get_number_of_pages()} pages")
    doc.save("output.pdf")
```

The CLI dispatcher (`pypdfbox info|merge|split|decrypt|version|...`,
mirroring upstream's `org.apache.pdfbox.tools.PDFBox` suite) is
installed alongside.

## Installation

From PyPI:

```sh
pip install pypdfbox
```

Extras:

- `pypdfbox[cjk]` — opt-in marker that consents to network fetches of
  Noto Sans CJK (SIL OFL 1.1) as a last-resort fallback for PDFs that
  reference an unembedded CJK font. The extra carries no Python deps;
  it is only the consent gate. Auto-download is still inert unless you
  also export `PYPDFBOX_CJK_AUTODOWNLOAD=1`. See
  [`docs/install.md`](docs/install.md) for the full matrix.

Native wheels are published for CPython 3.12–3.14 on macOS (x86_64 +
arm64), Linux/glibc (x86_64 + aarch64), and Windows (x86_64). Source
installs require a working C / Rust toolchain for the transitive deps
(`cryptography`, `Pillow`, `skia-python`, `imagecodecs`, `numpy`).
JBIG2 decoding (`/JBIG2Decode`) is supported by a first-party
pure-Python decoder (ported from the Apache-2.0 `apache/pdfbox-jbig2`),
which replaced the GPL-licensed `jbig2-parser` under the
permissive-license policy — no dependency, no native code. See
[`docs/install.md`](docs/install.md) for platform-specific
troubleshooting.

## Build

Source builds use [`uv`](https://docs.astral.sh/uv/) as the package
manager.

```sh
git clone https://github.com/mehdyhaghy/pypdfbox.git
cd pypdfbox
uv sync --all-groups
```

Run the test suite:

```sh
.venv/bin/pytest -q --no-cov
```

(`--no-cov` is the fast pass; drop it to refresh coverage at
`coverage.json`.)

Lint:

```sh
uv run ruff check --fix
uv run ruff check
```

A local `.git/hooks/pre-push` (not versioned, recreated per-clone)
runs `ruff` and an Apache-2.0 / MIT / BSD license allow-list against
the dependency tree before every push — full recipe in
[`docs/build.md`](docs/build.md).

## Contribute

PRs are welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the
contribution workflow, the parity test layering (hand-written +
ported upstream tests), and the bookkeeping rules around
[`PROVENANCE.md`](PROVENANCE.md) and [`CHANGES.md`](CHANGES.md).

In short, every change should:

- Match upstream PDFBox class names, package layout, and inheritance.
- Translate `camelCase` to `snake_case`. Nothing else moves.
- For ported files, add a row to `PROVENANCE.md` (pypdfbox path →
  upstream version → upstream Java path).
- For behavioural deviation, add a one-line entry to `CHANGES.md`.
- Ship parity tests in `tests/<module>/test_<class>.py` plus, where
  applicable, ported upstream tests in
  `tests/<module>/upstream/test_<class>.py`.

## Support

This is a community fork-style port, not the upstream Apache project,
so the Apache Jira issue tracker and PDFBox mailing lists are not
appropriate for pypdfbox-specific questions or bugs. Use:

- The GitHub
  [issue tracker](https://github.com/mehdyhaghy/pypdfbox/issues) for
  bug reports and feature requests against pypdfbox.
- The upstream
  [Apache PDFBox project](https://pdfbox.apache.org/) for questions
  about PDF / PDFBox concepts in general, including the
  [PDFBox users mailing list](https://pdfbox.apache.org/mailinglists.html)
  and Stack Overflow's
  [`pdfbox` tag](https://stackoverflow.com/questions/tagged/pdfbox)
  for design-level Q&A — pypdfbox's surface is close enough that
  PDFBox answers usually translate directly.

If you have found a clear pypdfbox-specific bug (parity mismatch,
crash, byte-level divergence), please open a GitHub issue and include
a minimal PDF that reproduces it.

See [`docs/support.md`](docs/support.md) for a longer breakdown of
where to ask which kind of question.

## Known Limitations and Problems

See the
[issue tracker](https://github.com/mehdyhaghy/pypdfbox/issues) for the
full list. The most common stable-state divergences and gaps are:

1. **Symbol / ZapfDingbats glyph coverage is partial.** Non-embedded
   Standard 14 `/Symbol` and `/ZapfDingbats` references substitute
   through the bundled `DejaVuSans.ttf` (Bitstream Vera + DejaVu
   public-domain — permissive). Coverage is roughly 100% of the
   Zapf Dingbats Unicode block and ~84% of the Adobe Symbol glyph
   set (Greek + math operators). The remaining 16% of Symbol glyphs
   render as `.notdef`. Bundling a true Symbol replacement would
   require pulling in a non-permissively-licensed font; we do not.

2. **ICU bidi reordering is not ported.** Text extraction uses
   Python's stdlib `unicodedata.bidirectional` for RTL detection and
   paragraph reversal. Pure-RTL and pure-LTR runs reorder correctly;
   mixed-LTR+RTL Unicode bidi paragraph reordering can differ from
   what Acrobat (or upstream PDFBox, which uses ICU) produces. This
   is a deliberate divergence — adding ICU as a runtime dependency
   would conflict with the permissive-license-only policy.

3. **Renderer pixel-exact parity is not portable.** Upstream's JUnit
   tests compare rendered output to bundled TIFF / PNG reference
   images produced by Java AWT. pypdfbox renders through Pillow plus a
   Skia-backed `_aggdraw_compat` rasteriser, so byte-equivalent
   output is unachievable. Parity is enforced *structurally* (page
   count, MediaBox, Rotation, Contents shape, Resources keys,
   save-reload round-trip) rather than pixel-by-pixel. See
   [`CHANGES.md`](CHANGES.md) → "Active divergences".

4. **Standard 14 fallback fonts are bundled.** When a PDF references
   a Standard 14 face (`Helvetica`, `Times-Roman`, `Courier`, …)
   without embedding the program, pypdfbox substitutes via Liberation
   TTFs bundled in `pypdfbox/pdmodel/font/resources/` (~4 MB on
   install). Liberation is permissively licensed; this matches
   upstream's behaviour of serving Standard 14 via a bundled fallback
   when the host system lacks the font.

5. **CJK auto-download is opt-in.** PDFs referencing an unembedded
   CJK font produce `.notdef` glyphs unless the user both installs
   `pypdfbox[cjk]` and sets `PYPDFBOX_CJK_AUTODOWNLOAD=1`. With both
   set, the fontbox CJK loader downloads Noto Sans CJK (pinned to
   release `Sans2.004`, SIL OFL 1.1) from the upstream GitHub
   releases on first use, verifies the SHA-256, and caches per-user.

6. **No PDF/A or PDF/UA conformance validation.** Apache PDFBox 4.0
   removes the Preflight module; pypdfbox follows that decision.
   Validation is out of scope and not bundled. Downstream users who
   need it wire in whichever external validator they choose
   (pypdfbox stays validator-agnostic, in keeping with the
   permissive-license-only rule).

The full active-divergences list lives in
[`CHANGES.md` → Active divergences](CHANGES.md#active-divergences-vs-upstream).
Open in-flight gaps that are *fixable but not yet done* are tracked on
the [issue tracker](https://github.com/mehdyhaghy/pypdfbox/issues).

## License

Apache License, Version 2.0 — same as upstream PDFBox. See
[`LICENSE`](LICENSE) for the full text and [`NOTICE`](NOTICE) for the
required attribution that downstream redistributors must propagate.

Dependency policy: Apache-2.0 / MIT / BSD only. GPL, LGPL, AGPL, MPL,
EPL, CDDL, SSPL, BUSL are forbidden, and the local pre-push hook
hard-fails if any forbidden license appears in the resolved tree.

Ported files are tracked centrally in [`PROVENANCE.md`](PROVENANCE.md)
(pypdfbox path → upstream PDFBox version → upstream Java path), which
satisfies Apache 2.0 §4(b) ("notices stating that You changed the
files") in one place. Source files carry no per-file license headers.

Substantive behavioural deviations from upstream are recorded in
[`CHANGES.md`](CHANGES.md).

## Export control

This distribution includes cryptographic software. The country in
which you currently reside may have restrictions on the import,
possession, use, and/or re-export to another country of encryption
software. BEFORE using any encryption software, please check your
country's laws, regulations and policies concerning the import,
possession, or use, and re-export of encryption software, to see if
this is permitted. See <https://www.wassenaar.org/> for more
information.

The U.S. Government Department of Commerce, Bureau of Industry and
Security (BIS) has classified this software as Export Commodity
Control Number (ECCN) 5D002.C.1, which includes information security
software using or performing cryptographic functions with asymmetric
algorithms. The form and manner of this open-source distribution
makes it eligible for export under the License Exception ENC
Technology Software Unrestricted (TSU) exception (see the BIS Export
Administration Regulations, Section 740.13) for both object code and
source code.

The cryptographic surfaces in pypdfbox are:

- PDF Standard Security Handlers (r2–r6: RC4 40/128, AES-128/256
  CBC) and the public-key security handler, implemented in
  `pypdfbox.pdmodel.encryption` on top of the
  [`cryptography`](https://pypi.org/project/cryptography/) library
  (Apache-2.0 / BSD).
- Digital signature read + write (PKCS#7 / CAdES / PAdES, RFC 3161
  timestamps, PAdES-LTV `/DSS`+`/VRI` revocation-info bundling),
  implemented in `pypdfbox.pdmodel.interactive.digitalsignature` on
  top of `cryptography`'s PKCS#7 builders.

Upstream PDFBox uses the Java Cryptography Architecture (JCA) and
Bouncy Castle for the same surfaces; pypdfbox uses PyCA
`cryptography`. Functionally equivalent; the export classification is
unchanged.

## Acknowledgement of upstream

pypdfbox is a port of [Apache PDFBox](https://pdfbox.apache.org/),
maintained by the Apache Software Foundation. The COS model, parser
architecture, content-stream operators, accessibility model, font
subsystem, signature pipeline, and rendering design that this project
mirrors are the cumulative work of the PDFBox maintainers and
contributors. Per-file porting attribution lives in
[`PROVENANCE.md`](PROVENANCE.md) (one entry per ported source file
and per ported test file, recording the upstream PDFBox version and
Java path). The project-level attribution that must propagate to
downstream redistributors lives in [`NOTICE`](NOTICE).

This is a community port. It is not endorsed by, affiliated with, or
released by the Apache Software Foundation. Bugs in pypdfbox are
bugs in pypdfbox, not in Apache PDFBox.
