pdfdancer-client-python 0.2.16__py3-none-any.whl → 0.2.18__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/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.18
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: httpx[http2]>=0.27.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 or local environments). Defaults to `https://api.pdfdancer.com`.
361
+ - Tune HTTP read timeouts via the `timeout` argument on `PDFDancer.open()` and `PDFDancer.new()` (default: 30 seconds).
362
+ - For testing against self-signed certificates, call `pdfdancer.set_ssl_verify(False)` to temporarily disable TLS verification.
363
+
364
+ ## Error Handling
365
+
366
+ Operations raise subclasses of `PdfDancerException`:
367
+
368
+ - `ValidationException`: input validation problems (missing token, invalid coordinates, etc.).
369
+ - `FontNotFoundException`: requested font unavailable on the service.
370
+ - `HttpClientException`: transport or server errors with detailed context.
371
+ - `SessionException`: session creation and lifecycle failures.
372
+
373
+ Wrap automated workflows in `try/except` blocks to surface actionable errors to your users.
374
+
375
+ ## Development Setup
376
+
377
+ ### Prerequisites
378
+
379
+ - **Python 3.10 or higher** (Python 3.9 has SSL issues with large file uploads)
380
+ - **Git** for cloning the repository
381
+ - **PDFDancer API token** for running end-to-end tests
382
+
383
+ ### Step-by-Step Setup
384
+
385
+ #### 1. Clone the Repository
386
+
387
+ ```bash
388
+ git clone https://github.com/MenschMachine/pdfdancer-client-python.git
389
+ cd pdfdancer-client-python/_main
390
+ ```
391
+
392
+ #### 2. Create a Virtual Environment
393
+
394
+ ```bash
395
+ # Create virtual environment
396
+ python -m venv venv
397
+
398
+ # Activate the virtual environment
399
+ # On macOS/Linux:
400
+ source venv/bin/activate
401
+
402
+ # On Windows:
403
+ venv\Scripts\activate
404
+ ```
405
+
406
+ You should see `(venv)` in your terminal prompt indicating the virtual environment is active.
407
+
408
+ #### 3. Install Dependencies
409
+
410
+ ```bash
411
+ # Install the package in editable mode with development dependencies
412
+ pip install -e ".[dev]"
413
+
414
+ # Alternatively, install runtime dependencies only:
415
+ # pip install -e .
416
+ ```
417
+
418
+ This installs:
419
+ - The `pdfdancer` package in editable mode (changes reflect immediately)
420
+ - Development tooling including `pytest`, `pytest-cov`, `pytest-mock`, `black`, `isort`, `flake8`, `mypy`, `build`, and `twine`.
421
+
422
+ #### 4. Configure API Token
423
+
424
+ Set your PDFDancer API token as an environment variable:
425
+
426
+ ```bash
427
+ # On macOS/Linux:
428
+ export PDFDANCER_TOKEN="your-api-token-here"
429
+
430
+ # On Windows (Command Prompt):
431
+ set PDFDANCER_TOKEN=your-api-token-here
432
+
433
+ # On Windows (PowerShell):
434
+ $env:PDFDANCER_TOKEN="your-api-token-here"
435
+ ```
436
+
437
+ For permanent configuration, add this to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.).
438
+
439
+ #### 5. Verify Installation
440
+
441
+ ```bash
442
+ # Run the test suite
443
+ pytest tests/ -v
444
+
445
+ # Run only unit tests (faster)
446
+ pytest tests/test_models.py -v
447
+
448
+ # Run end-to-end tests (requires API token)
449
+ pytest tests/e2e/ -v
450
+ ```
451
+
452
+ All tests should pass if everything is set up correctly.
453
+
454
+ ### Common Development Tasks
455
+
456
+ #### Running Tests
457
+
458
+ ```bash
459
+ # Run all tests with verbose output
460
+ pytest tests/ -v
461
+
462
+ # Run specific test file
463
+ pytest tests/test_models.py -v
464
+
465
+ # Run end-to-end tests only
466
+ pytest tests/e2e/ -v
467
+
468
+ # Run with coverage report
469
+ pytest tests/ --cov=pdfdancer --cov-report=term-missing
470
+ ```
471
+
472
+ #### Building Distribution Packages
473
+
474
+ ```bash
475
+ # Build wheel and source distribution
476
+ python -m build
477
+
478
+ # Verify the built packages
479
+ python -m twine check dist/*
480
+ ```
481
+
482
+ Artifacts will be created in the `dist/` directory.
483
+
484
+ #### Publishing to PyPI
485
+
486
+ ```bash
487
+ # Test upload to TestPyPI (recommended first)
488
+ python -m twine upload --repository testpypi dist/*
489
+
490
+ # Upload to PyPI
491
+ python -m twine upload dist/*
492
+
493
+ # Or use the release script
494
+ python release.py
495
+ ```
496
+
497
+ #### Code Quality
498
+
499
+ ```bash
500
+ # Format code
501
+ black src tests
502
+ isort src tests
503
+
504
+ # Lint
505
+ flake8 src tests
506
+
507
+ # Type checking
508
+ mypy src/pdfdancer/
509
+ ```
510
+
511
+ ### Project Structure
512
+
513
+ ```
514
+ pdfdancer-client-python/_main/
515
+ ├── src/pdfdancer/ # Main package source
516
+ │ ├── __init__.py # Package exports
517
+ │ ├── pdfdancer_v1.py # Core PDFDancer and PageClient classes
518
+ │ ├── paragraph_builder.py # Fluent paragraph builders
519
+ │ ├── image_builder.py # Fluent image builders
520
+ │ ├── models.py # Data models (Position, Font, Color, etc.)
521
+ │ ├── types.py # Object wrappers (ParagraphObject, etc.)
522
+ │ └── exceptions.py # Exception hierarchy
523
+ ├── tests/ # Test suite
524
+ │ ├── test_models.py # Model unit tests
525
+ │ ├── e2e/ # End-to-end integration tests
526
+ │ └── fixtures/ # Test fixtures and sample PDFs
527
+ ├── docs/ # Documentation
528
+ ├── dist/ # Build artifacts (created after packaging)
529
+ ├── logs/ # Local execution logs (ignored in VCS)
530
+ ├── pyproject.toml # Project metadata and dependencies
531
+ ├── release.py # Helper for publishing releases
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,15 @@
1
+ pdfdancer/__init__.py,sha256=ZZOarTVp9OJQUYA8PsBn8FWNCEHIaCcSHitd4dpBR5w,2150
2
+ pdfdancer/exceptions.py,sha256=WAcyTacykJwjiaURrQamEgizLxv0vSlSio6NMikg4D0,1558
3
+ pdfdancer/fingerprint.py,sha256=Ue5QzpqsKlbYefvKU0ULV4NgMU3AOTcseeV9HfiPJXI,3093
4
+ pdfdancer/image_builder.py,sha256=Omxc2LcieJ1MbvWBXR5_sfia--eAucTUe0KWgr22HYo,842
5
+ pdfdancer/models.py,sha256=kK2tIRwJ8XQJZZ__uSgvU6E0NRtj11Jzwwhy-d8EKSQ,32210
6
+ pdfdancer/paragraph_builder.py,sha256=x5XhPo-GUeovQuGbrH7MyyenITcy6in7bz6CD9r-ZqU,9458
7
+ pdfdancer/path_builder.py,sha256=KJC8toLhbCbtnxz8pphtpzgoBemGHlrcC1s02RAvCJ8,15862
8
+ pdfdancer/pdfdancer_v1.py,sha256=pR2TnA57l2tXzVZHaBz_QFvZcVAdeWgwUXtO5OhPOPc,87350
9
+ pdfdancer/types.py,sha256=SYbyzFJu1nDartalqgrceSTiLtsqZgIFQndvHz5Tnxw,12435
10
+ pdfdancer_client_python-0.2.18.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
11
+ pdfdancer_client_python-0.2.18.dist-info/licenses/NOTICE,sha256=xaC4l-IChAmtViNDie8ZWzUk0O6XRMyzOl0zLmVZ2HE,232
12
+ pdfdancer_client_python-0.2.18.dist-info/METADATA,sha256=37zeBth-hMmDWCMBdqShEsC8neWz8kqFOZIC-ALm4RA,24668
13
+ pdfdancer_client_python-0.2.18.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
14
+ pdfdancer_client_python-0.2.18.dist-info/top_level.txt,sha256=ICwSVRpcCKrdBF9QlaX9Y0e_N3Nk1p7QVxadGOnbxeY,10
15
+ pdfdancer_client_python-0.2.18.dist-info/RECORD,,