gotenberg-client 0.7.0__tar.gz → 0.8.2__tar.gz

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
       - id: detect-private-key
     # See https://github.com/prettier/prettier/issues/15742 for the fork reason
   - repo: https://github.com/rbubley/mirrors-prettier
-    rev: "v3.3.3"
+    rev: "v3.4.2"
     hooks:
       - id: prettier
         types_or:
@@ -45,13 +45,13 @@ repos:
       - id: codespell
   # Python hooks
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.6.9'
+    rev: 'v0.8.2'
     hooks:
       # Run the linter.
       - id: ruff
       # Run the formatter.
       - id: ruff-format
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "2.2.4"
+    rev: "v2.5.0"
     hooks:
       - id: pyproject-fmt

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/CHANGELOG.md

@@ -5,6 +5,41 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.2] - 2024-12-17
+
+### Fixed
+
+- Bump pypa/gh-action-pypi-publish from 1.12.2 to 1.12.3, fixing core metadata publishing issue
+
+## [0.8.1] - 2024-12-17
+
+### Fixed
+
+- Relaxed version restriction on `httpx`
+
+### Changed
+
+- Test in CI using Gotenberg 8.14.1
+
+## [0.8.0] - 2024-12-11
+
+### Breaking Change
+
+- Dropped support for Python 3.8 ([#43](https://github.com/stumpylog/gotenberg-client/pull/43))
+
+### Added
+
+- Official support and testing for Python 3.13 ([#25](https://github.com/stumpylog/gotenberg-client/pull/25))
+- Support for setting PDF metadata ([#42](https://github.com/stumpylog/gotenberg-client/pull/42))
+  - Initial work by @spechtx in ([#40](https://github.com/stumpylog/gotenberg-client/pull/40))
+- Integrated Codecov test analytics ([#44](https://github.com/stumpylog/gotenberg-client/pull/44))
+
+### Changed
+
+- Use `pytest-docker` to manage Docker image services ([#36](https://github.com/stumpylog/gotenberg-client/pull/36))
+- Bump Bump pypa/gh-action-pypi-publish from 1.10.2 to 1.12.2 by @dependabot ([#41](https://github.com/stumpylog/gotenberg-client/pull/41))
+- Bump codecov/codecov-action from 4 to 5 by @dependabot ([#41](https://github.com/stumpylog/gotenberg-client/pull/41))
+
 ## [0.7.0] - 2024-10-08
 
 ### Fixed

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: gotenberg-client
-Version: 0.7.0
+Version: 0.8.2
 Summary: A Python client for interfacing with the Gotenberg API
 Project-URL: Changelog, https://github.com/stumpylog/gotenberg-client/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://stumpylog.github.io/gotenberg-client/
@@ -17,16 +17,15 @@ Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 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 :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.8
-Requires-Dist: httpx[http2]~=0.24; python_version < '3.9'
-Requires-Dist: httpx[http2]~=0.27; python_version >= '3.9'
+Requires-Python: >=3.9
+Requires-Dist: httpx[http2]>=0.27
 Requires-Dist: typing-extensions; python_version < '3.11'
 Provides-Extra: magic
 Requires-Dist: python-magic; extra == 'magic'
@@ -136,6 +135,35 @@ with GotenbergClient("http://localhost:3000") as client:
       response.to_file(Path("my-world.pdf"))
 ```
 
+Adding metadata to a PDF:
+
+This example shows how to add metadata to your generated PDF. All metadata fields are optional and include:
+
+- Document info (title, author, subject, keywords)
+- Dates (creation, modification)
+- Technical details (pdf version, creator, producer)
+- PDF standards (trapped status, marked status)
+
+```python
+from gotenberg_client import GotenbergClient
+from datetime import datetime
+
+with GotenbergClient("http://localhost:3000") as client:
+    with client.chromium.html_to_pdf() as route:
+        response = (route
+            .index("my-index.html")
+            .metadata(
+                title="My Document",
+                author="John Doe",
+                subject="Example PDF",
+                keywords=["sample", "document", "test"],
+                creation_date=datetime.now(),
+                trapped="Unknown"
+            )
+            .run())
+        response.to_file(Path("my-index.pdf"))
+```
+
 To ensure the proper clean up of all used resources, both the client and the route(s) should be
 used as context manager. If for some reason you cannot, you should `.close` the client and any
 routes:

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/README.md

@@ -102,6 +102,35 @@ with GotenbergClient("http://localhost:3000") as client:
       response.to_file(Path("my-world.pdf"))
 ```
 
+Adding metadata to a PDF:
+
+This example shows how to add metadata to your generated PDF. All metadata fields are optional and include:
+
+- Document info (title, author, subject, keywords)
+- Dates (creation, modification)
+- Technical details (pdf version, creator, producer)
+- PDF standards (trapped status, marked status)
+
+```python
+from gotenberg_client import GotenbergClient
+from datetime import datetime
+
+with GotenbergClient("http://localhost:3000") as client:
+    with client.chromium.html_to_pdf() as route:
+        response = (route
+            .index("my-index.html")
+            .metadata(
+                title="My Document",
+                author="John Doe",
+                subject="Example PDF",
+                keywords=["sample", "document", "test"],
+                creation_date=datetime.now(),
+                trapped="Unknown"
+            )
+            .run())
+        response.to_file(Path("my-index.pdf"))
+```
+
 To ensure the proper clean up of all used resources, both the client and the route(s) should be
 used as context manager. If for some reason you cannot, you should `.close` the client and any
 routes:

gotenberg_client-0.8.2/docs/roadmap.md

@@ -0,0 +1,3 @@
+# Roadmap
+
+While I'm sure there's something out there, nothing is currently on the roadmap.

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/docs/routes.md

@@ -95,11 +95,45 @@ These options are not yet implemented
 | `pdfa`           | `.pdf_format()`                                                               | `PdfAFormat` |       |
 | `pdfua`          | <ul><li>`enable_universal_access()`<li>`disable_universal_access()`</li></ul> | N/A          |       |
 
-#### Metadata
+#### PDF Metadata Support
 
 [Gotenberg Documentation](https://gotenberg.dev/docs/routes#metadata-chromium)
 
-These options are not yet implemented
+Add metadata to your PDFs:
+
+```python
+from gotenberg_client import GotenbergClient
+from datetime import datetime
+
+with GotenbergClient("http://localhost:3000") as client:
+    with client.chromium.html_to_pdf() as route:
+        response = (route
+            .index("my-index.html")
+            .metadata(
+                title="My Document",
+                author="John Doe",
+                creation_date=datetime.now(),
+                keywords=["sample", "document"],
+                subject="Sample PDF Generation",
+                trapped="Unknown"
+            )
+            .run())
+```
+
+Supported metadata fields:
+
+- `title`: Document title
+- `author`: Document author
+- `subject`: Document subject
+- `keywords`: List of keywords
+- `creator`: Creating application
+- `creation_date`: Creation datetime
+- `modification_date`: Last modification datetime
+- `producer`: PDF producer
+- `trapped`: Trapping status ('True', 'False', 'Unknown')
+- `copyright`: Copyright information
+- `marked`: PDF marked status
+- `pdf_version`: PDF version number
 
 ## LibreOffice
 

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/pyproject.toml

@@ -16,7 +16,7 @@ license = "MPL-2.0"
 authors = [
   { name = "Trenton H", email = "rda0128ou@mozmail.com" },
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 classifiers = [
   "Development Status :: 4 - Beta",
   "Environment :: Web Environment",
@@ -25,18 +25,17 @@ classifiers = [
   "Operating System :: OS Independent",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dynamic = [ "version" ]
 dependencies = [
-  "httpx[http2]~=0.24; python_version<'3.9'",
-  "httpx[http2]~=0.27; python_version>='3.9'",
+  "httpx[http2]>=0.27",
   "typing-extensions; python_version<'3.11'",
 ]
 
@@ -64,7 +63,7 @@ installer = "uv"
 
 [tool.hatch.envs.hatch-static-analysis]
 # https://hatch.pypa.io/latest/config/internal/static-analysis/
-dependencies = [ "ruff ~= 0.6" ]
+dependencies = [ "ruff ~= 0.8" ]
 config-path = "none"
 
 [tool.hatch.envs.hatch-test]
@@ -74,19 +73,18 @@ randomize = true
 dependencies = [
   "coverage-enable-subprocess == 1.0",
   "coverage[toml] ~= 7.6",
-  "pytest < 8.0; python_version < '3.9'",
   "pytest ~= 8.3; python_version >= '3.9'",
   "pytest-mock ~= 3.14",
   "pytest-randomly ~= 3.15",
-  "pytest-rerunfailures ~= 14.0",
+  "pytest-rerunfailures ~= 15.0",
   "pytest-xdist[psutil] ~= 3.6",
 ]
 extra-dependencies = [
   "pytest-sugar",
-  "pytest-httpx == 0.30.0; python_version >= '3.9'",
-  "pytest-httpx ~= 0.22; python_version < '3.9'",
+  "pytest-httpx ~= 0.35",
   "pikepdf",
   "python-magic",
+  "pytest-docker ~= 3.1",
 ]
 extra-args = [ "--maxprocesses=8", "--pythonwarnings=all" ]
 
@@ -109,7 +107,7 @@ cov-report = [
 ]
 
 [[tool.hatch.envs.hatch-test.matrix]]
-python = [ "3.8", "3.9", "3.10", "3.11", "3.12", "pypy3.9", "pypy3.10" ]
+python = [ "3.9", "3.10", "3.11", "3.12", "3.13", "pypy3.9", "pypy3.10" ]
 
 #
 # Custom Environments
@@ -117,11 +115,11 @@ python = [ "3.8", "3.9", "3.10", "3.11", "3.12", "pypy3.9", "pypy3.10" ]
 [tool.hatch.envs.typing]
 detached = true
 dependencies = [
-  "mypy ~= 1.11",
+  "mypy ~= 1.13",
   "httpx",
   "pytest",
   "pikepdf",
-  "pytest-httpx == 0.30.0",
+  "pytest-httpx ~= 0.35",
 ]
 
 [tool.hatch.envs.typing.scripts]
@@ -168,7 +166,7 @@ deploy = [
 #
 
 [tool.ruff]
-target-version = "py38"
+target-version = "py39"
 line-length = 120
 
 # https://docs.astral.sh/ruff/settings/
@@ -244,6 +242,7 @@ lint.ignore = [
 ]
 # Tests can use magic values, assertions, and relative imports
 lint.per-file-ignores."tests/**/*" = [ "PLR2004", "S101", "TID252" ]
+lint.per-file-ignores."tests/utils.py" = [ "S603" ]
 # No relative imports
 lint.flake8-tidy-imports.ban-relative-imports = "all"
 # One import per line
@@ -251,6 +250,9 @@ lint.isort.force-single-line = true
 # Recognize us please
 lint.isort.known-first-party = [ "gotenberg_client" ]
 
+[tool.pyproject-fmt]
+max_supported_python = "3.13"
+
 [tool.pytest.ini_options]
 minversion = "7.0"
 testpaths = [ "tests" ]

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/src/gotenberg_client/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2023-present Trenton H <rda0128ou@mozmail.com>
 #
 # SPDX-License-Identifier: MPL-2.0
-__version__ = "0.7.0"
+__version__ = "0.8.2"

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/src/gotenberg_client/__init__.py

@@ -4,15 +4,19 @@
 from gotenberg_client._client import GotenbergClient
 from gotenberg_client._errors import BaseClientError
 from gotenberg_client._errors import CannotExtractHereError
+from gotenberg_client._errors import InvalidKeywordError
+from gotenberg_client._errors import InvalidPdfRevisionError
 from gotenberg_client._errors import MaxRetriesExceededError
 from gotenberg_client.responses import SingleFileResponse
 from gotenberg_client.responses import ZipFileResponse
 
 __all__ = [
-    "GotenbergClient",
-    "SingleFileResponse",
-    "ZipFileResponse",
     "BaseClientError",
     "CannotExtractHereError",
+    "GotenbergClient",
+    "InvalidKeywordError",
+    "InvalidPdfRevisionError",
     "MaxRetriesExceededError",
+    "SingleFileResponse",
+    "ZipFileResponse",
 ]

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/src/gotenberg_client/_base.py

@@ -6,10 +6,7 @@ from contextlib import ExitStack
 from pathlib import Path
 from time import sleep
 from types import TracebackType
-from typing import Dict
 from typing import Optional
-from typing import Tuple
-from typing import Type
 
 from httpx import Client
 from httpx import HTTPStatusError
@@ -71,13 +68,13 @@ class _BaseRoute(PdfFormatMixin, PfdUniversalAccessMixin):
         self._route = api_route
         self._stack = ExitStack()
         # These are the options that will be set to Gotenberg.  Things like PDF/A
-        self._form_data: Dict[str, str] = {}
+        self._form_data: dict[str, str] = {}
         # These are the names of files, mapping to their Path
-        self._file_map: Dict[str, Path] = {}
+        self._file_map: dict[str, Path] = {}
         # Additional in memory resources, mapping the referenced name to the content and an optional mimetype
-        self._in_memory_resources: Dict[str, Tuple[str, Optional[str]]] = {}
+        self._in_memory_resources: dict[str, tuple[str, Optional[str]]] = {}
         # Any header that will also be sent
-        self._headers: Dict[str, str] = {}
+        self._headers: dict[str, str] = {}
 
     def __enter__(self) -> Self:
         self.reset()
@@ -85,7 +82,7 @@ class _BaseRoute(PdfFormatMixin, PfdUniversalAccessMixin):
 
     def __exit__(
         self,
-        exc_type: Optional[Type[BaseException]],
+        exc_type: Optional[type[BaseException]],
         exc_val: Optional[BaseException],
         exc_tb: Optional[TracebackType],
     ) -> None:
@@ -111,6 +108,7 @@ class _BaseRoute(PdfFormatMixin, PfdUniversalAccessMixin):
         Executes the configured route against the server and returns the resulting
         Response.
         """
+
         resp = self._client.post(
             url=self._route,
             headers=self._headers,

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/src/gotenberg_client/_client.py

@@ -3,9 +3,7 @@
 # SPDX-License-Identifier: MPL-2.0
 import logging
 from types import TracebackType
-from typing import Dict
 from typing import Optional
-from typing import Type
 
 from httpx import Client
 
@@ -65,7 +63,7 @@ class GotenbergClient:
         self.merge = MergeApi(self._client)
         self.health = HealthCheckApi(self._client)
 
-    def add_headers(self, header: Dict[str, str]) -> None:
+    def add_headers(self, header: dict[str, str]) -> None:
         """
         Update the httpx Client headers with the given values.
 
@@ -110,7 +108,7 @@ class GotenbergClient:
         """
         self.add_headers({"Gotenberg-Webhook-Error-Method": method})
 
-    def set_webhook_extra_headers(self, extra_headers: Dict[str, str]) -> None:
+    def set_webhook_extra_headers(self, extra_headers: dict[str, str]) -> None:
         """
         Set additional HTTP headers for Gotenberg to use when calling webhooks.
 
@@ -138,7 +136,7 @@ class GotenbergClient:
 
     def __exit__(
         self,
-        exc_type: Optional[Type[BaseException]],
+        exc_type: Optional[type[BaseException]],
         exc_val: Optional[BaseException],
         exc_tb: Optional[TracebackType],
     ) -> None:

{gotenberg_client-0.7.0 → gotenberg_client-0.8.2}/src/gotenberg_client/_convert/chromium.py

@@ -3,10 +3,8 @@
 # SPDX-License-Identifier: MPL-2.0
 import logging
 from pathlib import Path
-from typing import List
 from typing import Literal
 from typing import Optional
-from typing import Tuple
 
 from httpx import Client
 
@@ -17,6 +15,7 @@ from gotenberg_client._convert.common import CustomHTTPHeaderMixin
 from gotenberg_client._convert.common import EmulatedMediaMixin
 from gotenberg_client._convert.common import HeaderFooterMixin
 from gotenberg_client._convert.common import InvalidStatusCodesMixin
+from gotenberg_client._convert.common import MetadataMixin
 from gotenberg_client._convert.common import PageOrientMixin
 from gotenberg_client._convert.common import PagePropertiesMixin
 from gotenberg_client._convert.common import PerformanceModeMixin
@@ -82,7 +81,7 @@ class _RouteWithResources(BaseSingleFileResponseRoute):
         self._add_in_memory_file(resource, name=name, mime_type=mime_type)
         return self
 
-    def resources(self, resources: List[Path]) -> Self:
+    def resources(self, resources: list[Path]) -> Self:
         """
         Adds multiple resource files for the index HTML file to reference.
 
@@ -94,7 +93,7 @@ class _RouteWithResources(BaseSingleFileResponseRoute):
 
     def string_resources(
         self,
-        resources: List[Tuple[str, str, Optional[str]]],
+        resources: list[tuple[str, str, Optional[str]]],
     ) -> Self:
         """
         Process string resources.
@@ -125,6 +124,7 @@ class HtmlRoute(
     HeaderFooterMixin,
     RenderControlMixin,
     PageOrientMixin,
+    MetadataMixin,
     _RouteWithResources,
     _FileBasedRoute,
 ):
@@ -141,6 +141,7 @@ class UrlRoute(
     EmulatedMediaMixin,
     CustomHTTPHeaderMixin,
     PageOrientMixin,
+    MetadataMixin,
     BaseSingleFileResponseRoute,
 ):
     """
@@ -183,7 +184,7 @@ class UrlRoute(
         return FORCE_MULTIPART
 
 
-class MarkdownRoute(PagePropertiesMixin, HeaderFooterMixin, _RouteWithResources, _FileBasedRoute):
+class MarkdownRoute(PagePropertiesMixin, HeaderFooterMixin, MetadataMixin, _RouteWithResources, _FileBasedRoute):
     """
     Represents the Gotenberg route for converting Markdown files to a PDF.
 
@@ -212,7 +213,7 @@ class MarkdownRoute(PagePropertiesMixin, HeaderFooterMixin, _RouteWithResources,
 
         return self
 
-    def markdown_files(self, markdown_files: List[Path]) -> Self:
+    def markdown_files(self, markdown_files: list[Path]) -> Self:
         """
         Adds multiple Markdown files to be converted.