pdfrender 0.1.0__tar.gz → 1.0.0__tar.gz

pdfrender-1.0.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.3
+Name: pdfrender
+Version: 1.0.0
+Summary: A client library for accessing pdfrender
+Requires-Dist: httpx>=0.23.1,<0.29.0
+Requires-Dist: attrs>=22.2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# pdfrender — Python SDK
+
+HTML and CSS to PDF API and MCP server. WeasyPrint with page headers, footers and page numbers, no headless browser. Hosted in Germany.
+
+```sh
+pip install pdfrender
+```
+
+[Get an API key](https://pdfrender.dev/go/pypi-sdk?to=/app/api-keys) and pass it to the client:
+
+```python
+import os
+
+from pdfrender import AuthenticatedClient
+from pdfrender.api.account import get_me
+
+client = AuthenticatedClient(
+    base_url="https://api.pdfrender.dev",
+    token=os.environ["PDFRENDER_API_KEY"],
+    auth_header_name="X-API-Key",
+    prefix="",
+)
+print(get_me.sync(client=client))
+```
+
+Every operation is a module with `sync`, `sync_detailed`, `asyncio` and `asyncio_detailed`; file fields take a `pdfrender.types.File(payload=..., file_name=..., mime_type=...)`.
+
+## Operations
+
+| Operation | Module | What it does |
+|---|---|---|
+| `GET /v1/me` | `pdfrender.api.account.get_me` | Your plan, remaining requests, and remaining credits |
+| `POST /v1/render` | `pdfrender.api.render.render_html_to_pdf` | Render an HTML document to a PDF |
+
+Generated with openapi-python-client from [`openapi.sdk.json`](../openapi.sdk.json). API reference: https://pdfrender.dev/docs · Support: https://pdfrender.dev/support

pdfrender-1.0.0/README.md

@@ -0,0 +1,35 @@
+# pdfrender — Python SDK
+
+HTML and CSS to PDF API and MCP server. WeasyPrint with page headers, footers and page numbers, no headless browser. Hosted in Germany.
+
+```sh
+pip install pdfrender
+```
+
+[Get an API key](https://pdfrender.dev/go/pypi-sdk?to=/app/api-keys) and pass it to the client:
+
+```python
+import os
+
+from pdfrender import AuthenticatedClient
+from pdfrender.api.account import get_me
+
+client = AuthenticatedClient(
+    base_url="https://api.pdfrender.dev",
+    token=os.environ["PDFRENDER_API_KEY"],
+    auth_header_name="X-API-Key",
+    prefix="",
+)
+print(get_me.sync(client=client))
+```
+
+Every operation is a module with `sync`, `sync_detailed`, `asyncio` and `asyncio_detailed`; file fields take a `pdfrender.types.File(payload=..., file_name=..., mime_type=...)`.
+
+## Operations
+
+| Operation | Module | What it does |
+|---|---|---|
+| `GET /v1/me` | `pdfrender.api.account.get_me` | Your plan, remaining requests, and remaining credits |
+| `POST /v1/render` | `pdfrender.api.render.render_html_to_pdf` | Render an HTML document to a PDF |
+
+Generated with openapi-python-client from [`openapi.sdk.json`](../openapi.sdk.json). API reference: https://pdfrender.dev/docs · Support: https://pdfrender.dev/support

pdfrender-1.0.0/pdfrender/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing pdfrender"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

pdfrender-1.0.0/pdfrender/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

pdfrender-1.0.0/pdfrender/api/account/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

pdfrender-1.0.0/pdfrender/api/account/get_me.py

@@ -0,0 +1,176 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.me_response import MeResponse
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/me",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MeResponse | None:
+    if response.status_code == 200:
+        response_200 = MeResponse.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[MeResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[MeResponse]:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[MeResponse]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+) -> MeResponse | None:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        MeResponse
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[MeResponse]:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[MeResponse]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+) -> MeResponse | None:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        MeResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

pdfrender-1.0.0/pdfrender/api/render/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

pdfrender-1.0.0/pdfrender/api/render/render_html_to_pdf.py

@@ -0,0 +1,273 @@
+from http import HTTPStatus
+from io import BytesIO
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.problem import Problem
+from ...models.render_request import RenderRequest
+from ...types import File, Response
+
+
+def _get_kwargs(
+    *,
+    body: RenderRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/render",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> File | Problem | None:
+    if response.status_code == 200:
+        response_200 = File(payload=BytesIO(response.content))
+
+        return response_200
+
+    if response.status_code == 400:
+        response_400 = Problem.from_dict(response.json())
+
+        return response_400
+
+    if response.status_code == 402:
+        response_402 = Problem.from_dict(response.json())
+
+        return response_402
+
+    if response.status_code == 403:
+        response_403 = Problem.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 413:
+        response_413 = Problem.from_dict(response.json())
+
+        return response_413
+
+    if response.status_code == 422:
+        response_422 = Problem.from_dict(response.json())
+
+        return response_422
+
+    if response.status_code == 429:
+        response_429 = Problem.from_dict(response.json())
+
+        return response_429
+
+    if response.status_code == 500:
+        response_500 = Problem.from_dict(response.json())
+
+        return response_500
+
+    if response.status_code == 504:
+        response_504 = Problem.from_dict(response.json())
+
+        return response_504
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[File | Problem]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: RenderRequest,
+) -> Response[File | Problem]:
+    """Render an HTML document to a PDF
+
+     Send an HTML document and get the PDF back as a download.
+
+    Inline images, fonts and CSS as `data:` URIs. External resources (http,
+    https, file) are not loaded: a document that references one is rejected with
+    400, and the detail lists the URLs. Relative URLs are ignored. JavaScript is
+    not run.
+
+    Limits: 2 MB of HTML, 50 pages, and 20 seconds including time in the queue.
+    Without an API key, the limit is 8 seconds and one render runs at a time.
+
+    On a paid plan, set `pdf_variant` to `pdf/a-2b` or `pdf/a-3b` for PDF/A
+    output.
+
+    Works without an API key for 10 requests a day per IP address. With a
+    key, a rejected or failed call costs no credits.
+
+    **Credits:** 1 per call.
+
+    Args:
+        body (RenderRequest): An HTML document to render, an optional filename and an optional
+            PDF/A variant.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[File | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: RenderRequest,
+) -> File | Problem | None:
+    """Render an HTML document to a PDF
+
+     Send an HTML document and get the PDF back as a download.
+
+    Inline images, fonts and CSS as `data:` URIs. External resources (http,
+    https, file) are not loaded: a document that references one is rejected with
+    400, and the detail lists the URLs. Relative URLs are ignored. JavaScript is
+    not run.
+
+    Limits: 2 MB of HTML, 50 pages, and 20 seconds including time in the queue.
+    Without an API key, the limit is 8 seconds and one render runs at a time.
+
+    On a paid plan, set `pdf_variant` to `pdf/a-2b` or `pdf/a-3b` for PDF/A
+    output.
+
+    Works without an API key for 10 requests a day per IP address. With a
+    key, a rejected or failed call costs no credits.
+
+    **Credits:** 1 per call.
+
+    Args:
+        body (RenderRequest): An HTML document to render, an optional filename and an optional
+            PDF/A variant.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        File | Problem
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: RenderRequest,
+) -> Response[File | Problem]:
+    """Render an HTML document to a PDF
+
+     Send an HTML document and get the PDF back as a download.
+
+    Inline images, fonts and CSS as `data:` URIs. External resources (http,
+    https, file) are not loaded: a document that references one is rejected with
+    400, and the detail lists the URLs. Relative URLs are ignored. JavaScript is
+    not run.
+
+    Limits: 2 MB of HTML, 50 pages, and 20 seconds including time in the queue.
+    Without an API key, the limit is 8 seconds and one render runs at a time.
+
+    On a paid plan, set `pdf_variant` to `pdf/a-2b` or `pdf/a-3b` for PDF/A
+    output.
+
+    Works without an API key for 10 requests a day per IP address. With a
+    key, a rejected or failed call costs no credits.
+
+    **Credits:** 1 per call.
+
+    Args:
+        body (RenderRequest): An HTML document to render, an optional filename and an optional
+            PDF/A variant.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[File | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: RenderRequest,
+) -> File | Problem | None:
+    """Render an HTML document to a PDF
+
+     Send an HTML document and get the PDF back as a download.
+
+    Inline images, fonts and CSS as `data:` URIs. External resources (http,
+    https, file) are not loaded: a document that references one is rejected with
+    400, and the detail lists the URLs. Relative URLs are ignored. JavaScript is
+    not run.
+
+    Limits: 2 MB of HTML, 50 pages, and 20 seconds including time in the queue.
+    Without an API key, the limit is 8 seconds and one render runs at a time.
+
+    On a paid plan, set `pdf_variant` to `pdf/a-2b` or `pdf/a-3b` for PDF/A
+    output.
+
+    Works without an API key for 10 requests a day per IP address. With a
+    key, a rejected or failed call costs no credits.
+
+    **Credits:** 1 per call.
+
+    Args:
+        body (RenderRequest): An HTML document to render, an optional filename and an optional
+            PDF/A variant.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        File | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed