API Modules¶
gotenberg_client._chromium.SyncChromiumApi ¶
Represents the Gotenberg API for Chromium-based conversions and screenshots.
Provides methods to create specific route objects for different conversion and screenshot types.
https://gotenberg.dev/docs/routes#convert-with-chromium
Methods:¶
html_to_pdf() -> SyncHtmlToPdfRoute ¶
Creates an SyncHtmlToPdfRoute object for converting HTML to PDF.
Returns:
| Name | Type | Description |
|---|---|---|
SyncHtmlToPdfRoute | SyncHtmlToPdfRoute | A new SyncHtmlToPdfRoute object. |
markdown_to_pdf() -> SyncMarkdownToPdfRoute ¶
Creates a SyncMarkdownToPdfRoute object for converting Markdown to PDF.
Returns:
| Name | Type | Description |
|---|---|---|
SyncMarkdownToPdfRoute | SyncMarkdownToPdfRoute | A new SyncMarkdownToPdfRoute object. |
screenshot_html() -> SyncScreenshotFromHtmlRoute ¶
Creates a SyncScreenshotFromHtmlRoute object for capturing screenshots from HTML files.
Returns:
| Name | Type | Description |
|---|---|---|
SyncScreenshotFromHtmlRoute | SyncScreenshotFromHtmlRoute | A new SyncScreenshotFromHtmlRoute object. |
screenshot_markdown() -> SyncScreenshotFromMarkdownRoute ¶
Creates a SyncScreenshotFromMarkdownRoute object for capturing screenshots from Markdown files.
Returns:
| Name | Type | Description |
|---|---|---|
SyncScreenshotFromMarkdownRoute | SyncScreenshotFromMarkdownRoute | A new SyncScreenshotFromMarkdownRoute object. |
screenshot_url() -> SyncScreenshotFromUrlRoute ¶
Creates a SyncScreenshotFromUrlRoute object for capturing screenshots from URLs.
Returns:
| Name | Type | Description |
|---|---|---|
SyncScreenshotFromUrlRoute | SyncScreenshotFromUrlRoute | A new SyncScreenshotFromUrlRoute object. |
url_to_pdf() -> SyncUrlToPdfRoute ¶
Creates a SyncUrlToPdfRoute object for converting URLs to PDF.
Returns:
| Name | Type | Description |
|---|---|---|
SyncUrlToPdfRoute | SyncUrlToPdfRoute | A new SyncUrlToPdfRoute object. |
gotenberg_client._chromium.AsyncChromiumApi ¶
Represents the asynchronous Gotenberg API for Chromium-based conversions and screenshots.
Provides methods to create specific route objects for different conversion and screenshot types.
https://gotenberg.dev/docs/routes#convert-with-chromium
Methods:¶
html_to_pdf() -> AsyncHtmlToPdfRoute ¶
Creates an AsyncHtmlToPdfRoute object for converting HTML to PDF.
Returns:
| Name | Type | Description |
|---|---|---|
AsyncHtmlToPdfRoute | AsyncHtmlToPdfRoute | A new AsyncHtmlToPdfRoute object. |
markdown_to_pdf() -> AsyncMarkdownToPdfRoute ¶
Creates a AsyncMarkdownToPdfRoute object for converting Markdown to PDF.
Returns:
| Name | Type | Description |
|---|---|---|
AsyncMarkdownToPdfRoute | AsyncMarkdownToPdfRoute | A new AsyncMarkdownToPdfRoute object. |
screenshot_html() -> AsyncScreenshotFromHtmlRoute ¶
Creates a AsyncScreenshotFromHtmlRoute object for capturing screenshots from HTML files.
Returns:
| Name | Type | Description |
|---|---|---|
AsyncScreenshotFromHtmlRoute | AsyncScreenshotFromHtmlRoute | A new AsyncScreenshotFromHtmlRoute object. |
screenshot_markdown() -> AsyncScreenshotFromMarkdownRoute ¶
Creates a AsyncScreenshotFromMarkdownRoute object for capturing screenshots from Markdown files.
Returns:
| Name | Type | Description |
|---|---|---|
AsyncScreenshotFromMarkdownRoute | AsyncScreenshotFromMarkdownRoute | A new SyncScreenshotFromMarkdownRoute object. |
screenshot_url() -> AsyncScreenshotFromUrlRoute ¶
Creates a AsyncScreenshotFromUrlRoute object for capturing screenshots from URLs.
Returns:
| Name | Type | Description |
|---|---|---|
AsyncScreenshotFromUrlRoute | AsyncScreenshotFromUrlRoute | A new AsyncScreenshotFromUrlRoute object. |
url_to_pdf() -> AsyncUrlToPdfRoute ¶
Creates a AsyncUrlToPdfRoute object for converting URLs to PDF.
Returns:
| Name | Type | Description |
|---|---|---|
AsyncUrlToPdfRoute | AsyncUrlToPdfRoute | A new AsyncUrlToPdfRoute object. |
gotenberg_client._libreoffice.SyncLibreOfficeApi ¶
Represents the sync Gotenberg API for LibreOffice-based conversions.
Methods:¶
to_pdf() -> SyncOfficeDocumentToPdfRoute ¶
Creates a SyncOfficeDocumentToPdfRoute object for converting documents to PDF.
Returns:
| Name | Type | Description |
|---|---|---|
SyncOfficeDocumentToPdfRoute | SyncOfficeDocumentToPdfRoute | A new SyncOfficeDocumentToPdfRoute object. |
gotenberg_client._libreoffice.AsyncLibreOfficeApi ¶
Represents the sync Gotenberg API for LibreOffice-based conversions.
Methods:¶
to_pdf() -> AsyncOfficeDocumentToPdfRoute ¶
Creates a AsyncOfficeDocumentToPdfRoute object for converting documents to PDF.
Returns:
| Name | Type | Description |
|---|---|---|
AsyncOfficeDocumentToPdfRoute | AsyncOfficeDocumentToPdfRoute | A new AsyncOfficeDocumentToPdfRoute object. |
gotenberg_client._pdfa_ua.SyncPdfAApi ¶
gotenberg_client._pdfa_ua.AsyncPdfAApi ¶
Methods:¶
to_pdfa() -> AsyncConvertToArchiveFormatRoute ¶
Creates a ConvertPdfToPdfAUa object for converting PDFs to PDF/A format.
Returns:
| Name | Type | Description |
|---|---|---|
ConvertPdfToPdfAUa | AsyncConvertToArchiveFormatRoute | A new ConvertPdfToPdfAUa object. |
gotenberg_client._pdfmetadata.SyncPdfMetadataApi ¶
gotenberg_client._pdfmetadata.AsyncPdfMetadataApi ¶
gotenberg_client._merge.SyncMergePdfsApi ¶
gotenberg_client._merge.AsyncMergePdfsApi ¶
gotenberg_client._others.SyncSplitApi ¶
gotenberg_client._others.AsyncSplitApi ¶
gotenberg_client._others.SyncFlattenApi ¶
gotenberg_client._others.AsyncFlattenApi ¶
gotenberg_client._health.SyncHealthCheckApi ¶
Synchronous implementation of the Gotenberg health check API.
This class provides a synchronous interface for performing health checks on the Gotenberg service.
For more information on Gotenberg's health check endpoint, see: https://gotenberg.dev/docs/routes#health
Methods:¶
health() -> HealthStatus ¶
Perform a health check on the Gotenberg service.
This method sends a GET request to the Gotenberg health check endpoint and returns the parsed health status.
For more details on the health check API, see: https://gotenberg.dev/docs/routes#health
Returns:
| Name | Type | Description |
|---|---|---|
HealthStatus | HealthStatus | An object representing the current health status of the Gotenberg service. |
Raises:
| Type | Description |
|---|---|
HTTPStatusError | If the request to the health check endpoint fails. |
gotenberg_client._health.AsyncHealthCheckApi ¶
Asynchronous implementation of the Gotenberg health check API.
This class provides an asynchronous interface for performing health checks on the Gotenberg service.
For more information on Gotenberg's health check endpoint, see: https://gotenberg.dev/docs/routes#health
Methods:¶
health() -> HealthStatus async ¶
Perform an asynchronous health check on the Gotenberg service.
This method sends an asynchronous GET request to the Gotenberg health check endpoint and returns the parsed health status.
For more details on the health check API, see: https://gotenberg.dev/docs/routes#health
Returns:
| Name | Type | Description |
|---|---|---|
HealthStatus | HealthStatus | An object representing the current health status of the Gotenberg service. |
Raises:
| Type | Description |
|---|---|
HTTPStatusError | If the request to the health check endpoint fails. |