Metadata-Version: 2.5
Name: gembox-pdfapi
Version: 2026.9.100
Summary: Python client for the GemBox.PdfApi engine.
Project-URL: Homepage, https://www.gemboxsoftware.com/pdf-api
Author: GemBox Ltd.
License-Expression: LicenseRef-GemBox-EULA
License-File: EULA.txt
Keywords: api,client,gembox,pdf,pdfapi,sdk
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: httpx<1,>=0.27
Description-Content-Type: text/markdown

# gembox-pdfapi

`gembox-pdfapi` is the Python client for the GemBox.PdfApi engine — a self-hosted REST API for
converting, securing, extracting and organizing PDF documents. The engine does the work; this
package is a thin, fully typed wrapper over its HTTP API.

## Quickstart

Install the package:

```shell
pip install gembox-pdfapi
```

or, with `uv`:

```shell
uv add gembox-pdfapi
```

The client needs a running engine to talk to. Pull its image and start one using the built-in `FREE-LIMITED-KEY`:

```shell
docker pull gembox/pdfapi
docker run --rm -p 8080:8080 -e GEMBOX_PDFAPI_LICENSE_KEY=FREE-LIMITED-KEY gembox/pdfapi
```

Then merge a couple of PDF documents against it:

```python
from gembox_pdfapi import PdfApiClient

with PdfApiClient("http://localhost:8080") as client:
    result = client.merge(["first.pdf", "second.pdf"])
    result.save("merged.pdf")
```

## Requirements

- Python 3.10 or later, on any operating system.
- A running GemBox.PdfApi engine to talk to.

## Licensing

The engine needs a license, not this package. Set `GEMBOX_PDFAPI_LICENSE_KEY` on the engine at
startup, the way the Quickstart shows.

This package is distributed under GemBox's End User License Agreement, included as `EULA.txt`.

## Learn more

Full product documentation: <https://www.gemboxsoftware.com/pdf-api>
