docling-client 2.120.1__tar.gz
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.
- docling_client-2.120.1/.gitignore +444 -0
- docling_client-2.120.1/PKG-INFO +144 -0
- docling_client-2.120.1/README.md +116 -0
- docling_client-2.120.1/pyproject.toml +72 -0
|
@@ -0,0 +1,444 @@
|
|
|
1
|
+
model_artifacts/
|
|
2
|
+
scratch/
|
|
3
|
+
ds_convert_models/
|
|
4
|
+
|
|
5
|
+
# Created by https://www.toptal.com/developers/gitignore/api/python,macos,virtualenv,pycharm,visualstudiocode,emacs,vim,jupyternotebooks
|
|
6
|
+
# Edit at https://www.toptal.com/developers/gitignore?templates=python,macos,virtualenv,pycharm,visualstudiocode,emacs,vim,jupyternotebooks
|
|
7
|
+
|
|
8
|
+
### Emacs ###
|
|
9
|
+
# -*- mode: gitignore; -*-
|
|
10
|
+
*~
|
|
11
|
+
\#*\#
|
|
12
|
+
/.emacs.desktop
|
|
13
|
+
/.emacs.desktop.lock
|
|
14
|
+
*.elc
|
|
15
|
+
auto-save-list
|
|
16
|
+
tramp
|
|
17
|
+
.\#*
|
|
18
|
+
|
|
19
|
+
# Org-mode
|
|
20
|
+
.org-id-locations
|
|
21
|
+
*_archive
|
|
22
|
+
|
|
23
|
+
# flymake-mode
|
|
24
|
+
*_flymake.*
|
|
25
|
+
|
|
26
|
+
# eshell files
|
|
27
|
+
/eshell/history
|
|
28
|
+
/eshell/lastdir
|
|
29
|
+
|
|
30
|
+
# elpa packages
|
|
31
|
+
/elpa/
|
|
32
|
+
|
|
33
|
+
# reftex files
|
|
34
|
+
*.rel
|
|
35
|
+
|
|
36
|
+
# AUCTeX auto folder
|
|
37
|
+
/auto/
|
|
38
|
+
|
|
39
|
+
# cask packages
|
|
40
|
+
.cask/
|
|
41
|
+
dist/
|
|
42
|
+
|
|
43
|
+
# Flycheck
|
|
44
|
+
flycheck_*.el
|
|
45
|
+
|
|
46
|
+
# server auth directory
|
|
47
|
+
/server/
|
|
48
|
+
|
|
49
|
+
# projectiles files
|
|
50
|
+
.projectile
|
|
51
|
+
|
|
52
|
+
# directory configuration
|
|
53
|
+
.dir-locals.el
|
|
54
|
+
|
|
55
|
+
# network security
|
|
56
|
+
/network-security.data
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### JupyterNotebooks ###
|
|
60
|
+
# gitignore template for Jupyter Notebooks
|
|
61
|
+
# website: http://jupyter.org/
|
|
62
|
+
|
|
63
|
+
.ipynb_checkpoints
|
|
64
|
+
*/.ipynb_checkpoints/*
|
|
65
|
+
|
|
66
|
+
# IPython
|
|
67
|
+
profile_default/
|
|
68
|
+
ipython_config.py
|
|
69
|
+
|
|
70
|
+
# Remove previous ipynb_checkpoints
|
|
71
|
+
# git rm -r .ipynb_checkpoints/
|
|
72
|
+
|
|
73
|
+
### macOS ###
|
|
74
|
+
# General
|
|
75
|
+
.DS_Store
|
|
76
|
+
.AppleDouble
|
|
77
|
+
.LSOverride
|
|
78
|
+
|
|
79
|
+
# Icon must end with two \r
|
|
80
|
+
Icon
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
# Thumbnails
|
|
84
|
+
._*
|
|
85
|
+
|
|
86
|
+
# Files that might appear in the root of a volume
|
|
87
|
+
.DocumentRevisions-V100
|
|
88
|
+
.fseventsd
|
|
89
|
+
.Spotlight-V100
|
|
90
|
+
.TemporaryItems
|
|
91
|
+
.Trashes
|
|
92
|
+
.VolumeIcon.icns
|
|
93
|
+
.com.apple.timemachine.donotpresent
|
|
94
|
+
|
|
95
|
+
# Directories potentially created on remote AFP share
|
|
96
|
+
.AppleDB
|
|
97
|
+
.AppleDesktop
|
|
98
|
+
Network Trash Folder
|
|
99
|
+
Temporary Items
|
|
100
|
+
.apdisk
|
|
101
|
+
|
|
102
|
+
### macOS Patch ###
|
|
103
|
+
# iCloud generated files
|
|
104
|
+
*.icloud
|
|
105
|
+
|
|
106
|
+
### PyCharm ###
|
|
107
|
+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
|
|
108
|
+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
|
109
|
+
|
|
110
|
+
# User-specific stuff
|
|
111
|
+
.idea/**/workspace.xml
|
|
112
|
+
.idea/**/tasks.xml
|
|
113
|
+
.idea/**/usage.statistics.xml
|
|
114
|
+
.idea/**/dictionaries
|
|
115
|
+
.idea/**/shelf
|
|
116
|
+
|
|
117
|
+
# AWS User-specific
|
|
118
|
+
.idea/**/aws.xml
|
|
119
|
+
|
|
120
|
+
# Generated files
|
|
121
|
+
.idea/**/contentModel.xml
|
|
122
|
+
|
|
123
|
+
# Sensitive or high-churn files
|
|
124
|
+
.idea/**/dataSources/
|
|
125
|
+
.idea/**/dataSources.ids
|
|
126
|
+
.idea/**/dataSources.local.xml
|
|
127
|
+
.idea/**/sqlDataSources.xml
|
|
128
|
+
.idea/**/dynamic.xml
|
|
129
|
+
.idea/**/uiDesigner.xml
|
|
130
|
+
.idea/**/dbnavigator.xml
|
|
131
|
+
|
|
132
|
+
# Gradle
|
|
133
|
+
.idea/**/gradle.xml
|
|
134
|
+
.idea/**/libraries
|
|
135
|
+
|
|
136
|
+
# Gradle and Maven with auto-import
|
|
137
|
+
# When using Gradle or Maven with auto-import, you should exclude module files,
|
|
138
|
+
# since they will be recreated, and may cause churn. Uncomment if using
|
|
139
|
+
# auto-import.
|
|
140
|
+
# .idea/artifacts
|
|
141
|
+
# .idea/compiler.xml
|
|
142
|
+
# .idea/jarRepositories.xml
|
|
143
|
+
# .idea/modules.xml
|
|
144
|
+
# .idea/*.iml
|
|
145
|
+
# .idea/modules
|
|
146
|
+
# *.iml
|
|
147
|
+
# *.ipr
|
|
148
|
+
|
|
149
|
+
# CMake
|
|
150
|
+
cmake-build-*/
|
|
151
|
+
|
|
152
|
+
# Mongo Explorer plugin
|
|
153
|
+
.idea/**/mongoSettings.xml
|
|
154
|
+
|
|
155
|
+
# File-based project format
|
|
156
|
+
*.iws
|
|
157
|
+
|
|
158
|
+
# IntelliJ
|
|
159
|
+
out/
|
|
160
|
+
|
|
161
|
+
# mpeltonen/sbt-idea plugin
|
|
162
|
+
.idea_modules/
|
|
163
|
+
|
|
164
|
+
# JIRA plugin
|
|
165
|
+
atlassian-ide-plugin.xml
|
|
166
|
+
|
|
167
|
+
# Cursive Clojure plugin
|
|
168
|
+
.idea/replstate.xml
|
|
169
|
+
|
|
170
|
+
# SonarLint plugin
|
|
171
|
+
.idea/sonarlint/
|
|
172
|
+
|
|
173
|
+
# Crashlytics plugin (for Android Studio and IntelliJ)
|
|
174
|
+
com_crashlytics_export_strings.xml
|
|
175
|
+
crashlytics.properties
|
|
176
|
+
crashlytics-build.properties
|
|
177
|
+
fabric.properties
|
|
178
|
+
|
|
179
|
+
# Editor-based Rest Client
|
|
180
|
+
.idea/httpRequests
|
|
181
|
+
|
|
182
|
+
# Android studio 3.1+ serialized cache file
|
|
183
|
+
.idea/caches/build_file_checksums.ser
|
|
184
|
+
|
|
185
|
+
### PyCharm Patch ###
|
|
186
|
+
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
|
|
187
|
+
|
|
188
|
+
# *.iml
|
|
189
|
+
# modules.xml
|
|
190
|
+
# .idea/misc.xml
|
|
191
|
+
# *.ipr
|
|
192
|
+
|
|
193
|
+
# Sonarlint plugin
|
|
194
|
+
# https://plugins.jetbrains.com/plugin/7973-sonarlint
|
|
195
|
+
.idea/**/sonarlint/
|
|
196
|
+
|
|
197
|
+
# SonarQube Plugin
|
|
198
|
+
# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
|
|
199
|
+
.idea/**/sonarIssues.xml
|
|
200
|
+
|
|
201
|
+
# Markdown Navigator plugin
|
|
202
|
+
# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
|
|
203
|
+
.idea/**/markdown-navigator.xml
|
|
204
|
+
.idea/**/markdown-navigator-enh.xml
|
|
205
|
+
.idea/**/markdown-navigator/
|
|
206
|
+
|
|
207
|
+
# Cache file creation bug
|
|
208
|
+
# See https://youtrack.jetbrains.com/issue/JBR-2257
|
|
209
|
+
.idea/$CACHE_FILE$
|
|
210
|
+
|
|
211
|
+
# CodeStream plugin
|
|
212
|
+
# https://plugins.jetbrains.com/plugin/12206-codestream
|
|
213
|
+
.idea/codestream.xml
|
|
214
|
+
|
|
215
|
+
# Azure Toolkit for IntelliJ plugin
|
|
216
|
+
# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
|
|
217
|
+
.idea/**/azureSettings.xml
|
|
218
|
+
|
|
219
|
+
### Python ###
|
|
220
|
+
# Byte-compiled / optimized / DLL files
|
|
221
|
+
__pycache__/
|
|
222
|
+
*.py[cod]
|
|
223
|
+
*$py.class
|
|
224
|
+
|
|
225
|
+
# C extensions
|
|
226
|
+
*.so
|
|
227
|
+
|
|
228
|
+
# Distribution / packaging
|
|
229
|
+
.Python
|
|
230
|
+
build/
|
|
231
|
+
develop-eggs/
|
|
232
|
+
downloads/
|
|
233
|
+
eggs/
|
|
234
|
+
.eggs/
|
|
235
|
+
lib/
|
|
236
|
+
lib64/
|
|
237
|
+
parts/
|
|
238
|
+
sdist/
|
|
239
|
+
var/
|
|
240
|
+
wheels/
|
|
241
|
+
share/python-wheels/
|
|
242
|
+
*.egg-info/
|
|
243
|
+
.installed.cfg
|
|
244
|
+
*.egg
|
|
245
|
+
MANIFEST
|
|
246
|
+
|
|
247
|
+
# PyInstaller
|
|
248
|
+
# Usually these files are written by a python script from a template
|
|
249
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
250
|
+
*.manifest
|
|
251
|
+
*.spec
|
|
252
|
+
|
|
253
|
+
# Installer logs
|
|
254
|
+
pip-log.txt
|
|
255
|
+
pip-delete-this-directory.txt
|
|
256
|
+
|
|
257
|
+
# Unit test / coverage reports
|
|
258
|
+
htmlcov/
|
|
259
|
+
.tox/
|
|
260
|
+
.nox/
|
|
261
|
+
.coverage
|
|
262
|
+
.coverage.*
|
|
263
|
+
.cache
|
|
264
|
+
nosetests.xml
|
|
265
|
+
coverage.xml
|
|
266
|
+
*.cover
|
|
267
|
+
*.py,cover
|
|
268
|
+
.hypothesis/
|
|
269
|
+
.pytest_cache/
|
|
270
|
+
cover/
|
|
271
|
+
|
|
272
|
+
# Translations
|
|
273
|
+
*.mo
|
|
274
|
+
*.pot
|
|
275
|
+
|
|
276
|
+
# Django stuff:
|
|
277
|
+
*.log
|
|
278
|
+
local_settings.py
|
|
279
|
+
db.sqlite3
|
|
280
|
+
db.sqlite3-journal
|
|
281
|
+
|
|
282
|
+
# Flask stuff:
|
|
283
|
+
instance/
|
|
284
|
+
.webassets-cache
|
|
285
|
+
|
|
286
|
+
# Scrapy stuff:
|
|
287
|
+
.scrapy
|
|
288
|
+
|
|
289
|
+
# Sphinx documentation
|
|
290
|
+
docs/_build/
|
|
291
|
+
|
|
292
|
+
# PyBuilder
|
|
293
|
+
.pybuilder/
|
|
294
|
+
target/
|
|
295
|
+
|
|
296
|
+
# Jupyter Notebook
|
|
297
|
+
|
|
298
|
+
# IPython
|
|
299
|
+
|
|
300
|
+
# pyenv
|
|
301
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
302
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
303
|
+
# .python-version
|
|
304
|
+
|
|
305
|
+
# pipenv
|
|
306
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
307
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
308
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
309
|
+
# install all needed dependencies.
|
|
310
|
+
#Pipfile.lock
|
|
311
|
+
|
|
312
|
+
# poetry
|
|
313
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
314
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
315
|
+
# commonly ignored for libraries.
|
|
316
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
317
|
+
#poetry.lock
|
|
318
|
+
|
|
319
|
+
# pdm
|
|
320
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
321
|
+
#pdm.lock
|
|
322
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
323
|
+
# in version control.
|
|
324
|
+
# https://pdm.fming.dev/#use-with-ide
|
|
325
|
+
.pdm.toml
|
|
326
|
+
|
|
327
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
328
|
+
__pypackages__/
|
|
329
|
+
|
|
330
|
+
# Celery stuff
|
|
331
|
+
celerybeat-schedule
|
|
332
|
+
celerybeat.pid
|
|
333
|
+
|
|
334
|
+
# SageMath parsed files
|
|
335
|
+
*.sage.py
|
|
336
|
+
|
|
337
|
+
# Environments
|
|
338
|
+
.env
|
|
339
|
+
.venv
|
|
340
|
+
env/
|
|
341
|
+
venv/
|
|
342
|
+
ENV/
|
|
343
|
+
env.bak/
|
|
344
|
+
venv.bak/
|
|
345
|
+
|
|
346
|
+
# Spyder project settings
|
|
347
|
+
.spyderproject
|
|
348
|
+
.spyproject
|
|
349
|
+
|
|
350
|
+
# Rope project settings
|
|
351
|
+
.ropeproject
|
|
352
|
+
|
|
353
|
+
# docs site build output (zensical, mkdocs)
|
|
354
|
+
/site
|
|
355
|
+
|
|
356
|
+
# generated docs sources — produced by scripts/render_notebooks.py and
|
|
357
|
+
# scripts/render_cli_reference.py at build time
|
|
358
|
+
/docs/_generated/
|
|
359
|
+
/docs/reference/cli.md
|
|
360
|
+
|
|
361
|
+
# Pyre type checker
|
|
362
|
+
.pyre/
|
|
363
|
+
|
|
364
|
+
# pytype static type analyzer
|
|
365
|
+
.pytype/
|
|
366
|
+
|
|
367
|
+
# Cython debug symbols
|
|
368
|
+
cython_debug/
|
|
369
|
+
|
|
370
|
+
# PyCharm
|
|
371
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
372
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
373
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
374
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
375
|
+
.idea/
|
|
376
|
+
|
|
377
|
+
### Python Patch ###
|
|
378
|
+
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
|
|
379
|
+
poetry.toml
|
|
380
|
+
|
|
381
|
+
# ruff
|
|
382
|
+
.ruff_cache/
|
|
383
|
+
|
|
384
|
+
### Vim ###
|
|
385
|
+
# Swap
|
|
386
|
+
[._]*.s[a-v][a-z]
|
|
387
|
+
!*.svg # comment out if you don't need vector files
|
|
388
|
+
[._]*.sw[a-p]
|
|
389
|
+
[._]s[a-rt-v][a-z]
|
|
390
|
+
[._]ss[a-gi-z]
|
|
391
|
+
[._]sw[a-p]
|
|
392
|
+
|
|
393
|
+
# Session
|
|
394
|
+
Session.vim
|
|
395
|
+
Sessionx.vim
|
|
396
|
+
|
|
397
|
+
# Temporary
|
|
398
|
+
.netrwhist
|
|
399
|
+
# Auto-generated tag files
|
|
400
|
+
tags
|
|
401
|
+
# Persistent undo
|
|
402
|
+
[._]*.un~
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
### Visual Studio Code ###
|
|
406
|
+
.vscode/
|
|
407
|
+
|
|
408
|
+
### VirtualEnv ###
|
|
409
|
+
# Virtualenv
|
|
410
|
+
# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
|
|
411
|
+
[Bb]in
|
|
412
|
+
[Ii]nclude
|
|
413
|
+
[Ll]ib
|
|
414
|
+
[Ll]ib64
|
|
415
|
+
[Ll]ocal
|
|
416
|
+
pyvenv.cfg
|
|
417
|
+
pip-selfcheck.json
|
|
418
|
+
|
|
419
|
+
### VisualStudioCode ###
|
|
420
|
+
.vscode/*
|
|
421
|
+
!.vscode/settings.json
|
|
422
|
+
!.vscode/tasks.json
|
|
423
|
+
!.vscode/launch.json
|
|
424
|
+
!.vscode/extensions.json
|
|
425
|
+
!.vscode/*.code-snippets
|
|
426
|
+
|
|
427
|
+
# Local History for Visual Studio Code
|
|
428
|
+
.history/
|
|
429
|
+
|
|
430
|
+
# Built Visual Studio Code Extensions
|
|
431
|
+
*.vsix
|
|
432
|
+
|
|
433
|
+
### VisualStudioCode Patch ###
|
|
434
|
+
# Ignore all local history of files
|
|
435
|
+
.history
|
|
436
|
+
.ionide
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
# Docs
|
|
440
|
+
# docs/**/*.png
|
|
441
|
+
# docs/**/*.svg
|
|
442
|
+
|
|
443
|
+
# AI agents
|
|
444
|
+
**/.bob/
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: docling-client
|
|
3
|
+
Version: 2.120.1
|
|
4
|
+
Summary: Client SDK for converting documents via a remote Docling Serve endpoint.
|
|
5
|
+
Project-URL: homepage, https://github.com/docling-project/docling
|
|
6
|
+
Project-URL: repository, https://github.com/docling-project/docling
|
|
7
|
+
Project-URL: issues, https://github.com/docling-project/docling/issues
|
|
8
|
+
Project-URL: changelog, https://github.com/docling-project/docling/blob/main/CHANGELOG.md
|
|
9
|
+
Author-email: Christoph Auer <cau@zurich.ibm.com>, Michele Dolfi <dol@zurich.ibm.com>, Maxim Lysak <mly@zurich.ibm.com>, Nikos Livathinos <nli@zurich.ibm.com>, Ahmed Nassar <ahn@zurich.ibm.com>, Panos Vagenas <pva@zurich.ibm.com>, Peter Staar <taa@zurich.ibm.com>
|
|
10
|
+
License-Expression: MIT
|
|
11
|
+
Keywords: api,client,convert,docling,document,pdf,remote,service
|
|
12
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Intended Audience :: Science/Research
|
|
15
|
+
Classifier: Operating System :: MacOS :: MacOS X
|
|
16
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
17
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
24
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
25
|
+
Requires-Python: <4.0,>=3.10
|
|
26
|
+
Requires-Dist: docling-slim[service-client]==2.120.1
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
|
|
29
|
+
# Docling Client
|
|
30
|
+
|
|
31
|
+
**Lightweight client SDK for converting documents via a remote [Docling Serve](https://github.com/docling-project/docling-serve) endpoint**
|
|
32
|
+
|
|
33
|
+
`docling-client` is a meta-package that installs [`docling-slim[service-client]`](https://pypi.org/project/docling-slim/), giving you `DoclingServiceClient` — a drop-in replacement for the local `DocumentConverter` that offloads conversion to a Docling Serve instance over HTTP.
|
|
34
|
+
|
|
35
|
+
For the full documentation, see the [Docling docs](https://docling-project.github.io/docling/usage/api_server/).
|
|
36
|
+
|
|
37
|
+
## Why a remote client?
|
|
38
|
+
|
|
39
|
+
| You want to… | Use |
|
|
40
|
+
|---|---|
|
|
41
|
+
| Convert documents in a Python application, **without running models locally** | `docling-client` → point at a Docling Serve endpoint |
|
|
42
|
+
| Run Docling directly **in-process** in a Python application | [`docling`](https://pypi.org/project/docling/) |
|
|
43
|
+
| Full control over which extras are installed | [`docling-slim[service-client]`](https://pypi.org/project/docling-slim/) |
|
|
44
|
+
|
|
45
|
+
Switching from local to remote conversion typically requires changing only the client class and the endpoint URL — the conversion API (sources, options, output formats) stays the same.
|
|
46
|
+
|
|
47
|
+
## Getting started
|
|
48
|
+
|
|
49
|
+
### 1. Install
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
pip install docling-client
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 2. Point at a Docling Serve endpoint
|
|
56
|
+
|
|
57
|
+
You need a running [Docling Serve](https://github.com/docling-project/docling-serve) instance — [self-hosted](https://docling-project.github.io/docling/usage/api_server/deployment/) or a [managed service](#managed-services).
|
|
58
|
+
|
|
59
|
+
Set your connection details in the environment (or a `.env` file):
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
DOCLING_SERVICE_URL=https://your-docling-service.example.com
|
|
63
|
+
DOCLING_SERVICE_API_KEY=your-api-key # omit if the service is unauthenticated
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### 3. Convert a document
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
import os
|
|
70
|
+
from docling.service_client import DoclingServiceClient
|
|
71
|
+
|
|
72
|
+
with DoclingServiceClient(
|
|
73
|
+
url=os.environ["DOCLING_SERVICE_URL"],
|
|
74
|
+
api_key=os.environ.get("DOCLING_SERVICE_API_KEY", ""),
|
|
75
|
+
) as client:
|
|
76
|
+
result = client.convert(source="https://arxiv.org/pdf/2501.17887")
|
|
77
|
+
print(result.document.export_to_markdown())
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Convert many documents concurrently:
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
sources = [
|
|
84
|
+
"https://arxiv.org/pdf/2501.17887",
|
|
85
|
+
"path/to/report.pdf",
|
|
86
|
+
"path/to/slides.pptx",
|
|
87
|
+
]
|
|
88
|
+
|
|
89
|
+
with DoclingServiceClient(url=os.environ["DOCLING_SERVICE_URL"]) as client:
|
|
90
|
+
for result in client.convert_all(source=sources, max_concurrency=4):
|
|
91
|
+
print(result.input.file.name, result.status)
|
|
92
|
+
print(result.document.export_to_markdown()[:200])
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Switching from local to remote
|
|
96
|
+
|
|
97
|
+
If you already use the local `DocumentConverter`, the client API mirrors it closely. Only the import and instantiation change:
|
|
98
|
+
|
|
99
|
+
```python
|
|
100
|
+
# Before — local, runs models on this machine
|
|
101
|
+
from docling.document_converter import DocumentConverter
|
|
102
|
+
converter = DocumentConverter()
|
|
103
|
+
result = converter.convert("report.pdf")
|
|
104
|
+
|
|
105
|
+
# After — remote, offloads conversion to Docling Serve
|
|
106
|
+
from docling.service_client import DoclingServiceClient
|
|
107
|
+
converter = DoclingServiceClient(url="https://...", api_key="...")
|
|
108
|
+
result = converter.convert(source="report.pdf")
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Both `result.document.export_to_markdown()` and other output methods work the same way.
|
|
112
|
+
|
|
113
|
+
## Managed services
|
|
114
|
+
|
|
115
|
+
Running [Docling Serve](https://github.com/docling-project/docling-serve) yourself means operating infrastructure. Managed services remove that overhead.
|
|
116
|
+
|
|
117
|
+
### Docling for IBM watsonx
|
|
118
|
+
|
|
119
|
+
A fully managed, hosted instance of Docling Serve — no servers, GPUs, scaling, or operational monitoring required. It exposes the same REST API, so your client code stays portable: swap the base URL, supply your API key, and go.
|
|
120
|
+
|
|
121
|
+
- [Product page](https://www.ibm.com/products/docling)
|
|
122
|
+
- [Free trial](https://www.ibm.com/products/docling) — no credit card needed
|
|
123
|
+
|
|
124
|
+
## More examples
|
|
125
|
+
|
|
126
|
+
Runnable examples are in [`docs/examples/service_client/`](https://github.com/docling-project/docling/tree/main/docs/examples/service_client/) in the repository:
|
|
127
|
+
|
|
128
|
+
| Script | What it shows |
|
|
129
|
+
|---|---|
|
|
130
|
+
| [`convert.py`](https://github.com/docling-project/docling/blob/main/docs/examples/service_client/convert.py) | `convert()` and `convert_all()` — the high-level API |
|
|
131
|
+
| [`tasks.py`](https://github.com/docling-project/docling/blob/main/docs/examples/service_client/tasks.py) | Job lifecycle: `submit()`, `watch()`, `result()`, result targets |
|
|
132
|
+
| [`batch.py`](https://github.com/docling-project/docling/blob/main/docs/examples/service_client/batch.py) | `submit_batch()` for plugin sources and artifact targets |
|
|
133
|
+
| [`chunk.py`](https://github.com/docling-project/docling/blob/main/docs/examples/service_client/chunk.py) | `chunk()` — split a document into retrieval-ready pieces |
|
|
134
|
+
|
|
135
|
+
## Documentation
|
|
136
|
+
|
|
137
|
+
- [API server overview](https://docling-project.github.io/docling/usage/api_server/)
|
|
138
|
+
- [Deployment guide](https://docling-project.github.io/docling/usage/api_server/deployment/)
|
|
139
|
+
- [Managed services](https://docling-project.github.io/docling/usage/api_server/managed/)
|
|
140
|
+
- [REST API reference](https://docling-project.github.io/docling/usage/api_server/rest_api/)
|
|
141
|
+
|
|
142
|
+
## License
|
|
143
|
+
|
|
144
|
+
MIT License — see [LICENSE](https://github.com/docling-project/docling/blob/main/LICENSE)
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# Docling Client
|
|
2
|
+
|
|
3
|
+
**Lightweight client SDK for converting documents via a remote [Docling Serve](https://github.com/docling-project/docling-serve) endpoint**
|
|
4
|
+
|
|
5
|
+
`docling-client` is a meta-package that installs [`docling-slim[service-client]`](https://pypi.org/project/docling-slim/), giving you `DoclingServiceClient` — a drop-in replacement for the local `DocumentConverter` that offloads conversion to a Docling Serve instance over HTTP.
|
|
6
|
+
|
|
7
|
+
For the full documentation, see the [Docling docs](https://docling-project.github.io/docling/usage/api_server/).
|
|
8
|
+
|
|
9
|
+
## Why a remote client?
|
|
10
|
+
|
|
11
|
+
| You want to… | Use |
|
|
12
|
+
|---|---|
|
|
13
|
+
| Convert documents in a Python application, **without running models locally** | `docling-client` → point at a Docling Serve endpoint |
|
|
14
|
+
| Run Docling directly **in-process** in a Python application | [`docling`](https://pypi.org/project/docling/) |
|
|
15
|
+
| Full control over which extras are installed | [`docling-slim[service-client]`](https://pypi.org/project/docling-slim/) |
|
|
16
|
+
|
|
17
|
+
Switching from local to remote conversion typically requires changing only the client class and the endpoint URL — the conversion API (sources, options, output formats) stays the same.
|
|
18
|
+
|
|
19
|
+
## Getting started
|
|
20
|
+
|
|
21
|
+
### 1. Install
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pip install docling-client
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 2. Point at a Docling Serve endpoint
|
|
28
|
+
|
|
29
|
+
You need a running [Docling Serve](https://github.com/docling-project/docling-serve) instance — [self-hosted](https://docling-project.github.io/docling/usage/api_server/deployment/) or a [managed service](#managed-services).
|
|
30
|
+
|
|
31
|
+
Set your connection details in the environment (or a `.env` file):
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
DOCLING_SERVICE_URL=https://your-docling-service.example.com
|
|
35
|
+
DOCLING_SERVICE_API_KEY=your-api-key # omit if the service is unauthenticated
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### 3. Convert a document
|
|
39
|
+
|
|
40
|
+
```python
|
|
41
|
+
import os
|
|
42
|
+
from docling.service_client import DoclingServiceClient
|
|
43
|
+
|
|
44
|
+
with DoclingServiceClient(
|
|
45
|
+
url=os.environ["DOCLING_SERVICE_URL"],
|
|
46
|
+
api_key=os.environ.get("DOCLING_SERVICE_API_KEY", ""),
|
|
47
|
+
) as client:
|
|
48
|
+
result = client.convert(source="https://arxiv.org/pdf/2501.17887")
|
|
49
|
+
print(result.document.export_to_markdown())
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Convert many documents concurrently:
|
|
53
|
+
|
|
54
|
+
```python
|
|
55
|
+
sources = [
|
|
56
|
+
"https://arxiv.org/pdf/2501.17887",
|
|
57
|
+
"path/to/report.pdf",
|
|
58
|
+
"path/to/slides.pptx",
|
|
59
|
+
]
|
|
60
|
+
|
|
61
|
+
with DoclingServiceClient(url=os.environ["DOCLING_SERVICE_URL"]) as client:
|
|
62
|
+
for result in client.convert_all(source=sources, max_concurrency=4):
|
|
63
|
+
print(result.input.file.name, result.status)
|
|
64
|
+
print(result.document.export_to_markdown()[:200])
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Switching from local to remote
|
|
68
|
+
|
|
69
|
+
If you already use the local `DocumentConverter`, the client API mirrors it closely. Only the import and instantiation change:
|
|
70
|
+
|
|
71
|
+
```python
|
|
72
|
+
# Before — local, runs models on this machine
|
|
73
|
+
from docling.document_converter import DocumentConverter
|
|
74
|
+
converter = DocumentConverter()
|
|
75
|
+
result = converter.convert("report.pdf")
|
|
76
|
+
|
|
77
|
+
# After — remote, offloads conversion to Docling Serve
|
|
78
|
+
from docling.service_client import DoclingServiceClient
|
|
79
|
+
converter = DoclingServiceClient(url="https://...", api_key="...")
|
|
80
|
+
result = converter.convert(source="report.pdf")
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Both `result.document.export_to_markdown()` and other output methods work the same way.
|
|
84
|
+
|
|
85
|
+
## Managed services
|
|
86
|
+
|
|
87
|
+
Running [Docling Serve](https://github.com/docling-project/docling-serve) yourself means operating infrastructure. Managed services remove that overhead.
|
|
88
|
+
|
|
89
|
+
### Docling for IBM watsonx
|
|
90
|
+
|
|
91
|
+
A fully managed, hosted instance of Docling Serve — no servers, GPUs, scaling, or operational monitoring required. It exposes the same REST API, so your client code stays portable: swap the base URL, supply your API key, and go.
|
|
92
|
+
|
|
93
|
+
- [Product page](https://www.ibm.com/products/docling)
|
|
94
|
+
- [Free trial](https://www.ibm.com/products/docling) — no credit card needed
|
|
95
|
+
|
|
96
|
+
## More examples
|
|
97
|
+
|
|
98
|
+
Runnable examples are in [`docs/examples/service_client/`](https://github.com/docling-project/docling/tree/main/docs/examples/service_client/) in the repository:
|
|
99
|
+
|
|
100
|
+
| Script | What it shows |
|
|
101
|
+
|---|---|
|
|
102
|
+
| [`convert.py`](https://github.com/docling-project/docling/blob/main/docs/examples/service_client/convert.py) | `convert()` and `convert_all()` — the high-level API |
|
|
103
|
+
| [`tasks.py`](https://github.com/docling-project/docling/blob/main/docs/examples/service_client/tasks.py) | Job lifecycle: `submit()`, `watch()`, `result()`, result targets |
|
|
104
|
+
| [`batch.py`](https://github.com/docling-project/docling/blob/main/docs/examples/service_client/batch.py) | `submit_batch()` for plugin sources and artifact targets |
|
|
105
|
+
| [`chunk.py`](https://github.com/docling-project/docling/blob/main/docs/examples/service_client/chunk.py) | `chunk()` — split a document into retrieval-ready pieces |
|
|
106
|
+
|
|
107
|
+
## Documentation
|
|
108
|
+
|
|
109
|
+
- [API server overview](https://docling-project.github.io/docling/usage/api_server/)
|
|
110
|
+
- [Deployment guide](https://docling-project.github.io/docling/usage/api_server/deployment/)
|
|
111
|
+
- [Managed services](https://docling-project.github.io/docling/usage/api_server/managed/)
|
|
112
|
+
- [REST API reference](https://docling-project.github.io/docling/usage/api_server/rest_api/)
|
|
113
|
+
|
|
114
|
+
## License
|
|
115
|
+
|
|
116
|
+
MIT License — see [LICENSE](https://github.com/docling-project/docling/blob/main/LICENSE)
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "docling-client"
|
|
7
|
+
version = "2.120.1" # DO NOT EDIT, updated automatically
|
|
8
|
+
description = "Client SDK for converting documents via a remote Docling Serve endpoint."
|
|
9
|
+
license = "MIT"
|
|
10
|
+
keywords = [
|
|
11
|
+
"docling",
|
|
12
|
+
"convert",
|
|
13
|
+
"document",
|
|
14
|
+
"pdf",
|
|
15
|
+
"service",
|
|
16
|
+
"client",
|
|
17
|
+
"remote",
|
|
18
|
+
"api",
|
|
19
|
+
]
|
|
20
|
+
classifiers = [
|
|
21
|
+
"Operating System :: MacOS :: MacOS X",
|
|
22
|
+
"Operating System :: POSIX :: Linux",
|
|
23
|
+
"Operating System :: Microsoft :: Windows",
|
|
24
|
+
"Development Status :: 5 - Production/Stable",
|
|
25
|
+
"Intended Audience :: Developers",
|
|
26
|
+
"Intended Audience :: Science/Research",
|
|
27
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
28
|
+
"Programming Language :: Python :: 3",
|
|
29
|
+
"Programming Language :: Python :: 3.10",
|
|
30
|
+
"Programming Language :: Python :: 3.11",
|
|
31
|
+
"Programming Language :: Python :: 3.12",
|
|
32
|
+
"Programming Language :: Python :: 3.13",
|
|
33
|
+
"Programming Language :: Python :: 3.14",
|
|
34
|
+
]
|
|
35
|
+
readme = "README.md"
|
|
36
|
+
authors = [
|
|
37
|
+
{ name = "Christoph Auer", email = "cau@zurich.ibm.com" },
|
|
38
|
+
{ name = "Michele Dolfi", email = "dol@zurich.ibm.com" },
|
|
39
|
+
{ name = "Maxim Lysak", email = "mly@zurich.ibm.com" },
|
|
40
|
+
{ name = "Nikos Livathinos", email = "nli@zurich.ibm.com" },
|
|
41
|
+
{ name = "Ahmed Nassar", email = "ahn@zurich.ibm.com" },
|
|
42
|
+
{ name = "Panos Vagenas", email = "pva@zurich.ibm.com" },
|
|
43
|
+
{ name = "Peter Staar", email = "taa@zurich.ibm.com" },
|
|
44
|
+
]
|
|
45
|
+
requires-python = '>=3.10,<4.0'
|
|
46
|
+
|
|
47
|
+
# Meta-package: pulls in docling-slim with the service-client extra.
|
|
48
|
+
# The `docling` Python module itself is provided by docling-slim.
|
|
49
|
+
dependencies = [
|
|
50
|
+
'docling-slim[service-client]==2.120.1',
|
|
51
|
+
]
|
|
52
|
+
|
|
53
|
+
[project.urls]
|
|
54
|
+
homepage = "https://github.com/docling-project/docling"
|
|
55
|
+
repository = "https://github.com/docling-project/docling"
|
|
56
|
+
issues = "https://github.com/docling-project/docling/issues"
|
|
57
|
+
changelog = "https://github.com/docling-project/docling/blob/main/CHANGELOG.md"
|
|
58
|
+
|
|
59
|
+
[tool.uv.sources]
|
|
60
|
+
# For local development: use workspace member
|
|
61
|
+
docling-slim = { workspace = true }
|
|
62
|
+
|
|
63
|
+
# Dependency-only wheel: no Python modules shipped here. All source lives in
|
|
64
|
+
# the docling-slim wheel (built from the repo root).
|
|
65
|
+
[tool.hatch.build.targets.wheel]
|
|
66
|
+
bypass-selection = true
|
|
67
|
+
|
|
68
|
+
[tool.hatch.build.targets.sdist]
|
|
69
|
+
only-include = ["pyproject.toml", "README.md"]
|
|
70
|
+
|
|
71
|
+
[tool.uv]
|
|
72
|
+
package = true
|