Skip to main content

Python client library for interacting with the PDFRest API

Project description

pdfrest

Python client library for the PDFRest service. The project is managed with uv and targets Python 3.9 and newer.

Running examples

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

Getting started

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:

uv sync --group dev

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

uv run pre-commit install

Run the test suite with:

uv run pytest

Check per-function coverage for the client classes:

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:

uv run mkdocs serve

Build the static documentation site:

uv run mkdocs build --strict

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdfrest-1.0.0.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pdfrest-1.0.0-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

Details for the file pdfrest-1.0.0.tar.gz.

File metadata

  • Download URL: pdfrest-1.0.0.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pdfrest-1.0.0.tar.gz
Algorithm Hash digest
SHA256 44c8525d33d54413750e2a094abd94243cd9ab51083f690d14b4a7ba31893822
MD5 7821b12c088d12319a0cf9eb292a518d
BLAKE2b-256 3ce455538efad8cb4af5f1b55280bd66e41bc623389f9ffef592b5739884b92e

See more details on using hashes here.

File details

Details for the file pdfrest-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pdfrest-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 61.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pdfrest-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5ae74177cf1d97363cb92cb6408342ef906cc1914a56c5620280ebe2154eb50
MD5 e6bad44c424825308cfaee9f040e3f5a
BLAKE2b-256 4ff56abef94b1e23152f9293316745b332f4f0c184783fa126405949c3ea2559

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page