Metadata-Version: 2.3
Name: pdfrest
Version: 1.0.1
Summary: Python client library for interacting with the PDFRest API
Keywords: api,document-processing,pdf,pdfrest,sdk
Author: Datalogics
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: exceptiongroup>=1.3.0
Requires-Dist: httpx>=0.28.1
Requires-Dist: langcodes>=3.4.0
Requires-Dist: pydantic>=2.12.0
Maintainer: Datalogics
Requires-Python: >=3.10
Project-URL: Documentation, https://python.pdfrest.com/
Project-URL: Homepage, https://pdfrest.com/
Project-URL: Source, https://github.com/pdfrest/pdfrest-python
Description-Content-Type: text/markdown

# pdfrest

Python client library for the PDFRest service. The project is managed with
[uv](https://docs.astral.sh/uv/) and targets Python 3.9 and newer.

## Running examples

```bash
uvx nox -s examples
uv run nox -s run-example -- examples/delete/delete_example.py
```

## Getting started

```bash
uv sync
uv run python -c "import pdfrest; print(pdfrest.__version__)"
```

## Development

To install the tooling used by CI locally, include the `--group dev` flag:

```bash
uv sync --group dev
```

It is recommended to enable the pre-commit hooks after installation:

```bash
uv run pre-commit install
```

Run the test suite with:

```bash
uv run pytest
```

Check per-function coverage for the client classes:

```bash
uvx nox -s class-coverage
```

To reuse an existing `coverage/py<version>/coverage.json` without rerunning
tests, add `-- --no-tests` (and optional `--coverage-json path`).

## Documentation

Run the docs site locally:

```bash
uv run mkdocs serve
```

Build the static documentation site:

```bash
uv run mkdocs build --strict
```
