pdfdancer-client-python 0.3.1__py3-none-any.whl → 0.3.2__py3-none-any.whl

pdfdancer/__init__.py

@@ -35,6 +35,8 @@ from .models import (
     Point,
     Position,
     PositionMode,
+    RedactResponse,
+    RedactTarget,
     ShapeType,
     StandardFonts,
     TextObjectRef,
@@ -78,6 +80,8 @@ __all__ = [
     "Line",
     "Bezier",
     "Path",
+    "RedactTarget",
+    "RedactResponse",
     "PdfDancerException",
     "FontNotFoundException",
     "ValidationException",

pdfdancer/models.py

@@ -893,6 +893,55 @@ class MoveRequest:
         }
 
 
+@dataclass
+class RedactTarget:
+    """A single redaction target identifying an object by its internal ID."""
+
+    id: str
+    replacement: str
+
+    def to_dict(self) -> dict:
+        return {"id": self.id, "replacement": self.replacement}
+
+
+@dataclass
+class RedactRequest:
+    """Request for redacting content from a PDF document."""
+
+    targets: List["RedactTarget"]
+    default_replacement: str
+    placeholder_color: "Color"
+
+    def to_dict(self) -> dict:
+        return {
+            "targets": [t.to_dict() for t in self.targets],
+            "defaultReplacement": self.default_replacement,
+            "placeholderColor": {
+                "r": self.placeholder_color.r,
+                "g": self.placeholder_color.g,
+                "b": self.placeholder_color.b,
+                "a": self.placeholder_color.a,
+            },
+        }
+
+
+@dataclass
+class RedactResponse:
+    """Response from a redaction operation."""
+
+    count: int
+    success: bool
+    warnings: List[str]
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "RedactResponse":
+        return cls(
+            count=data.get("count", 0),
+            success=data.get("success", False),
+            warnings=data.get("warnings", []),
+        )
+
+
 @dataclass
 class PageMoveRequest:
     """Request to reorder pages.

pdfdancer/pdfdancer_v1.py

@@ -14,6 +14,7 @@ import os
 import sys
 import time
 from datetime import datetime, timezone
+from importlib.metadata import version as get_package_version
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, BinaryIO, List, Mapping, Optional, Union
 
@@ -35,6 +36,7 @@ from .models import (
     AddPageRequest,
     AddRequest,
     ChangeFormFieldRequest,
+    Color,
     CommandResult,
     DeleteRequest,
     DocumentSnapshot,
@@ -57,6 +59,9 @@ from .models import (
     Paragraph,
     Position,
     PositionMode,
+    RedactRequest,
+    RedactResponse,
+    RedactTarget,
     ShapeType,
     TextLine,
     TextObjectRef,
@@ -69,6 +74,7 @@ from .types import (
     ImageObject,
     ParagraphObject,
     PathObject,
+    PDFObjectBase,
     TextLineObject,
 )
 
@@ -78,6 +84,14 @@ if TYPE_CHECKING:
 
 load_dotenv()
 
+# Client identifier header for all HTTP requests
+# Always reads from installed package metadata (stays in sync with pyproject.toml)
+try:
+    CLIENT_HEADER_VALUE = f"python/{get_package_version('pdfdancer-client-python')}"
+except Exception:
+    # Fallback in case package metadata is not available
+    CLIENT_HEADER_VALUE = "python/unknown"
+
 # Global variable to disable SSL certificate verification
 # Set to True to skip SSL verification (useful for testing with self-signed certificates)
 # WARNING: Only use in development/testing environments
@@ -748,7 +762,10 @@ class PDFDancer:
 
             while attempt <= max_retries:
                 try:
-                    headers = {"X-Fingerprint": Fingerprint.generate()}
+                    headers = {
+                        "X-Fingerprint": Fingerprint.generate(),
+                        "X-PDFDancer-Client": CLIENT_HEADER_VALUE,
+                    }
 
                     response = temp_client.post(
                         cls._cleanup_url_path(base_url, "/keys/anon"),
@@ -910,7 +927,10 @@ class PDFDancer:
         # Create HTTP client for connection reuse with HTTP/2 support
         instance._client = httpx.Client(
             http2=True,
-            headers={"Authorization": f"Bearer {instance._token}"},
+            headers={
+                "Authorization": f"Bearer {instance._token}",
+                "X-PDFDancer-Client": CLIENT_HEADER_VALUE,
+            },
             verify=not DISABLE_SSL_VERIFY,
         )
 
@@ -976,7 +996,10 @@ class PDFDancer:
         # Create HTTP client for connection reuse with HTTP/2 support
         self._client = httpx.Client(
             http2=True,
-            headers={"Authorization": f"Bearer {self._token}"},
+            headers={
+                "Authorization": f"Bearer {self._token}",
+                "X-PDFDancer-Client": CLIENT_HEADER_VALUE,
+            },
             verify=not DISABLE_SSL_VERIFY,
         )
 
@@ -2054,6 +2077,58 @@ class PDFDancer:
 
         return result
 
+    def _redact(
+        self,
+        targets: List["RedactTarget"],
+        default_replacement: str = "[REDACTED]",
+        placeholder_color: Optional[Color] = None,
+    ) -> "RedactResponse":
+        """
+        Redacts specified objects from the PDF document.
+
+        Args:
+            targets: List of RedactTarget objects identifying what to redact
+            default_replacement: Default replacement text for redacted content
+            placeholder_color: Color for image/path placeholder rectangles
+
+        Returns:
+            RedactResponse with count, success status, and any warnings
+        """
+        if not targets:
+            raise ValidationException("At least one redaction target is required")
+
+        if placeholder_color is None:
+            placeholder_color = Color(0, 0, 0)
+
+        request = RedactRequest(targets, default_replacement, placeholder_color)
+        response = self._make_request("POST", "/pdf/redact", data=request.to_dict())
+        result = RedactResponse.from_dict(response.json())
+
+        if result.success:
+            self._invalidate_snapshots()
+
+        return result
+
+    def redact(
+        self,
+        objects: List["PDFObjectBase"],
+        replacement: str = "[REDACTED]",
+        placeholder_color: Optional[Color] = None,
+    ) -> "RedactResponse":
+        """
+        Redacts multiple objects from the PDF document.
+
+        Args:
+            objects: List of PDF objects to redact
+            replacement: Replacement text for all redacted content
+            placeholder_color: Color for image/path placeholder rectangles
+
+        Returns:
+            RedactResponse with count, success status, and any warnings
+        """
+        targets = [RedactTarget(obj.internal_id, replacement) for obj in objects]
+        return self._redact(targets, replacement, placeholder_color)
+
     # Add Operations
 
     def _add_image(self, image: Image, position: Optional[Position] = None) -> bool:

pdfdancer/types.py

@@ -64,6 +64,14 @@ class PDFObjectBase:
             Position.at_page_coordinates(self.position.page_number, x, y),
         )
 
+    def redact(self, replacement: str = "[REDACTED]") -> bool:
+        """Redact this object from the PDF document."""
+        from .models import RedactTarget
+
+        target = RedactTarget(self.internal_id, replacement)
+        result = self._client._redact([target], replacement)
+        return result.success
+
 
 # -------------------------------------------------------------------
 # Subclasses

{pdfdancer_client_python-0.3.1.dist-info → pdfdancer_client_python-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdfdancer-client-python
-Version: 0.3.1
+Version: 0.3.2
 Summary: Python client for PDFDancer API
 Author-email: "The Famous Cat Ltd." <hi@thefamouscat.com>
 License: 
@@ -300,7 +300,7 @@ with PDFDancer.open(
         .font(StandardFonts.HELVETICA, 12) \
         .color(Color(70, 70, 70)) \
         .line_spacing(1.4) \
-        .at(page_number=0, x=72, y=520) \
+        .at(page_number=1, x=72, y=520) \
         .add()
 
     # Persist the modified document
@@ -321,7 +321,7 @@ with PDFDancer.new(token="your-api-token") as pdf:
         .font(StandardFonts.TIMES_BOLD, 18) \
         .color(Color(10, 10, 80)) \
         .line_spacing(1.2) \
-        .at(page_number=0, x=72, y=730) \
+        .at(page_number=1, x=72, y=730) \
         .add()
 
     pdf.new_image() \

{pdfdancer_client_python-0.3.1.dist-info → pdfdancer_client_python-0.3.2.dist-info}/RECORD

@@ -1,17 +1,17 @@
-pdfdancer/__init__.py,sha256=DkDPiTq-u5FWGpD5FHFXpAvZ7em79_PWauQgtE5VLIw,2427
+pdfdancer/__init__.py,sha256=m_buZKsE08oJSuU_ofWjN--IdPvnSiWrin6xwCYYL80,2507
 pdfdancer/exceptions.py,sha256=mJacmUJTPGUsB8Bo_FgfeXYkvZkH5OPJCVBfilBVmQo,2058
 pdfdancer/fingerprint.py,sha256=eL3PHPgv-knMya7s95RXg3qzzpkAA1aevxqb6tuOb34,3061
 pdfdancer/image_builder.py,sha256=aBxMFAMFzzbGTjlVH0hi94mA81cH8tp37Pk84HRPV00,1892
-pdfdancer/models.py,sha256=TzUe5EGG_EufkRLbJFWSKhpTBfwt5C4g-jPWP2djtwI,50630
+pdfdancer/models.py,sha256=JKvncVzzkXJy47XIQP9Ydvl2xkbi4IPXO60weXPoBiw,51856
 pdfdancer/page_builder.py,sha256=ARWLRtlrLGbES-0nbiigTOsRVmodRX0DNK8YIAkA9Ig,3850
 pdfdancer/paragraph_builder.py,sha256=OmhzYazMnq0n0rhrjWcKbo0LQfEC7BZoiLB29ycF630,20504
 pdfdancer/path_builder.py,sha256=safKb_IeHRWlQbyBTIXfcoBfXxUZhuzYvBIob5Tbp-8,23938
-pdfdancer/pdfdancer_v1.py,sha256=3dsOeIglFS_azisQ8vfrTuhT9-09gZOvTRZ28Re-el8,120183
+pdfdancer/pdfdancer_v1.py,sha256=aLAdyhvxxQrjKQxDHgoIrUxwcIgIAYS4twL6TOOeSQ0,122812
 pdfdancer/text_line_builder.py,sha256=8jYknV4hw0fyzwX0OI_oLvnh5aMmCV3jXaVkmYLu6MQ,10273
-pdfdancer/types.py,sha256=XX0pr-G34ghZz0wT_2A9ivHQAjtChHAEPlZYQj4X3z4,16344
-pdfdancer_client_python-0.3.1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-pdfdancer_client_python-0.3.1.dist-info/licenses/NOTICE,sha256=xaC4l-IChAmtViNDie8ZWzUk0O6XRMyzOl0zLmVZ2HE,232
-pdfdancer_client_python-0.3.1.dist-info/METADATA,sha256=VY1nAJH871I0XmVt4i67JG3iZ81CwovcN0uwuwvLsp4,24736
-pdfdancer_client_python-0.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pdfdancer_client_python-0.3.1.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
-pdfdancer_client_python-0.3.1.dist-info/RECORD,,
+pdfdancer/types.py,sha256=gRpAOSmp9pESHjHdsrda8d2E6q8fGxZKVg59guxXg3g,16658
+pdfdancer_client_python-0.3.2.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+pdfdancer_client_python-0.3.2.dist-info/licenses/NOTICE,sha256=xaC4l-IChAmtViNDie8ZWzUk0O6XRMyzOl0zLmVZ2HE,232
+pdfdancer_client_python-0.3.2.dist-info/METADATA,sha256=VAUegFatdCjjiRZyldhJ5jP8gbq-2W3vTRqw-iOyoEs,24736
+pdfdancer_client_python-0.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pdfdancer_client_python-0.3.2.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
+pdfdancer_client_python-0.3.2.dist-info/RECORD,,