pdfops 0.2.0__tar.gz → 0.3.0__tar.gz

{pdfops-0.2.0 → pdfops-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pdfops
-Version: 0.2.0
+Version: 0.3.0
 Summary: Python client for the PDFops API: fill AcroForm PDFs, merge and split PDFs, page operations (extract, delete, rotate, watermark, page numbers), protect and unlock, edit metadata, inspect form fields, generate invoices. One HTTP call, no native deps, no headless browser.
 Project-URL: Homepage, https://pdfops.dev
 Project-URL: Documentation, https://pdfops.dev/docs
@@ -93,9 +93,9 @@ PDF inputs may be `bytes`, a path (`str` / `pathlib.Path`), or a binary file obj
 
 | Method | Endpoint | Returns |
 |---|---|---|
-| `inspect(pdf)` | `POST /api/inspect` | `dict` — `count`, `hasXFA`, `fields[]`, `fillTemplate` |
-| `fill_form(pdf, fields, *, flatten=False)` | `POST /api/fill-form` | filled PDF `bytes` |
-| `merge([pdf, pdf, ...])` | `POST /api/merge` | merged PDF `bytes` |
+| `inspect(pdf, *, password=None)` | `POST /api/inspect` | `dict` — `count`, `hasXFA`, `fields[]`, `fillTemplate` |
+| `fill_form(pdf, fields, *, flatten=False, password=None)` | `POST /api/fill-form` | filled PDF `bytes` |
+| `merge([pdf, pdf, ...], *, password=None)` | `POST /api/merge` | merged PDF `bytes` |
 | `invoice(request)` | `POST /api/invoice` | invoice PDF `bytes` |
 | `extract_pages(pdf, pages, *, password=None)` | `POST /api/extract-pages` | PDF `bytes` with only those pages, in that order |
 | `delete_pages(pdf, pages, *, password=None)` | `POST /api/delete-pages` | PDF `bytes` without those pages |

{pdfops-0.2.0 → pdfops-0.3.0}/README.md

@@ -63,9 +63,9 @@ PDF inputs may be `bytes`, a path (`str` / `pathlib.Path`), or a binary file obj
 
 | Method | Endpoint | Returns |
 |---|---|---|
-| `inspect(pdf)` | `POST /api/inspect` | `dict` — `count`, `hasXFA`, `fields[]`, `fillTemplate` |
-| `fill_form(pdf, fields, *, flatten=False)` | `POST /api/fill-form` | filled PDF `bytes` |
-| `merge([pdf, pdf, ...])` | `POST /api/merge` | merged PDF `bytes` |
+| `inspect(pdf, *, password=None)` | `POST /api/inspect` | `dict` — `count`, `hasXFA`, `fields[]`, `fillTemplate` |
+| `fill_form(pdf, fields, *, flatten=False, password=None)` | `POST /api/fill-form` | filled PDF `bytes` |
+| `merge([pdf, pdf, ...], *, password=None)` | `POST /api/merge` | merged PDF `bytes` |
 | `invoice(request)` | `POST /api/invoice` | invoice PDF `bytes` |
 | `extract_pages(pdf, pages, *, password=None)` | `POST /api/extract-pages` | PDF `bytes` with only those pages, in that order |
 | `delete_pages(pdf, pages, *, password=None)` | `POST /api/delete-pages` | PDF `bytes` without those pages |

{pdfops-0.2.0 → pdfops-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pdfops"
-version = "0.2.0"
+version = "0.3.0"
 description = "Python client for the PDFops API: fill AcroForm PDFs, merge and split PDFs, page operations (extract, delete, rotate, watermark, page numbers), protect and unlock, edit metadata, inspect form fields, generate invoices. One HTTP call, no native deps, no headless browser."
 readme = "README.md"
 license = "MIT"

{pdfops-0.2.0 → pdfops-0.3.0}/src/pdfops/__init__.py

@@ -26,7 +26,7 @@ from urllib import error as urlerror
 from urllib import request as urlrequest
 
 __all__ = ["PdfOps", "PdfOpsError", "PdfInput", "SplitPart", "SplitResult", "UnlockResult", "__version__"]
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 
 #: A PDF given as raw bytes, a filesystem path, or a binary file object.
 PdfInput = Union[bytes, bytearray, memoryview, str, "os.PathLike[str]", IO[bytes]]
@@ -152,6 +152,10 @@ class PdfOps:
             h["X-API-Key"] = self.api_key
         if self.client_tag:
             h["X-Pdfops-Client"] = self.client_tag
+            # Same rule as the TS SDK: the package version describes the "py"
+            # tag only; an embedding tool's tag has its own version.
+            if self.client_tag == "py":
+                h["X-Pdfops-Client-Version"] = __version__
         if extra:
             h.update(extra)
         return h
@@ -193,22 +197,29 @@ class PdfOps:
 
     # ── API ─────────────────────────────────────────────────────────────────
 
-    def inspect(self, pdf: PdfInput) -> Dict[str, Any]:
+    def inspect(self, pdf: PdfInput, *, password: Optional[str] = None) -> Dict[str, Any]:
         """List a PDF's AcroForm fields plus a paste-ready ``fillTemplate``.
 
         Returns ``{"count", "hasXFA", "fields": [...], "fillTemplate": {...}}``.
-        A PDF with no form returns ``count == 0`` — not an error.
+        A PDF with no form returns ``count == 0`` — not an error. ``password``
+        opens a user-password PDF.
         """
-        data = self._post_pdf("/api/inspect", [("pdf", "input.pdf", _read_pdf(pdf), "application/pdf")])
+        parts: List[Tuple[str, Optional[str], bytes, str]] = [("pdf", "input.pdf", _read_pdf(pdf), "application/pdf")]
+        if password is not None:
+            parts.append(("password", None, password.encode("utf-8"), "text/plain"))
+        data = self._post_pdf("/api/inspect", parts)
         return json.loads(data.decode("utf-8"))
 
-    def fill_form(self, pdf: PdfInput, fields: Mapping[str, str], *, flatten: bool = False) -> bytes:
+    def fill_form(
+        self, pdf: PdfInput, fields: Mapping[str, str], *, flatten: bool = False, password: Optional[str] = None
+    ) -> bytes:
         """Fill AcroForm fields; returns the filled PDF bytes.
 
         Field names must exist in the PDF — use :meth:`inspect` to discover
         them. Checkbox values are the strings ``"true"``/``"false"``; choice
         fields take one of their options. ``flatten=True`` bakes values into
         the page content and drops the form so fields are no longer editable.
+        ``password`` opens a user-password PDF.
         """
         parts: List[Tuple[str, Optional[str], bytes, str]] = [
             ("pdf", "input.pdf", _read_pdf(pdf), "application/pdf"),
@@ -216,13 +227,20 @@ class PdfOps:
         ]
         if flatten:
             parts.append(("flatten", None, b"true", "text/plain"))
+        if password is not None:
+            parts.append(("password", None, password.encode("utf-8"), "text/plain"))
         return self._post_pdf("/api/fill-form", parts)
 
-    def merge(self, pdfs: Sequence[PdfInput]) -> bytes:
-        """Merge two or more PDFs, in order; returns the combined PDF bytes."""
+    def merge(self, pdfs: Sequence[PdfInput], *, password: Optional[str] = None) -> bytes:
+        """Merge two or more PDFs, in order; returns the combined PDF bytes.
+
+        ``password`` opens user-password inputs and applies to every input.
+        """
         if len(pdfs) < 2:
             raise PdfOpsError(400, "too_few_pdfs", "merge needs at least 2 PDFs")
-        parts = [("pdf", f"part-{i}.pdf", _read_pdf(p), "application/pdf") for i, p in enumerate(pdfs)]
+        parts: List[Tuple[str, Optional[str], bytes, str]] = [("pdf", f"part-{i}.pdf", _read_pdf(p), "application/pdf") for i, p in enumerate(pdfs)]
+        if password is not None:
+            parts.append(("password", None, password.encode("utf-8"), "text/plain"))
         return self._post_pdf("/api/merge", parts)
 
     def invoice(self, request: Mapping[str, Any]) -> bytes:

{pdfops-0.2.0 → pdfops-0.3.0}/tests/test_client.py

@@ -13,6 +13,7 @@ import sys
 import tempfile
 import unittest
 from typing import List, Optional, Tuple
+from unittest import mock
 
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "src"))
 
@@ -54,6 +55,7 @@ class HeadersAndInputs(unittest.TestCase):
         self.assertEqual(url, "https://pdfops.dev/api/fill-form")
         self.assertEqual(headers["X-API-Key"], "pdfops_live_x")
         self.assertEqual(headers["X-Pdfops-Client"], "py")
+        self.assertEqual(headers["X-Pdfops-Client-Version"], __version__)
         self.assertEqual(headers["User-Agent"], f"pdfops-python/{__version__}")
 
     def test_keyless_and_custom_tag_and_base_url(self):
@@ -114,6 +116,20 @@ class Endpoints(unittest.TestCase):
         _, _, headers, body = t.calls[0]
         self.assertEqual([p[0] for p in parts_of(body, headers["Content-Type"])], ["pdf", "fields"])
 
+    def test_password_forwarded_on_fill_inspect_merge(self):
+        for call, path in (
+            (lambda c: c.fill_form(PDF, {"a": "b"}, password="pw"), "/api/fill-form"),
+            (lambda c: c.merge([PDF, PDF], password="pw"), "/api/merge"),
+            (lambda c: c.inspect(PDF, password="pw"), "/api/inspect"),
+        ):
+            t = FakeTransport(body=b"{}" if path == "/api/inspect" else PDF)
+            call(PdfOps(transport=t))
+            _, url, headers, body = t.calls[0]
+            self.assertTrue(url.endswith(path))
+            parts = parts_of(body, headers["Content-Type"])
+            self.assertEqual(parts[-1][0], "password")
+            self.assertEqual(parts[-1][3], b"pw")
+
     def test_merge_order_and_minimum(self):
         t = FakeTransport(body=PDF)
         PdfOps(transport=t).merge([PDF, b"%PDF-2", b"%PDF-3"])
@@ -135,8 +151,12 @@ class Endpoints(unittest.TestCase):
         self.assertEqual(json.loads(body), req)
 
     def test_usage_requires_key_and_parses_json(self):
-        with self.assertRaises(PdfOpsError) as cm:
-            PdfOps(transport=FakeTransport()).usage()
+        # Isolated from a real PDFOPS_API_KEY sitting in the ambient
+        # environment (e.g. this box's cron env), which would otherwise
+        # make the client think a key was supplied.
+        with mock.patch.dict(os.environ, {"PDFOPS_API_KEY": ""}):
+            with self.assertRaises(PdfOpsError) as cm:
+                PdfOps(transport=FakeTransport()).usage()
         self.assertEqual(cm.exception.code, "missing_api_key")
         t = FakeTransport(body=json.dumps({"tier": "free", "limit": 250, "used": 3, "remaining": 247}).encode())
         u = PdfOps("k", transport=t).usage()