PyPI - gowkhtmltopdf - Versions diffs - 0.2.5__tar.gz - Mend

gowkhtmltopdf 0.2.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

gowkhtmltopdf-0.2.5/MANIFEST.in +7 -0
gowkhtmltopdf-0.2.5/PKG-INFO +69 -0
gowkhtmltopdf-0.2.5/README.md +42 -0
gowkhtmltopdf-0.2.5/examples/invoice.py +58 -0
gowkhtmltopdf-0.2.5/pyproject.toml +95 -0
gowkhtmltopdf-0.2.5/setup.cfg +4 -0
gowkhtmltopdf-0.2.5/setup.py +61 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf/__init__.py +134 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf/_lib.py +338 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf/api.py +114 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf/document.py +584 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf/exceptions.py +156 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf/py.typed +1 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf.egg-info/PKG-INFO +69 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf.egg-info/SOURCES.txt +20 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf.egg-info/dependency_links.txt +1 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf.egg-info/not-zip-safe +1 -0
gowkhtmltopdf-0.2.5/src/gowkhtmltopdf.egg-info/top_level.txt +1 -0
gowkhtmltopdf-0.2.5/tests/__init__.py +14 -0
gowkhtmltopdf-0.2.5/tests/bench_library.py +258 -0
gowkhtmltopdf-0.2.5/tests/test_binding.py +131 -0
gowkhtmltopdf-0.2.5/tests/test_model.py +286 -0

gowkhtmltopdf-0.2.5/MANIFEST.in ADDED Viewed

@@ -0,0 +1,7 @@
+include README.md
+include src/gowkhtmltopdf/py.typed
+recursive-include tests *.py
+recursive-include examples *.py
+prune docs
+prune frontend
+prune testdata

gowkhtmltopdf-0.2.5/PKG-INFO ADDED Viewed

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: gowkhtmltopdf
+Version: 0.2.5
+Summary: In-process Python bindings for the gowkhtmltopdf HTML-to-PDF engine via a ctypes-loaded c-shared library
+Author: Chinmay Sawant
+License: MIT
+Project-URL: Homepage, https://github.com/chinmay-sawant/gowkhtmltopdf
+Project-URL: Issues, https://github.com/chinmay-sawant/gowkhtmltopdf/issues
+Keywords: html,pdf,wkhtmltopdf,ctypes,invoice
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Text Processing :: Markup :: HTML
+Classifier: Topic :: Printing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+# gowkhtmltopdf (Python)
+In-process Python bindings for the gowkhtmltopdf HTML-to-PDF engine. The
+package loads `libgowkhtmltopdf` (a Go `-buildmode=c-shared` library) with
+stdlib `ctypes`; there is no subprocess and no compiled Python extension.
+Requires Python 3.8+. Linux is the first-supported platform; macOS and
+Windows builds follow the wheel matrix.
+## Document style
+Mirrors the Go `Document` API:
+```python
+from gowkhtmltopdf import Document, Page, Content
+doc = Document(
+    pages=[Page(source=Content(html=b"<html><body><h1>Invoice</h1></body></html>"))],
+    page_size="A4",
+)
+pdf_bytes: bytes = doc.pdf()  # or doc.pdf(timeout=30)
+```
+## Helper style
+```python
+from gowkhtmltopdf import convert_html_to_pdf, PDFOptions
+pdf_bytes = convert_html_to_pdf(
+    html=b"<html><body><h1>Invoice #42</h1><p>Total: $19.00</p></body></html>",
+    options=PDFOptions(page_size="A4", orientation="portrait"),
+)
+with open("invoice.pdf", "wb") as f:
+    f.write(pdf_bytes)
+```
+Images work the same way via `ImageDocument` or
+`convert_html_to_image(html, options=ImageOptions(width=1024))`.
+The full build, install, security (ACL / NetworkPolicy), and ABI
+stability guide lives in [documentation/python.md](../../documentation/python.md).

gowkhtmltopdf-0.2.5/README.md ADDED Viewed

@@ -0,0 +1,42 @@
+# gowkhtmltopdf (Python)
+In-process Python bindings for the gowkhtmltopdf HTML-to-PDF engine. The
+package loads `libgowkhtmltopdf` (a Go `-buildmode=c-shared` library) with
+stdlib `ctypes`; there is no subprocess and no compiled Python extension.
+Requires Python 3.8+. Linux is the first-supported platform; macOS and
+Windows builds follow the wheel matrix.
+## Document style
+Mirrors the Go `Document` API:
+```python
+from gowkhtmltopdf import Document, Page, Content
+doc = Document(
+    pages=[Page(source=Content(html=b"<html><body><h1>Invoice</h1></body></html>"))],
+    page_size="A4",
+)
+pdf_bytes: bytes = doc.pdf()  # or doc.pdf(timeout=30)
+```
+## Helper style
+```python
+from gowkhtmltopdf import convert_html_to_pdf, PDFOptions
+pdf_bytes = convert_html_to_pdf(
+    html=b"<html><body><h1>Invoice #42</h1><p>Total: $19.00</p></body></html>",
+    options=PDFOptions(page_size="A4", orientation="portrait"),
+)
+with open("invoice.pdf", "wb") as f:
+    f.write(pdf_bytes)
+```
+Images work the same way via `ImageDocument` or
+`convert_html_to_image(html, options=ImageOptions(width=1024))`.
+The full build, install, security (ACL / NetworkPolicy), and ABI
+stability guide lives in [documentation/python.md](../../documentation/python.md).

gowkhtmltopdf-0.2.5/examples/invoice.py ADDED Viewed

@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+"""Runnable example: both snippet styles produce an invoice PDF.
+Run from anywhere with a built library on the search path:
+    cd bindings/python && python examples/invoice.py
+Writes invoice.pdf (Document style) and invoice_high_level.pdf
+(convert_html_to_pdf style) into the current directory.
+"""
+import os
+import sys
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "src"))
+from gowkhtmltopdf import (  # noqa: E402
+    Content,
+    Document,
+    PDFOptions,
+    Page,
+    convert_html_to_pdf,
+)
+HTML = (
+    b"<html><body>"
+    b"<h1>Invoice</h1>"
+    b"<p>Invoice #42</p>"
+    b"<p>Total: $19.00</p>"
+    b"</body></html>"
+)
+def main():
+    doc = Document(
+        pages=[Page(source=Content(html=HTML))],
+        page_size="A4",
+    )
+    document_bytes = doc.pdf()
+    assert document_bytes.startswith(b"%PDF-"), "missing %PDF- header"
+    high_level_bytes = convert_html_to_pdf(
+        html=HTML,
+        options=PDFOptions(page_size="A4", orientation="portrait"),
+    )
+    assert high_level_bytes.startswith(b"%PDF-"), "missing %PDF- header"
+    with open("invoice.pdf", "wb") as sink:
+        sink.write(document_bytes)
+    with open("invoice_high_level.pdf", "wb") as sink:
+        sink.write(high_level_bytes)
+    print("invoice.pdf: {0} bytes".format(len(document_bytes)))
+    print("invoice_high_level.pdf: {0} bytes".format(len(high_level_bytes)))
+if __name__ == "__main__":
+    main()

gowkhtmltopdf-0.2.5/pyproject.toml ADDED Viewed

@@ -0,0 +1,95 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+[project]
+name = "gowkhtmltopdf"
+version = "0.2.5"
+description = "In-process Python bindings for the gowkhtmltopdf HTML-to-PDF engine via a ctypes-loaded c-shared library"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [{ name = "Chinmay Sawant" }]
+keywords = ["html", "pdf", "wkhtmltopdf", "ctypes", "invoice"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3",
+    "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",
+    "Topic :: Text Processing :: Markup :: HTML",
+    "Topic :: Printing",
+]
+[project.urls]
+Homepage = "https://github.com/chinmay-sawant/gowkhtmltopdf"
+Issues = "https://github.com/chinmay-sawant/gowkhtmltopdf/issues"
+[tool.setuptools]
+package-dir = { "" = "src" }
+zip-safe = false
+[tool.setuptools.packages.find]
+where = ["src"]
+[tool.setuptools.package-data]
+gowkhtmltopdf = ["libgowkhtmltopdf.*", "py.typed"]
+# cibuildwheel (Phase 43). Archs are per-platform: never set a global archs
+# list (macOS rejects Linux's aarch64 name). Linux builds the c-shared library
+# inside the manylinux container via before-build; macOS/Windows override
+# CIBW_BEFORE_BUILD in publish-pypi.yml to scripts/build_cshared_for_wheel.sh.
+[tool.cibuildwheel]
+# Wheels are tagged py3-none-<plat> (ctypes-loaded native lib, not a CPython
+# extension), so one CPython build per platform is enough for requires-python
+# >=3.8. Building cp38..cp313 would only overwrite the same tag repeatedly.
+build = "cp311-*"
+[tool.cibuildwheel.linux]
+# Per-job CIBW_ARCHS_LINUX in the workflow selects x86_64 or aarch64.
+manylinux-x86_64-image = "manylinux_2_28"
+manylinux-aarch64-image = "manylinux_2_28"
+repair-wheel-command = "auditwheel repair --strip -w {dest_dir} {wheel}"
+# {project} is the repo root (cwd where cibuildwheel was invoked). Relative
+# ../.. from the package cwd is wrong and can resolve to /.
+before-build = '''
+set -eux
+ARCH="$(uname -m)"
+case "$ARCH" in
+  x86_64|amd64) GOPLAT=amd64 ;;
+  aarch64|arm64) GOPLAT=arm64 ;;
+  *) echo "unsupported architecture: $ARCH" >&2; exit 1 ;;
+esac
+curl -fsSL "https://go.dev/dl/go1.26.0.linux-${GOPLAT}.tar.gz" -o /tmp/gowk-go.tar.gz
+rm -rf /usr/local/go
+tar -C /usr/local -xzf /tmp/gowk-go.tar.gz
+export PATH="/usr/local/go/bin:$PATH"
+ROOT="{project}"
+test -f "$ROOT/VERSION"
+test -f "$ROOT/go.mod"
+test -d "$ROOT/bindings/c"
+OUT="$ROOT/bindings/python/src/gowkhtmltopdf/libgowkhtmltopdf.so"
+mkdir -p "$(dirname "$OUT")"
+(
+  cd "$ROOT" && CGO_ENABLED=1 go build -buildmode=c-shared \
+    -ldflags "-X main.libVersion=$(cat VERSION) -s -w" \
+    -o "$OUT" ./bindings/c
+)
+test -f "$OUT"
+'''
+[tool.cibuildwheel.macos]
+# Native arch on macos-latest (Apple Silicon). Workflow sets
+# CIBW_BEFORE_BUILD=bash scripts/build_cshared_for_wheel.sh.
+archs = "arm64"
+[tool.cibuildwheel.windows]
+# Workflow sets CIBW_BEFORE_BUILD for the host Go + mingw build.

gowkhtmltopdf-0.2.5/setup.cfg ADDED Viewed

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build =
+tag_date = 0

gowkhtmltopdf-0.2.5/setup.py ADDED Viewed

@@ -0,0 +1,61 @@
+"""Build shim: VERSION stamp + platform/platlib wheel tags.
+pyproject.toml carries a static version so the package builds standalone.
+When the repo-root VERSION file exists (normal in-tree and sdist-from-repo
+builds), setup.py overrides that static value so the wheel or sdist always
+matches the release stamp in VERSION.
+The package ships a prebuilt c-shared library as package data and loads it
+with ctypes. That is not a Python C extension, so setuptools would:
+  1. emit py3-none-any (cibuildwheel rejects pure-Python wheels)
+  2. put .so/.dylib/.dll under purelib (auditwheel rejects that)
+Force a platform tag (py3-none-<plat>) and a BinaryDistribution so the
+native library lands in platlib and auditwheel can repair the wheel.
+"""
+from pathlib import Path
+from setuptools import setup
+from setuptools.dist import Distribution
+try:
+    from wheel.bdist_wheel import bdist_wheel as _bdist_wheel
+except ImportError:  # pragma: no cover - wheel is listed in build-system.requires
+    _bdist_wheel = None
+class BinaryDistribution(Distribution):
+    """Tell setuptools this package is platform-specific.
+    Without this, package-data shared libraries install into purelib and
+    auditwheel fails with "shared library in purelib folder".
+    """
+    def has_ext_modules(self):
+        return True
+class bdist_wheel(_bdist_wheel):  # type: ignore[misc,valid-type]
+    def finalize_options(self):
+        super().finalize_options()
+        self.root_is_pure = False
+    def get_tag(self):
+        _python, _abi, plat = super().get_tag()
+        # ctypes-loaded native lib: one wheel per OS/arch, any CPython 3.x.
+        return "py3", "none", plat
+_ROOT_VERSION = Path(__file__).resolve().parent.parent.parent / "VERSION"
+_kwargs = {
+    "distclass": BinaryDistribution,
+}
+if _bdist_wheel is not None:
+    _kwargs["cmdclass"] = {"bdist_wheel": bdist_wheel}
+if _ROOT_VERSION.is_file():
+    _kwargs["version"] = _ROOT_VERSION.read_text(encoding="utf-8").strip()
+setup(**_kwargs)

gowkhtmltopdf-0.2.5/src/gowkhtmltopdf/__init__.py ADDED Viewed

@@ -0,0 +1,134 @@
+"""gowkhtmltopdf: in-process Python bindings for the gowkhtmltopdf engine.
+Two usage styles, both backed by a ctypes-loaded c-shared library:
+    from gowkhtmltopdf import Document, Page, Content
+    doc = Document(
+        pages=[Page(source=Content(html=b"<html><body><h1>Invoice</h1></body></html>"))],
+        page_size="A4",
+    )
+    pdf_bytes = doc.pdf()
+Or the flat helper:
+    from gowkhtmltopdf import convert_html_to_pdf, PDFOptions
+    pdf_bytes = convert_html_to_pdf(
+        b"<html><body><h1>Invoice #42</h1></body></html>",
+        options=PDFOptions(page_size="A4"),
+    )
+The shared library is located and loaded only when a conversion runs;
+building model objects never touches it.
+"""
+from .exceptions import (
+    ConversionError,
+    ConversionTimeoutError,
+    ErrEmptyContent,
+    ErrInvalidContent,
+    ErrInvalidOrientation,
+    ErrInvalidPDFProfile,
+    ErrInvalidPageSize,
+    ErrInvalidPDFVersion,
+    ErrMissingOutput,
+    ErrNoPageObjects,
+    GowkhtmltopdfError,
+    InternalEngineError,
+    InvalidArgumentError,
+    LoadDeniedError,
+    RenderError,
+    ResourceLimitError,
+    error_from_status,
+    sniff_sentinel,
+)
+from .document import (
+    Content,
+    Crop,
+    Document,
+    HeaderFooter,
+    ImageDocument,
+    ImageOptions,
+    Margin,
+    NetworkPolicy,
+    Page,
+    PDFOptions,
+    TOC,
+    compatible_network_policy,
+    restricted_network_policy,
+)
+from .api import (
+    convert_file_to_pdf,
+    convert_html_to_image,
+    convert_html_to_pdf,
+    convert_url_to_pdf,
+)
+__version__ = "0.2.5"
+#: Upstream settings-surface identifier (api.go LibraryVersion), distinct
+#: from the project release in __version__.
+library_version = "0.12.7-dev"
+def abi_version():
+    # type: () -> int
+    """Return the ABI revision of the loaded shared library (always 1 today).
+    Raises ImportError when the library is missing or built for another ABI.
+    """
+    from ._lib import abi_version as _abi_version
+    return _abi_version()
+def library_version_string():
+    # type: () -> str
+    """Return the runtime version string reported by the shared library."""
+    from ._lib import library_version_string as _lvs
+    return _lvs()
+__all__ = [
+    "GowkhtmltopdfError",
+    "ConversionError",
+    "InvalidArgumentError",
+    "LoadDeniedError",
+    "RenderError",
+    "ConversionTimeoutError",
+    "ResourceLimitError",
+    "InternalEngineError",
+    "ErrEmptyContent",
+    "ErrInvalidContent",
+    "ErrNoPageObjects",
+    "ErrInvalidPageSize",
+    "ErrInvalidOrientation",
+    "ErrInvalidPDFVersion",
+    "ErrInvalidPDFProfile",
+    "ErrMissingOutput",
+    "error_from_status",
+    "sniff_sentinel",
+    "Content",
+    "Page",
+    "Margin",
+    "HeaderFooter",
+    "TOC",
+    "Crop",
+    "NetworkPolicy",
+    "compatible_network_policy",
+    "restricted_network_policy",
+    "PDFOptions",
+    "ImageOptions",
+    "Document",
+    "ImageDocument",
+    "convert_html_to_pdf",
+    "convert_file_to_pdf",
+    "convert_url_to_pdf",
+    "convert_html_to_image",
+    "__version__",
+    "library_version",
+    "abi_version",
+    "library_version_string",
+]