pdftl 0.7.0__tar.gz

pdftl-0.7.0/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# readthedocs.yaml
+
+version: 2
+
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3.10"
+  jobs:
+    pre_build:
+    - cd docs && make html
+
+sphinx:
+  configuration: docs/source/conf.py
+
+formats:
+  - pdf
+  - epub
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+      - docs

pdftl-0.7.0/CHANGELOG.md

@@ -0,0 +1,220 @@
+# Changelog
+
+This changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- Posible headings: Added, Changed, Deprecated, Fixed, Removed, Security -->
+
+## [0.7.0] - 2026-01-11
+
+### Added
+
+- automated `pdftk` compatibility testing using third party
+  php test suite.
+
+- `drop_xfa` output option to drop XFA form data (pdftk compatibility)
+
+- `render` operation: rasterize pages
+
+- `move`, `update_info`, `update_info_utf8` now accept
+  instructions from a JSON "at-file" using `@filename.json`
+  in place of CLI arguments
+
+- `dump_data` gives JSON output via the `json` keyword
+
+### Fixed
+
+- bug in `add_pages.py` when a page has an integer key-value
+
+- more comprehensive handling of the five PDF page boxes for
+  `dump_data` and `update_info`
+
+- `drop_info` and `drop_xmp` output options should now work
+  as claimed
+
+- `flatten` reimplemented for robustness
+
+## [0.6.0] - 2026-01-04
+
+### Added
+
+- `move` operation: move pages within a PDF file
+
+- `place` operation: shift, scale and/or spin content within
+  the page
+
+### Changed
+
+- Now handles compound page specifications like `1,3-4,7-end`
+
+### Fixed
+
+- Improved API documentation generation
+
+### Removed
+
+- `spin` operation. See `place` for this functionality.
+
+## [0.5.0] - 2026-01-03
+
+### Added
+
+- `add_text` features:
+
+  - source metadata variables (`source_filename`,
+    `source_page`, etc)
+
+  - Bates stamping variable features,
+    e.g. `DEF-{page+120:06d}` produces DEF-000121, DEF-000122,
+    ...
+
+- `insert` operation: insert blank pages
+
+## [0.4.1] - 2026-01-02
+
+### Fixed
+
+- Broken link in README.md
+
+## [0.4.0] - 2026-01-01
+
+### Added
+
+- API with fluent and functional interfaces
+- `docs/api_tutorial.md` and auto-generated API docs
+
+### Changed
+
+- Renamed operation: `list_files` is now `dump_files`
+
+### Fixed
+
+- Fixed bug preventing parsing of the page specification "right"
+
+## [0.3.1] - 2025-12-20
+
+### Fixed
+
+- `README.md` corrected, and "platform" badge added
+
+## [0.3.0] - 2025-12-20
+
+### Added
+
+- Get `help` by tag with `pdftl help tag:<tagname>`
+
+- `dump_signatures`: view and validate PDF signatures
+
+- PDF signature output options:
+
+  - `sign_cert <file>` Path to certificate PEM
+
+  - `sign_field <name>` Signature field name (default: Signature1)
+
+  - `sign_key <file>` Path to private key PEM
+
+  - `sign_pass_env <var>` Environment variable with sign_cert passphrase
+
+  - `sign_pass_prompt` Prompt for sign_cert passphrase
+
+- `dump_layers`: dump PDF optional content groups (OCGs), a.k.a. "layers"
+
+### Fixed
+
+- performance improvements for `cat`
+
+## [0.2.1] - 2025-12-17
+
+### Added
+
+- `crop`: added `fit` and `fit-group`
+
+- artwork
+
+- extended NOTICE.md: acknowledge `pikepdf`/`qpdf` and `pypdfium2`
+
+- Windows testing
+
+### Fixed
+
+- performance improvements (lazy-loaded imports)
+
+- help tweaks: add sources for non-operations; more help topic aliases
+
+## [0.2.0] - 2025-12-13
+
+### Added
+
+- readthedocs integration and docs generation
+
+### Fixed
+
+- Improved help text
+
+## [0.1.1] - 2025-12-12
+
+### Added
+
+- codecov integration
+- PyPI publish integration
+
+## [0.1.0] - 2025-12-11
+
+### Added
+
+- Initial public release of `pdftl`.
+- Operations:
+  - ``add_text``               Add user-specified text strings to PDF pages
+  - ``background``             Use a 1-page PDF as the background for each page
+  - ``burst``                  Split a single PDF into individual page files
+  - ``cat``                    Concatenate pages from input PDFs into a new PDF
+  - ``chop``                   Chop pages into multiple smaller pieces
+  - ``crop``                   Crop pages
+  - ``delete``                 Delete pages from an input PDF
+  - ``delete_annots``          Delete annotation info
+  - ``dump_annots``            Dump annotation info
+  - ``dump_data``              Metadata, page and bookmark info (XML-escaped)
+  - ``dump_data_annots``       Dump annotation info in pdftk style
+  - ``dump_data_fields``       Print PDF form field data with XML-style escaping
+  - ``dump_data_fields_utf8``  Print PDF form field data in UTF-8
+  - ``dump_data_utf8``         Metadata, page and bookmark info (in UTF-8)
+  - ``dump_dests``             Print PDF named destinations data to the console
+  - ``dump_text``              Print PDF text data to the console or a file
+  - ``fill_form``              Fill a PDF form
+  - ``filter``                 Do nothing. (The default if ``<operation>`` omitted.)
+  - ``generate_fdf``           Generate an FDF file containing PDF form data
+  - ``inject``                 Inject code at start or end of page content streams
+  - ``list_files``             List file attachments
+  - ``modify_annots``          Modify properties of existing annotations
+  - ``multibackground``        Use multiple pages as backgrounds
+  - ``multistamp``             Stamp multiple pages onto an input PDF
+  - ``normalize``              Reformat page content streams
+  - ``optimize_images``        Optimize images
+  - ``replace``                Regex replacement on page content streams
+  - ``rotate``                 Rotate pages in a PDF
+  - ``shuffle``                Interleave pages from multiple input PDFs
+  - ``spin``                   Spin page content in a PDF
+  - ``stamp``                  Stamp a 1-page PDF onto each page of an input PDF
+  - ``unpack_files``           Unpack file attachments
+  - ``update_info``            Update PDF metadata
+  - ``update_info_utf8``       Update PDF metadata from dump_data_utf8 instructions
+- Output options:
+  - ``allow <perm>...``        Specify permissions for encrypted files
+  - ``attach_files <file>``... Attach files to the output PDF
+  - ``compress``               (default) Compress output file streams
+  - ``drop_info``              Discard document-level info metadata
+  - ``drop_xmp``               Discard document-level XMP metadata
+  - ``encrypt_128bit``         Use 128 bit encryption (obsolete, maybe insecure)
+  - ``encrypt_40bit``          Use 40 bit encryption (obsolete, highly insecure)
+  - ``encrypt_aes128``         Use 128 bit AES encryption (maybe obsolete)
+  - ``encrypt_aes256``         Use 256 bit AES encryption
+  - ``flatten``                Flatten all annotations
+  - ``keep_final_id``          Copy final input PDF's ID metadata to output
+  - ``keep_first_id``          Copy first input PDF's ID metadata to output
+  - ``linearize``              Linearize output file(s)
+  - ``need_appearances``       Set a form rendering flag in the output PDF
+  - ``output <file>``          The output file path, or a template for 'burst'
+  - ``owner_pw <pw>``          Set owner password and encrypt output
+  - ``uncompress``             Disables compression of output file streams
+  - ``user_pw <pw>``           Set user password and encrypt output
+  - ``verbose``                Turn on verbose output

pdftl-0.7.0/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

pdftl-0.7.0/MANIFEST.in

@@ -0,0 +1,47 @@
+# --- Core Metadata ---
+include pyproject.toml
+include README.md
+include LICENSE
+include NOTICE.md
+include *.md
+include *.yaml
+
+# --- Package Data ---
+recursive-include src/pdftl *.py
+recursive-include src/pdftl *.pyi
+include src/pdftl/py.typed
+
+# --- Tests & Assets ---
+# useful for downstream packagers like Debian
+recursive-include tests *.py
+recursive-include tests/assets *.pdf *.fdf *.txt
+recursive-include tests *.cnf *.csr *.pem
+
+# --- Documentation ---
+include docs/Makefile
+include docs/README*.md
+include docs/*.py
+
+# --- Tools/Scripts ---
+recursive-include tools *.py
+
+# --- Excludes (Global) ---
+
+# Remove CI/CD configuration and local artifacts
+
+prune .github
+exclude .gitignore
+exclude pytest.log
+
+# Remove Python compilation artifacts
+
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude *.so
+global-exclude *.dylib
+
+# Remove OS/Editor junk
+
+global-exclude .DS_Store
+global-exclude .git*
+global-exclude *conflicted*

pdftl-0.7.0/NOTICE.md

@@ -0,0 +1,35 @@
+# pdftl Notices
+
+This software is distributed under the Mozilla Public License 2.0.
+
+## Artwork
+
+### The `pdftl` icon
+
+The [`pdftl` icon](https://raw.githubusercontent.com/pdftl/pdftl/main/.github/assets/pdftl.svg) is a derivative work. It incorporates elements from the [Google Noto Emoji](https://github.com/googlefonts/noto-emoji) library.
+* **Original copyright:** 2013 Google Inc.
+* **Original license:** Apache License, Version 2.0
+* **Modifications:** The artwork has been modified (recolored, reshaped, and combined) for the `pdftl` project.
+* **Icon license:** These modifications and the resulting composite icon are licensed under the **Mozilla Public License 2.0** to match the `pdftl` project's primary license.
+
+
+## Third-party components
+
+### OCRmyPDF
+
+Portions of the `optimize_images` command are adapted from [OCRmyPDF](https://github.com/ocrmypdf/OCRmyPDF).
+
+* **Original author:** James R. Barlow
+* **License:** Mozilla Public License 2.0
+* **Copyright:** © 2022 James R. Barlow
+
+The original source code can be found at <https://github.com/ocrmypdf/OCRmyPDF>.
+
+### pikepdf/qpdf
+
+This project relies heavily on pikepdf (© 2022-2024 James R. Barlow, MPL 2.0) and qpdf (MPL 2.0). While not directly "adapted" code, they are core dependencies that make this tool possible.
+
+### pypdfium2 / PDFium
+The `dump_text` operation is powered by **pypdfium2**.
+* **License:** BSD-3-Clause
+* **Source:** https://github.com/pypdfium2/pypdfium2