pdfdancer-client-python 0.2.16__py3-none-any.whl → 0.2.17__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of pdfdancer-client-python might be problematic. Click here for more details.

pdfdancer/__init__.py CHANGED
@@ -45,7 +45,26 @@ __all__ = [
45
45
  "FontNotFoundException",
46
46
  "ValidationException",
47
47
  "HttpClientException",
48
- "SessionException"
48
+ "SessionException",
49
+ "set_ssl_verify"
49
50
  ]
50
51
 
51
52
  from .pdfdancer_v1 import PDFDancer
53
+ from . import pdfdancer_v1
54
+
55
+ def set_ssl_verify(enabled: bool) -> None:
56
+ """
57
+ Enable or disable SSL certificate verification for all API requests.
58
+
59
+ Args:
60
+ enabled: True to enable SSL verification (default, secure),
61
+ False to disable SSL verification (only for testing with self-signed certs)
62
+
63
+ WARNING: Disabling SSL verification should only be done in development/testing
64
+ environments with self-signed certificates. Never disable in production.
65
+
66
+ Example:
67
+ import pdfdancer
68
+ pdfdancer.set_ssl_verify(False) # Disable SSL verification
69
+ """
70
+ pdfdancer_v1.DISABLE_SSL_VERIFY = not enabled
@@ -272,7 +272,8 @@ class ParagraphBuilder:
272
272
  return lines
273
273
 
274
274
  def add(self):
275
- self._client._add_paragraph(self._build())
275
+ # noinspection PyProtectedMember
276
+ return self._client._add_paragraph(self._build())
276
277
 
277
278
 
278
279
  class ParagraphPageBuilder(ParagraphBuilder):
pdfdancer/pdfdancer_v1.py CHANGED
@@ -7,6 +7,7 @@ Provides session-based PDF manipulation operations with strict validation.
7
7
 
8
8
  import json
9
9
  import os
10
+ import time
10
11
  from pathlib import Path
11
12
  from typing import List, Optional, Union, BinaryIO, Mapping, Any
12
13
 
@@ -15,6 +16,13 @@ from dotenv import load_dotenv
15
16
 
16
17
  load_dotenv()
17
18
 
19
+ # Global variable to disable SSL certificate verification
20
+ # Set to True to skip SSL verification (useful for testing with self-signed certificates)
21
+ # WARNING: Only use in development/testing environments
22
+ DISABLE_SSL_VERIFY = False
23
+
24
+ DEBUG = False
25
+
18
26
  from . import ParagraphBuilder
19
27
  from .exceptions import (
20
28
  PdfDancerException,
@@ -470,12 +478,21 @@ class PDFDancer:
470
478
  'pdf': ('document.pdf', self._pdf_bytes, 'application/pdf')
471
479
  }
472
480
 
481
+ request_size = len(self._pdf_bytes)
482
+ if DEBUG:
483
+ print(f"{time.time()}|POST /session/create - request size: {request_size} bytes")
484
+
473
485
  response = self._session.post(
474
486
  self._cleanup_url_path(self._base_url, "/session/create"),
475
487
  files=files,
476
- timeout=self._read_timeout if self._read_timeout > 0 else None
488
+ timeout=self._read_timeout if self._read_timeout > 0 else None,
489
+ verify=not DISABLE_SSL_VERIFY
477
490
  )
478
491
 
492
+ response_size = len(response.content)
493
+ if DEBUG:
494
+ print(f"{time.time()}|POST /session/create - response size: {response_size} bytes")
495
+
479
496
  self._handle_authentication_error(response)
480
497
  response.raise_for_status()
481
498
  session_id = response.text.strip()
@@ -538,14 +555,24 @@ class PDFDancer:
538
555
  raise ValidationException(f"Initial page count must be at least 1, got {initial_page_count}")
539
556
  request_data['initialPageCount'] = initial_page_count
540
557
 
558
+ request_body = json.dumps(request_data)
559
+ request_size = len(request_body.encode('utf-8'))
560
+ if DEBUG:
561
+ print(f"{time.time()}|POST /session/new - request size: {request_size} bytes")
562
+
541
563
  headers = {'Content-Type': 'application/json'}
542
564
  response = self._session.post(
543
565
  self._cleanup_url_path(self._base_url, "/session/new"),
544
566
  json=request_data,
545
567
  headers=headers,
546
- timeout=self._read_timeout if self._read_timeout > 0 else None
568
+ timeout=self._read_timeout if self._read_timeout > 0 else None,
569
+ verify=not DISABLE_SSL_VERIFY
547
570
  )
548
571
 
572
+ response_size = len(response.content)
573
+ if DEBUG:
574
+ print(f"{time.time()}|POST /session/new - response size: {response_size} bytes")
575
+
549
576
  self._handle_authentication_error(response)
550
577
  response.raise_for_status()
551
578
  session_id = response.text.strip()
@@ -572,15 +599,27 @@ class PDFDancer:
572
599
  }
573
600
 
574
601
  try:
602
+ request_size = 0
603
+ if data is not None:
604
+ request_body = json.dumps(data)
605
+ request_size = len(request_body.encode('utf-8'))
606
+ if DEBUG:
607
+ print(f"{time.time()}|{method} {path} - request size: {request_size} bytes")
608
+
575
609
  response = self._session.request(
576
610
  method=method,
577
611
  url=self._cleanup_url_path(self._base_url, path),
578
612
  json=data,
579
613
  params=params,
580
614
  headers=headers,
581
- timeout=self._read_timeout if self._read_timeout > 0 else None
615
+ timeout=self._read_timeout if self._read_timeout > 0 else None,
616
+ verify=not DISABLE_SSL_VERIFY
582
617
  )
583
618
 
619
+ response_size = len(response.content)
620
+ if DEBUG:
621
+ print(f"{time.time()}|{method} {path} - response size: {response_size} bytes")
622
+
584
623
  # Handle FontNotFoundException
585
624
  if response.status_code == 404:
586
625
  try:
@@ -1040,14 +1079,23 @@ class PDFDancer:
1040
1079
  'ttfFile': (filename, font_data, 'font/ttf')
1041
1080
  }
1042
1081
 
1082
+ request_size = len(font_data)
1083
+ if DEBUG:
1084
+ print(f"{time.time()}|POST /font/register - request size: {request_size} bytes")
1085
+
1043
1086
  headers = {'X-Session-Id': self._session_id}
1044
1087
  response = self._session.post(
1045
1088
  self._cleanup_url_path(self._base_url, "/font/register"),
1046
1089
  files=files,
1047
1090
  headers=headers,
1048
- timeout=30
1091
+ timeout=30,
1092
+ verify=not DISABLE_SSL_VERIFY
1049
1093
  )
1050
1094
 
1095
+ response_size = len(response.content)
1096
+ if DEBUG:
1097
+ print(f"{time.time()}|POST /font/register - response size: {response_size} bytes")
1098
+
1051
1099
  response.raise_for_status()
1052
1100
  return response.text.strip()
1053
1101
 
pdfdancer/types.py CHANGED
@@ -189,7 +189,7 @@ class ParagraphEdit(BaseTextEdit):
189
189
  ):
190
190
  # noinspection PyProtectedMember
191
191
  result = self._target_obj._client._modify_paragraph(self._object_ref, self._new_text)
192
- if result.warning is not None:
192
+ if result.warning:
193
193
  print(f"WARNING: {result.warning}", file=sys.stderr)
194
194
  return result
195
195
  else:
@@ -202,7 +202,7 @@ class ParagraphEdit(BaseTextEdit):
202
202
  )
203
203
  # noinspection PyProtectedMember
204
204
  result = self._target_obj._client._modify_paragraph(self._object_ref, new_paragraph)
205
- if result.warning is not None:
205
+ if result.warning:
206
206
  print(f"WARNING: {result.warning}", file=sys.stderr)
207
207
  return result
208
208
 
@@ -250,7 +250,7 @@ class TextLineEdit(BaseTextEdit):
250
250
  ):
251
251
  # noinspection PyProtectedMember
252
252
  result = self._target_obj._client._modify_text_line(self._object_ref, self._new_text)
253
- if result.warning is not None:
253
+ if result.warning:
254
254
  print(f"WARNING: {result.warning}", file=sys.stderr)
255
255
  return result
256
256
  else:
@@ -0,0 +1,585 @@
1
+ Metadata-Version: 2.4
2
+ Name: pdfdancer-client-python
3
+ Version: 0.2.17
4
+ Summary: Python client for PDFDancer API
5
+ Author-email: "The Famous Cat Ltd." <hi@thefamouscat.com>
6
+ License:
7
+ Apache License
8
+ Version 2.0, January 2004
9
+ http://www.apache.org/licenses/
10
+
11
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
12
+
13
+ 1. Definitions.
14
+
15
+ "License" shall mean the terms and conditions for use, reproduction,
16
+ and distribution as defined by Sections 1 through 9 of this document.
17
+
18
+ "Licensor" shall mean the copyright owner or entity authorized by
19
+ the copyright owner that is granting the License.
20
+
21
+ "Legal Entity" shall mean the union of the acting entity and all
22
+ other entities that control, are controlled by, or are under common
23
+ control with that entity. For the purposes of this definition,
24
+ "control" means (i) the power, direct or indirect, to cause the
25
+ direction or management of such entity, whether by contract or
26
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
27
+ outstanding shares, or (iii) beneficial ownership of such entity.
28
+
29
+ "You" (or "Your") shall mean an individual or Legal Entity
30
+ exercising permissions granted by this License.
31
+
32
+ "Source" form shall mean the preferred form for making modifications,
33
+ including but not limited to software source code, documentation
34
+ source, and configuration files.
35
+
36
+ "Object" form shall mean any form resulting from mechanical
37
+ transformation or translation of a Source form, including but
38
+ not limited to compiled object code, generated documentation,
39
+ and conversions to other media types.
40
+
41
+ "Work" shall mean the work of authorship, whether in Source or
42
+ Object form, made available under the License, as indicated by a
43
+ copyright notice that is included in or attached to the work
44
+ (an example is provided in the Appendix below).
45
+
46
+ "Derivative Works" shall mean any work, whether in Source or Object
47
+ form, that is based on (or derived from) the Work and for which the
48
+ editorial revisions, annotations, elaborations, or other modifications
49
+ represent, as a whole, an original work of authorship. For the purposes
50
+ of this License, Derivative Works shall not include works that remain
51
+ separable from, or merely link (or bind by name) to the interfaces of,
52
+ the Work and Derivative Works thereof.
53
+
54
+ "Contribution" shall mean any work of authorship, including
55
+ the original version of the Work and any modifications or additions
56
+ to that Work or Derivative Works thereof, that is intentionally
57
+ submitted to Licensor for inclusion in the Work by the copyright owner
58
+ or by an individual or Legal Entity authorized to submit on behalf of
59
+ the copyright owner. For the purposes of this definition, "submitted"
60
+ means any form of electronic, verbal, or written communication sent
61
+ to the Licensor or its representatives, including but not limited to
62
+ communication on electronic mailing lists, source code control systems,
63
+ and issue tracking systems that are managed by, or on behalf of, the
64
+ Licensor for the purpose of discussing and improving the Work, but
65
+ excluding communication that is conspicuously marked or otherwise
66
+ designated in writing by the copyright owner as "Not a Contribution."
67
+
68
+ "Contributor" shall mean Licensor and any individual or Legal Entity
69
+ on behalf of whom a Contribution has been received by Licensor and
70
+ subsequently incorporated within the Work.
71
+
72
+ 2. Grant of Copyright License. Subject to the terms and conditions of
73
+ this License, each Contributor hereby grants to You a perpetual,
74
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75
+ copyright license to reproduce, prepare Derivative Works of,
76
+ publicly display, publicly perform, sublicense, and distribute the
77
+ Work and such Derivative Works in Source or Object form.
78
+
79
+ 3. Grant of Patent License. Subject to the terms and conditions of
80
+ this License, each Contributor hereby grants to You a perpetual,
81
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82
+ (except as stated in this section) patent license to make, have made,
83
+ use, offer to sell, sell, import, and otherwise transfer the Work,
84
+ where such license applies only to those patent claims licensable
85
+ by such Contributor that are necessarily infringed by their
86
+ Contribution(s) alone or by combination of their Contribution(s)
87
+ with the Work to which such Contribution(s) was submitted. If You
88
+ institute patent litigation against any entity (including a
89
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
90
+ or a Contribution incorporated within the Work constitutes direct
91
+ or contributory patent infringement, then any patent licenses
92
+ granted to You under this License for that Work shall terminate
93
+ as of the date such litigation is filed.
94
+
95
+ 4. Redistribution. You may reproduce and distribute copies of the
96
+ Work or Derivative Works thereof in any medium, with or without
97
+ modifications, and in Source or Object form, provided that You
98
+ meet the following conditions:
99
+
100
+ (a) You must give any other recipients of the Work or
101
+ Derivative Works a copy of this License; and
102
+
103
+ (b) You must cause any modified files to carry prominent notices
104
+ stating that You changed the files; and
105
+
106
+ (c) You must retain, in the Source form of any Derivative Works
107
+ that You distribute, all copyright, patent, trademark, and
108
+ attribution notices from the Source form of the Work,
109
+ excluding those notices that do not pertain to any part of
110
+ the Derivative Works; and
111
+
112
+ (d) If the Work includes a "NOTICE" text file as part of its
113
+ distribution, then any Derivative Works that You distribute must
114
+ include a readable copy of the attribution notices contained
115
+ within such NOTICE file, excluding those notices that do not
116
+ pertain to any part of the Derivative Works, in at least one
117
+ of the following places: within a NOTICE text file distributed
118
+ as part of the Derivative Works; within the Source form or
119
+ documentation, if provided along with the Derivative Works; or,
120
+ within a display generated by the Derivative Works, if and
121
+ wherever such third-party notices normally appear. The contents
122
+ of the NOTICE file are for informational purposes only and
123
+ do not modify the License. You may add Your own attribution
124
+ notices within Derivative Works that You distribute, alongside
125
+ or as an addendum to the NOTICE text from the Work, provided
126
+ that such additional attribution notices cannot be construed
127
+ as modifying the License.
128
+
129
+ You may add Your own copyright statement to Your modifications and
130
+ may provide additional or different license terms and conditions
131
+ for use, reproduction, or distribution of Your modifications, or
132
+ for any such Derivative Works as a whole, provided Your use,
133
+ reproduction, and distribution of the Work otherwise complies with
134
+ the conditions stated in this License.
135
+
136
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
137
+ any Contribution intentionally submitted for inclusion in the Work
138
+ by You to the Licensor shall be under the terms and conditions of
139
+ this License, without any additional terms or conditions.
140
+ Notwithstanding the above, nothing herein shall supersede or modify
141
+ the terms of any separate license agreement you may have executed
142
+ with Licensor regarding such Contributions.
143
+
144
+ 6. Trademarks. This License does not grant permission to use the trade
145
+ names, trademarks, service marks, or product names of the Licensor,
146
+ except as required for reasonable and customary use in describing the
147
+ origin of the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty. Unless required by applicable law or
150
+ agreed to in writing, Licensor provides the Work (and each
151
+ Contributor provides its Contributions) on an "AS IS" BASIS,
152
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
153
+ implied, including, without limitation, any warranties or conditions
154
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
155
+ PARTICULAR PURPOSE. You are solely responsible for determining the
156
+ appropriateness of using or redistributing the Work and assume any
157
+ risks associated with Your exercise of permissions under this License.
158
+
159
+ 8. Limitation of Liability. In no event and under no legal theory,
160
+ whether in tort (including negligence), contract, or otherwise,
161
+ unless required by applicable law (such as deliberate and grossly
162
+ negligent acts) or agreed to in writing, shall any Contributor be
163
+ liable to You for damages, including any direct, indirect, special,
164
+ incidental, or consequential damages of any character arising as a
165
+ result of this License or out of the use or inability to use the
166
+ Work (including but not limited to damages for loss of goodwill,
167
+ work stoppage, computer failure or malfunction, or any and all
168
+ other commercial damages or losses), even if such Contributor
169
+ has been advised of the possibility of such damages.
170
+
171
+ 9. Accepting Warranty or Additional Liability. While redistributing
172
+ the Work or Derivative Works thereof, You may choose to offer,
173
+ and charge a fee for, acceptance of support, warranty, indemnity,
174
+ or other liability obligations and/or rights consistent with this
175
+ License. However, in accepting such obligations, You may act only
176
+ on Your own behalf and on Your sole responsibility, not on behalf
177
+ of any other Contributor, and only if You agree to indemnify,
178
+ defend, and hold each Contributor harmless for any liability
179
+ incurred by, or claims asserted against, such Contributor by reason
180
+ of your accepting any such warranty or additional liability.
181
+
182
+ END OF TERMS AND CONDITIONS
183
+
184
+ APPENDIX: How to apply the Apache License to your work.
185
+
186
+ To apply the Apache License to your work, attach the following
187
+ boilerplate notice, with the fields enclosed by brackets "[]"
188
+ replaced with your own identifying information. (Don't include
189
+ the brackets!) The text should be enclosed in the appropriate
190
+ comment syntax for the file format. We also recommend that a
191
+ file or class name and description of purpose be included on the
192
+ same "printed page" as the copyright notice for easier
193
+ identification within third-party archives.
194
+
195
+ Copyright [yyyy] [name of copyright owner]
196
+
197
+ Licensed under the Apache License, Version 2.0 (the "License");
198
+ you may not use this file except in compliance with the License.
199
+ You may obtain a copy of the License at
200
+
201
+ http://www.apache.org/licenses/LICENSE-2.0
202
+
203
+ Unless required by applicable law or agreed to in writing, software
204
+ distributed under the License is distributed on an "AS IS" BASIS,
205
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
206
+ See the License for the specific language governing permissions and
207
+ limitations under the License.
208
+
209
+ Project-URL: Homepage, https://www.pdfdancer.com/
210
+ Project-URL: Repository, https://github.com/MenschMachine/pdfdancer-client-python
211
+ Classifier: Development Status :: 4 - Beta
212
+ Classifier: Intended Audience :: Developers
213
+ Classifier: License :: OSI Approved :: Apache Software License
214
+ Classifier: Programming Language :: Python :: 3.10
215
+ Classifier: Programming Language :: Python :: 3.11
216
+ Classifier: Programming Language :: Python :: 3.12
217
+ Classifier: Programming Language :: Python :: 3.13
218
+ Requires-Python: >=3.10
219
+ Description-Content-Type: text/markdown
220
+ License-File: LICENSE
221
+ License-File: NOTICE
222
+ Requires-Dist: requests>=2.25.0
223
+ Requires-Dist: pydantic>=1.8.0
224
+ Requires-Dist: typing-extensions>=4.0.0
225
+ Requires-Dist: python-dotenv>=0.19.0
226
+ Provides-Extra: dev
227
+ Requires-Dist: pytest>=7.0; extra == "dev"
228
+ Requires-Dist: pytest-cov>=4.0; extra == "dev"
229
+ Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
230
+ Requires-Dist: black>=22.0; extra == "dev"
231
+ Requires-Dist: flake8>=5.0; extra == "dev"
232
+ Requires-Dist: mypy>=1.0; extra == "dev"
233
+ Requires-Dist: isort>=5.10.0; extra == "dev"
234
+ Requires-Dist: build>=0.8.0; extra == "dev"
235
+ Requires-Dist: twine>=4.0.0; extra == "dev"
236
+ Dynamic: license-file
237
+
238
+ # PDFDancer Python Client
239
+
240
+ **Getting Started with PDFDancer**
241
+
242
+ PDFDancer gives you pixel-perfect programmatic control over any PDF document from Python. Locate existing elements by
243
+ coordinates or text, adjust them precisely, add brand-new content, and ship the modified PDF in memory or on disk. The
244
+ same API is also available for TypeScript and Java, so teams can orchestrate identical PDF workflows across stacks.
245
+
246
+ > Need the raw API schema? The latest OpenAPI description lives in `docs/openapi.yml` and is published at
247
+ > https://bucket.pdfdancer.com/api-doc/development-0.0.yml.
248
+
249
+ ## Highlights
250
+
251
+ - Locate paragraphs, text lines, images, vector paths, form fields, and pages by index, coordinates, or text prefixes.
252
+ - Edit existing content in place with fluent editors and context managers that apply changes safely.
253
+ - Programmatically control third-party PDFs—modify invoices, contracts, and reports you did not author.
254
+ - Add content with precise XY positioning using paragraph and image builders, custom fonts, and color helpers.
255
+ - Export results as bytes for downstream processing or save directly to disk with one call.
256
+
257
+ ## What Makes PDFDancer Different
258
+
259
+ - **Edit any PDF**: Work with documents from customers, governments, or vendors—not just ones you generated.
260
+ - **Pixel-perfect positioning**: Move or add elements at exact coordinates and keep the original layout intact.
261
+ - **Surgical text replacement**: Swap or rewrite paragraphs without reflowing the rest of the page.
262
+ - **Form manipulation**: Inspect, fill, and update AcroForm fields programmatically.
263
+ - **Coordinate-based selection**: Select objects by position, bounding box, or text patterns.
264
+ - **Real PDF editing**: Modify the underlying PDF structure instead of merely stamping overlays.
265
+
266
+ ## Installation
267
+
268
+ ```bash
269
+ pip install pdfdancer-client-python
270
+
271
+ # Editable install for local development
272
+ pip install -e .
273
+ ```
274
+
275
+ Requires Python 3.10+ and a PDFDancer API token.
276
+
277
+ ## Quick Start — Edit an Existing PDF
278
+
279
+ ```python
280
+ from pathlib import Path
281
+ from pdfdancer import Color, PDFDancer, StandardFonts
282
+
283
+ with PDFDancer.open(
284
+ pdf_data=Path("input.pdf"),
285
+ token="your-api-token", # optional when PDFDANCER_TOKEN is set
286
+ base_url="https://api.pdfdancer.com",
287
+ ) as pdf:
288
+ # Locate and update an existing paragraph
289
+ heading = pdf.page(0).select_paragraphs_starting_with("Executive Summary")[0]
290
+ heading.move_to(72, 680)
291
+ with heading.edit() as editor:
292
+ editor.replace("Overview")
293
+
294
+ # Add a new paragraph with precise placement
295
+ pdf.new_paragraph() \
296
+ .text("Generated with PDFDancer") \
297
+ .font(StandardFonts.HELVETICA, 12) \
298
+ .color(Color(70, 70, 70)) \
299
+ .line_spacing(1.4) \
300
+ .at(page_index=0, x=72, y=520) \
301
+ .add()
302
+
303
+ # Persist the modified document
304
+ pdf.save("output.pdf")
305
+ # or keep it in memory
306
+ pdf_bytes = pdf.get_bytes()
307
+ ```
308
+
309
+ ## Create a Blank PDF
310
+
311
+ ```python
312
+ from pathlib import Path
313
+ from pdfdancer import Color, PDFDancer, StandardFonts
314
+
315
+ with PDFDancer.new(token="your-api-token") as pdf:
316
+ pdf.new_paragraph() \
317
+ .text("Quarterly Summary") \
318
+ .font(StandardFonts.TIMES_BOLD, 18) \
319
+ .color(Color(10, 10, 80)) \
320
+ .line_spacing(1.2) \
321
+ .at(page_index=0, x=72, y=730) \
322
+ .add()
323
+
324
+ pdf.new_image() \
325
+ .from_file(Path("logo.png")) \
326
+ .at(page=0, x=420, y=710) \
327
+ .add()
328
+
329
+ pdf.save("summary.pdf")
330
+ ```
331
+
332
+ ## Work with Forms and Layout
333
+
334
+ ```python
335
+ from pdfdancer import PDFDancer
336
+
337
+ with PDFDancer.open("contract.pdf") as pdf:
338
+ # Inspect global document structure
339
+ pages = pdf.pages()
340
+ print("Total pages:", len(pages))
341
+
342
+ # Update form fields
343
+ signature = pdf.select_form_fields_by_name("signature")[0]
344
+ signature.edit().value("Signed by Jane Doe").apply()
345
+
346
+ # Trim or move content at specific coordinates
347
+ images = pdf.page(1).select_images()
348
+ for image in images:
349
+ x = image.position.x()
350
+ if x is not None and x < 100:
351
+ image.delete()
352
+ ```
353
+
354
+ Selectors return typed objects (`ParagraphObject`, `TextLineObject`, `ImageObject`, `FormFieldObject`, `PageClient`, …)
355
+ with helpers such as `delete()`, `move_to(x, y)`, or `edit()` depending on the object type.
356
+
357
+ ## Configuration
358
+
359
+ - Set `PDFDANCER_TOKEN` for authentication (preferred for local development and CI).
360
+ - Override the API host with `PDFDANCER_BASE_URL` (e.g., sandbox environments).
361
+ - Tune HTTP read timeouts via the `timeout` argument on `PDFDancer.open()` and `PDFDancer.new()`.
362
+ - The HTTP client now keeps TLS connections warm with aggressive pooling and retries. Fine-tune via
363
+ environment variables such as `PDFDANCER_POOL_CONNECTIONS`, `PDFDANCER_POOL_MAXSIZE`,
364
+ `PDFDANCER_RETRY_TOTAL`, and `PDFDANCER_TRUST_ENV=true` (if you want to honour system proxy settings).
365
+
366
+ ## Error Handling
367
+
368
+ Operations raise subclasses of `PdfDancerException`:
369
+
370
+ - `ValidationException`: input validation problems (missing token, invalid coordinates, etc.).
371
+ - `FontNotFoundException`: requested font unavailable on the service.
372
+ - `HttpClientException`: transport or server errors with detailed context.
373
+ - `SessionException`: session creation and lifecycle failures.
374
+
375
+ Wrap automated workflows in `try/except` blocks to surface actionable errors to your users.
376
+
377
+ ## Development Setup
378
+
379
+ ### Prerequisites
380
+
381
+ - **Python 3.10 or higher** (Python 3.9 has SSL issues with large file uploads)
382
+ - **Git** for cloning the repository
383
+ - **PDFDancer API token** for running end-to-end tests
384
+
385
+ ### Step-by-Step Setup
386
+
387
+ #### 1. Clone the Repository
388
+
389
+ ```bash
390
+ git clone https://github.com/MenschMachine/pdfdancer-client-python.git
391
+ cd pdfdancer-client-python/_main
392
+ ```
393
+
394
+ #### 2. Create a Virtual Environment
395
+
396
+ ```bash
397
+ # Create virtual environment
398
+ python -m venv venv
399
+
400
+ # Activate the virtual environment
401
+ # On macOS/Linux:
402
+ source venv/bin/activate
403
+
404
+ # On Windows:
405
+ venv\Scripts\activate
406
+ ```
407
+
408
+ You should see `(venv)` in your terminal prompt indicating the virtual environment is active.
409
+
410
+ #### 3. Install Dependencies
411
+
412
+ ```bash
413
+ # Install the package in editable mode with development dependencies
414
+ pip install -e ".[dev]"
415
+
416
+ # Alternatively, install dependencies separately:
417
+ # pip install -e .
418
+ # pip install -r requirements-dev.txt
419
+ ```
420
+
421
+ This installs:
422
+ - The `pdfdancer` package in editable mode (changes reflect immediately)
423
+ - Development dependencies: `pytest`, `build`, `twine`, etc.
424
+
425
+ #### 4. Configure API Token
426
+
427
+ Set your PDFDancer API token as an environment variable:
428
+
429
+ ```bash
430
+ # On macOS/Linux:
431
+ export PDFDANCER_TOKEN="your-api-token-here"
432
+
433
+ # On Windows (Command Prompt):
434
+ set PDFDANCER_TOKEN=your-api-token-here
435
+
436
+ # On Windows (PowerShell):
437
+ $env:PDFDANCER_TOKEN="your-api-token-here"
438
+ ```
439
+
440
+ For permanent configuration, add this to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.).
441
+
442
+ #### 5. Verify Installation
443
+
444
+ ```bash
445
+ # Run the test suite
446
+ pytest tests/ -v
447
+
448
+ # Run only unit tests (faster)
449
+ pytest tests/test_models.py -v
450
+
451
+ # Run end-to-end tests (requires API token)
452
+ pytest tests/e2e/ -v
453
+ ```
454
+
455
+ All 123 tests should pass if everything is set up correctly.
456
+
457
+ ### Common Development Tasks
458
+
459
+ #### Running Tests
460
+
461
+ ```bash
462
+ # Run all tests with verbose output
463
+ pytest tests/ -v
464
+
465
+ # Run specific test file
466
+ pytest tests/test_models.py -v
467
+
468
+ # Run end-to-end tests only
469
+ pytest tests/e2e/ -v
470
+
471
+ # Run with coverage report
472
+ pytest tests/ --cov=pdfdancer --cov-report=term-missing
473
+ ```
474
+
475
+ #### Building Distribution Packages
476
+
477
+ ```bash
478
+ # Build wheel and source distribution
479
+ python -m build
480
+
481
+ # Verify the built packages
482
+ python -m twine check dist/*
483
+ ```
484
+
485
+ Artifacts will be created in the `dist/` directory.
486
+
487
+ #### Publishing to PyPI
488
+
489
+ ```bash
490
+ # Test upload to TestPyPI (recommended first)
491
+ python -m twine upload --repository testpypi dist/*
492
+
493
+ # Upload to PyPI
494
+ python -m twine upload dist/*
495
+
496
+ # Or use the release script
497
+ python release.py
498
+ ```
499
+
500
+ #### Code Quality
501
+
502
+ ```bash
503
+ # The project follows existing code style
504
+ # No formatter is configured - match the existing patterns
505
+
506
+ # Type checking (if using mypy)
507
+ mypy src/pdfdancer/
508
+
509
+ # Run linting (if configured)
510
+ pylint src/pdfdancer/
511
+ ```
512
+
513
+ ### Project Structure
514
+
515
+ ```
516
+ pdfdancer-client-python/_main/
517
+ ├── src/pdfdancer/ # Main package source
518
+ │ ├── __init__.py # Package exports
519
+ │ ├── pdfdancer_v1.py # Core PDFDancer and PageClient classes
520
+ │ ├── paragraph_builder.py # Fluent paragraph builders
521
+ │ ├── image_builder.py # Fluent image builders
522
+ │ ├── models.py # Data models (Position, Font, Color, etc.)
523
+ │ ├── types.py # Object wrappers (ParagraphObject, etc.)
524
+ │ └── exceptions.py # Exception hierarchy
525
+ ├── tests/ # Test suite
526
+ │ ├── test_models.py # Model unit tests
527
+ │ ├── e2e/ # End-to-end integration tests
528
+ │ └── fixtures/ # Test fixtures and sample PDFs
529
+ ├── docs/ # Documentation
530
+ ├── pyproject.toml # Project metadata and dependencies
531
+ ├── setup.py # Build configuration
532
+ └── README.md # This file
533
+ ```
534
+
535
+ ### Troubleshooting
536
+
537
+ #### Virtual Environment Issues
538
+
539
+ If `python -m venv venv` fails, ensure you have the `venv` module:
540
+
541
+ ```bash
542
+ # On Ubuntu/Debian
543
+ sudo apt-get install python3-venv
544
+
545
+ # On macOS (using Homebrew)
546
+ brew install python@3.10
547
+ ```
548
+
549
+ #### SSL Errors with Large Files
550
+
551
+ Upgrade to Python 3.10+ if you encounter SSL errors during large file uploads.
552
+
553
+ #### Import Errors
554
+
555
+ Ensure the virtual environment is activated and the package is installed in editable mode:
556
+
557
+ ```bash
558
+ source venv/bin/activate # or venv\Scripts\activate on Windows
559
+ pip install -e .
560
+ ```
561
+
562
+ #### Test Failures
563
+
564
+ - Ensure `PDFDANCER_TOKEN` is set for e2e tests
565
+ - Check network connectivity to the PDFDancer API
566
+ - Verify you're using Python 3.10 or higher
567
+
568
+ ### Contributing
569
+
570
+ Contributions are welcome via pull request. Please:
571
+
572
+ 1. Create a feature branch from `main`
573
+ 2. Add tests for new functionality
574
+ 3. Ensure all tests pass: `pytest tests/ -v`
575
+ 4. Follow existing code style and patterns
576
+ 5. Update documentation as needed
577
+
578
+ ## Related SDKs
579
+
580
+ - TypeScript client: https://github.com/MenschMachine/pdfdancer-client-js
581
+ - Java client: https://github.com/MenschMachine/pdfdancer-client-java
582
+
583
+ ## License
584
+
585
+ Apache License 2.0 © 2025 The Famous Cat Ltd. See `LICENSE` and `NOTICE` for details.
@@ -0,0 +1,13 @@
1
+ pdfdancer/__init__.py,sha256=kMxx9nYmp_NdsnWTl6ebmqh2q6G7F-iYECJZfpgVSSo,1935
2
+ pdfdancer/exceptions.py,sha256=Y5zwNVZprsv2hvKX304cXWobJt11nrEhCzLklu2wiO8,1567
3
+ pdfdancer/image_builder.py,sha256=Omxc2LcieJ1MbvWBXR5_sfia--eAucTUe0KWgr22HYo,842
4
+ pdfdancer/models.py,sha256=Tw77OWjELD4sfDqnCwmhczrKClwyLan9gXTqsvgoJxE,24765
5
+ pdfdancer/paragraph_builder.py,sha256=x5XhPo-GUeovQuGbrH7MyyenITcy6in7bz6CD9r-ZqU,9458
6
+ pdfdancer/pdfdancer_v1.py,sha256=WOhsRPQJew8162_lnkn9bvfFE6TJN1AziHkcbpk-xyA,56470
7
+ pdfdancer/types.py,sha256=SYbyzFJu1nDartalqgrceSTiLtsqZgIFQndvHz5Tnxw,12435
8
+ pdfdancer_client_python-0.2.17.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
9
+ pdfdancer_client_python-0.2.17.dist-info/licenses/NOTICE,sha256=xaC4l-IChAmtViNDie8ZWzUk0O6XRMyzOl0zLmVZ2HE,232
10
+ pdfdancer_client_python-0.2.17.dist-info/METADATA,sha256=ccmn874VVkUAXd_LmKPqnBw69VvhpdGzQ2yfJCdh3tI,24665
11
+ pdfdancer_client_python-0.2.17.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
12
+ pdfdancer_client_python-0.2.17.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
13
+ pdfdancer_client_python-0.2.17.dist-info/RECORD,,
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,8 @@
1
+ PDFDancer SDK for Python
2
+ Copyright 2025 The Famous Cat Ltd.
3
+
4
+ This product includes software developed by
5
+ The Famous Cat Ltd. (https://pdfdancer.com)
6
+
7
+ Licensed under the Apache License, Version 2.0.
8
+ See the LICENSE file for details.
@@ -1,190 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: pdfdancer-client-python
3
- Version: 0.2.16
4
- Summary: Python client for PDFDancer API
5
- Author-email: "The Famous Cat Ltd." <hi@thefamouscat.com>
6
- License: MIT
7
- Project-URL: Homepage, https://www.pdfdancer.com/
8
- Project-URL: Repository, https://github.com/MenschMachine/pdfdancer-client-python
9
- Classifier: Development Status :: 4 - Beta
10
- Classifier: Intended Audience :: Developers
11
- Classifier: License :: OSI Approved :: MIT License
12
- Classifier: Programming Language :: Python :: 3.10
13
- Classifier: Programming Language :: Python :: 3.11
14
- Classifier: Programming Language :: Python :: 3.12
15
- Classifier: Programming Language :: Python :: 3.13
16
- Requires-Python: >=3.10
17
- Description-Content-Type: text/markdown
18
- Requires-Dist: requests>=2.25.0
19
- Requires-Dist: pydantic>=1.8.0
20
- Requires-Dist: typing-extensions>=4.0.0
21
- Requires-Dist: python-dotenv>=0.19.0
22
- Provides-Extra: dev
23
- Requires-Dist: pytest>=7.0; extra == "dev"
24
- Requires-Dist: pytest-cov>=4.0; extra == "dev"
25
- Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
26
- Requires-Dist: black>=22.0; extra == "dev"
27
- Requires-Dist: flake8>=5.0; extra == "dev"
28
- Requires-Dist: mypy>=1.0; extra == "dev"
29
- Requires-Dist: isort>=5.10.0; extra == "dev"
30
- Requires-Dist: build>=0.8.0; extra == "dev"
31
- Requires-Dist: twine>=4.0.0; extra == "dev"
32
-
33
- # PDFDancer Python Client
34
-
35
- **Getting Started with PDFDancer**
36
-
37
- PDFDancer gives you pixel-perfect programmatic control over any PDF document from Python. Locate existing elements by
38
- coordinates or text, adjust them precisely, add brand-new content, and ship the modified PDF in memory or on disk. The
39
- same API is also available for TypeScript and Java, so teams can orchestrate identical PDF workflows across stacks.
40
-
41
- > Need the raw API schema? The latest OpenAPI description lives in `docs/openapi.yml` and is published at
42
- > https://bucket.pdfdancer.com/api-doc/development-0.0.yml.
43
-
44
- ## Highlights
45
-
46
- - Locate paragraphs, text lines, images, vector paths, form fields, and pages by index, coordinates, or text prefixes.
47
- - Edit existing content in place with fluent editors and context managers that apply changes safely.
48
- - Programmatically control third-party PDFs—modify invoices, contracts, and reports you did not author.
49
- - Add content with precise XY positioning using paragraph and image builders, custom fonts, and color helpers.
50
- - Export results as bytes for downstream processing or save directly to disk with one call.
51
-
52
- ## What Makes PDFDancer Different
53
-
54
- - **Edit any PDF**: Work with documents from customers, governments, or vendors—not just ones you generated.
55
- - **Pixel-perfect positioning**: Move or add elements at exact coordinates and keep the original layout intact.
56
- - **Surgical text replacement**: Swap or rewrite paragraphs without reflowing the rest of the page.
57
- - **Form manipulation**: Inspect, fill, and update AcroForm fields programmatically.
58
- - **Coordinate-based selection**: Select objects by position, bounding box, or text patterns.
59
- - **Real PDF editing**: Modify the underlying PDF structure instead of merely stamping overlays.
60
-
61
- ## Installation
62
-
63
- ```bash
64
- pip install pdfdancer-client-python
65
-
66
- # Editable install for local development
67
- pip install -e .
68
- ```
69
-
70
- Requires Python 3.10+ and a PDFDancer API token.
71
-
72
- ## Quick Start — Edit an Existing PDF
73
-
74
- ```python
75
- from pathlib import Path
76
- from pdfdancer import Color, PDFDancer, StandardFonts
77
-
78
- with PDFDancer.open(
79
- pdf_data=Path("input.pdf"),
80
- token="your-api-token", # optional when PDFDANCER_TOKEN is set
81
- base_url="https://api.pdfdancer.com",
82
- ) as pdf:
83
- # Locate and update an existing paragraph
84
- heading = pdf.page(0).select_paragraphs_starting_with("Executive Summary")[0]
85
- heading.move_to(72, 680)
86
- with heading.edit() as editor:
87
- editor.replace("Overview")
88
-
89
- # Add a new paragraph with precise placement
90
- pdf.new_paragraph() \
91
- .text("Generated with PDFDancer") \
92
- .font(StandardFonts.HELVETICA, 12) \
93
- .color(Color(70, 70, 70)) \
94
- .line_spacing(1.4) \
95
- .at(page_index=0, x=72, y=520) \
96
- .add()
97
-
98
- # Persist the modified document
99
- pdf.save("output.pdf")
100
- # or keep it in memory
101
- pdf_bytes = pdf.get_bytes()
102
- ```
103
-
104
- ## Create a Blank PDF
105
-
106
- ```python
107
- from pathlib import Path
108
- from pdfdancer import Color, PDFDancer, StandardFonts
109
-
110
- with PDFDancer.new(token="your-api-token") as pdf:
111
- pdf.new_paragraph() \
112
- .text("Quarterly Summary") \
113
- .font(StandardFonts.TIMES_BOLD, 18) \
114
- .color(Color(10, 10, 80)) \
115
- .line_spacing(1.2) \
116
- .at(page_index=0, x=72, y=730) \
117
- .add()
118
-
119
- pdf.new_image() \
120
- .from_file(Path("logo.png")) \
121
- .at(page=0, x=420, y=710) \
122
- .add()
123
-
124
- pdf.save("summary.pdf")
125
- ```
126
-
127
- ## Work with Forms and Layout
128
-
129
- ```python
130
- from pdfdancer import PDFDancer
131
-
132
- with PDFDancer.open("contract.pdf") as pdf:
133
- # Inspect global document structure
134
- pages = pdf.pages()
135
- print("Total pages:", len(pages))
136
-
137
- # Update form fields
138
- signature = pdf.select_form_fields_by_name("signature")[0]
139
- signature.edit().value("Signed by Jane Doe").apply()
140
-
141
- # Trim or move content at specific coordinates
142
- images = pdf.page(1).select_images()
143
- for image in images:
144
- x = image.position.x()
145
- if x is not None and x < 100:
146
- image.delete()
147
- ```
148
-
149
- Selectors return typed objects (`ParagraphObject`, `TextLineObject`, `ImageObject`, `FormFieldObject`, `PageClient`, …)
150
- with helpers such as `delete()`, `move_to(x, y)`, or `edit()` depending on the object type.
151
-
152
- ## Configuration
153
-
154
- - Set `PDFDANCER_TOKEN` for authentication (preferred for local development and CI).
155
- - Override the API host with `PDFDANCER_BASE_URL` (e.g., sandbox environments).
156
- - Tune HTTP read timeouts via the `timeout` argument on `PDFDancer.open()` and `PDFDancer.new()`.
157
-
158
- ## Error Handling
159
-
160
- Operations raise subclasses of `PdfDancerException`:
161
-
162
- - `ValidationException`: input validation problems (missing token, invalid coordinates, etc.).
163
- - `FontNotFoundException`: requested font unavailable on the service.
164
- - `HttpClientException`: transport or server errors with detailed context.
165
- - `SessionException`: session creation and lifecycle failures.
166
-
167
- Wrap automated workflows in `try/except` blocks to surface actionable errors to your users.
168
-
169
- ## Development
170
-
171
- ```bash
172
- python -m venv venv
173
- source venv/bin/activate # Windows: venv\Scripts\activate
174
- pip install -e ".[dev]"
175
-
176
- pytest -q # unit suite
177
- pytest tests/e2e # integration tests (requires live API + fixtures)
178
- python -m build # produce distribution artifacts
179
- ```
180
-
181
- Releases are published with `python release.py`. Contributions are welcome via pull request.
182
-
183
- ## Related SDKs
184
-
185
- - TypeScript client: https://github.com/MenschMachine/pdfdancer-client-js
186
- - Java client: https://github.com/MenschMachine/pdfdancer-client-java
187
-
188
- ## License
189
-
190
- MIT © The Famous Cat Ltd.
@@ -1,11 +0,0 @@
1
- pdfdancer/__init__.py,sha256=_UHBR0vhjhNf9DBX4qnbtQb9iReW4NVgFTZUyk1ioHI,1264
2
- pdfdancer/exceptions.py,sha256=Y5zwNVZprsv2hvKX304cXWobJt11nrEhCzLklu2wiO8,1567
3
- pdfdancer/image_builder.py,sha256=Omxc2LcieJ1MbvWBXR5_sfia--eAucTUe0KWgr22HYo,842
4
- pdfdancer/models.py,sha256=Tw77OWjELD4sfDqnCwmhczrKClwyLan9gXTqsvgoJxE,24765
5
- pdfdancer/paragraph_builder.py,sha256=pgFTkyhYrx4VQDKy4Vhp-042OMlJOD8D0MW9flkvC7Y,9410
6
- pdfdancer/pdfdancer_v1.py,sha256=BbVMNVmjlCESZ0jlWuDmFby90LUv6Y3qJcLLPJCIloc,54487
7
- pdfdancer/types.py,sha256=vG9kTryS6fHmJYGqH31bkq3gG4zF-9DpHqCFkpybuV8,12471
8
- pdfdancer_client_python-0.2.16.dist-info/METADATA,sha256=VELMMZEB27JXJWYZe2rLi6ck9sZ_q_MwPNYhuJngMZU,6911
9
- pdfdancer_client_python-0.2.16.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
10
- pdfdancer_client_python-0.2.16.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
11
- pdfdancer_client_python-0.2.16.dist-info/RECORD,,