Python bindings for fulgur — offline HTML/CSS to PDF conversion

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mitsuru from gravatar.com mitsuru

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT OR Apache-2.0
  • Author: Mitsuru Hayasaka
  • Tags pdf , html , css , conversion , typesetting
  • Requires: Python >=3.9
  • Provides-Extra: test
Classifiers
Report project as malware

Project description

pyfulgur

Python bindings for fulgur — an offline, deterministic HTML/CSS to PDF conversion library written in Rust.

Status

Alpha (v0.0.2). Core Engine / AssetBundle / PageSize / Margin / render_html API is available. Batch rendering, sandboxing, and template engine wiring are planned for later releases.

Install

Note: v0.0.2 is an early alpha. Pre-built wheels are not yet published to PyPI; install from source for now.

# From a checkout of the fulgur repository
pip install maturin
maturin develop --release -m crates/pyfulgur/Cargo.toml

Pre-built wheels for manylinux / macOS / Windows will be published in a later release.

Quick start

from pyfulgur import AssetBundle, Engine, PageSize

bundle = AssetBundle()
bundle.add_css("body { font-family: sans-serif; }")

engine = Engine(page_size=PageSize.A4, assets=bundle)
pdf_bytes = engine.render_html("<h1>Hello, world!</h1>")

with open("output.pdf", "wb") as f:
    f.write(pdf_bytes)

Builder style:

engine = (
    Engine.builder()
    .page_size(PageSize.A4)
    .landscape(False)
    .title("My doc")
    .assets(bundle)
    .build()
)
engine.render_html_to_file("<h1>Hi</h1>", "out.pdf")

API surface

  • Engine(**kwargs) / Engine.builder() → EngineBuilder
  • Engine.render_html(html: str) -> bytes — render to PDF bytes (releases the GIL)
  • Engine.render_html_to_file(html: str, path: str | os.PathLike) -> None — render to a file
  • AssetBundle: add_css, add_css_file, add_font_file, add_image, add_image_file
  • PageSize: A4, LETTER, A3, custom(w_mm, h_mm), .landscape()
  • Margin: Margin(top, right, bottom, left), Margin.uniform(pt), Margin.symmetric(v, h), Margin.uniform_mm(mm)
  • Exceptions: FileNotFoundError, ValueError, pyfulgur.RenderError

Type stubs

pyfulgur ships PEP 561 type stubs (py.typed + __init__.pyi) so mypy, pyright, and IDEs can type-check call sites against the native API. Docstrings live in the Rust source and are exposed via __doc__ for help(), Jupyter ?, and griffe / mkdocstrings inspection.

Known limitation: blitz parse-error noise on stdout

The underlying blitz-dom parser writes non-fatal html5ever parse errors directly to the process's stdout via println!. These fire for browser-tolerated but technically invalid HTML — documents without a <!DOCTYPE>, missing <html>/<body> wrappers, or structural quirks that browsers silently auto-correct — and show up as ERROR: ... noise in Jupyter notebooks or any environment that captures stdout. The PDF bytes returned by render_html are not affected; only the caller's terminal is polluted.

pyfulgur intentionally does not redirect fd 1 from inside the binding: process-wide fd manipulation in a multi-threaded library context races with concurrent render_html calls from other threads (mixed suppress / non-suppress callers would silently lose stdout during a suppressed window). Correctness and parallelism take priority over cosmetic stdout cleanliness.

If you need clean stdout:

  • Redirect at the caller side with a Python contextlib.redirect_stdout for Python-level writes, or os.dup2 for fd-level writes. This keeps the fd manipulation scoped to your own call site where you can guarantee single-threaded use.
  • Run renders in a subprocess via multiprocessing (each worker has its own fd 1).
  • Use the fulgur CLI (which handles stdout isolation internally) invoked via subprocess.run when cold-start cost is acceptable.

A wrapper-style Python package that shells out to the fulgur CLI (clean stdout, parallel via process isolation, no native build required) is on the roadmap as a complement to this native binding.

Links

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mitsuru from gravatar.com mitsuru

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT OR Apache-2.0
  • Author: Mitsuru Hayasaka
  • Tags pdf , html , css , conversion , typesetting
  • Requires: Python >=3.9
  • Provides-Extra: test
Classifiers

Release history Release notifications | RSS feed

0.37.0

0.36.0

0.35.0

0.34.0

0.33.0

0.32.0

0.31.0

0.30.0

0.29.0

0.28.0

This version

0.27.0

0.26.0

0.25.0

0.24.0

0.23.0

0.22.0

0.21.0

0.20.0

0.19.0

0.18.0

0.17.0

0.16.0

0.15.0

0.14.0

0.13.0

0.12.0

0.11.0

0.10.0

0.9.0

0.8.0

0.7.0

0.5.11

0.5.8

0.5.6

0.5.5

0.5.2

0.5.1

0.5.0

0.0.1

Download files

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

Source Distribution

pyfulgur-0.27.0.tar.gz (912.4 kB view details)

Uploaded Source

Built Distributions

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

pyfulgur-0.27.0-cp39-abi3-win_amd64.whl (7.3 MB view details)

Uploaded CPython 3.9+Windows x86-64

pyfulgur-0.27.0-cp39-abi3-musllinux_1_2_x86_64.whl (7.7 MB view details)

Uploaded CPython 3.9+musllinux: musl 1.2+ x86-64

pyfulgur-0.27.0-cp39-abi3-musllinux_1_2_aarch64.whl (7.3 MB view details)

Uploaded CPython 3.9+musllinux: musl 1.2+ ARM64

pyfulgur-0.27.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (7.5 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

pyfulgur-0.27.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (7.1 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ ARM64

pyfulgur-0.27.0-cp39-abi3-macosx_11_0_arm64.whl (6.8 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

pyfulgur-0.27.0-cp39-abi3-macosx_10_12_x86_64.whl (7.1 MB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

File details

Details for the file pyfulgur-0.27.0.tar.gz.

File metadata

  • Download URL: pyfulgur-0.27.0.tar.gz
  • Upload date:
  • Size: 912.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pyfulgur-0.27.0.tar.gz
Algorithm Hash digest
SHA256 bbd002bc9460efb4f1b396372274933b85a6c47fc5e285aa36e9338bd9d695e2
MD5 09c9daa85fe9d84354202f5016e89128
BLAKE2b-256 cc7ef9bdfbcbb020ddc5f2244fd62741407d1fa53322dc6c53a5b19bf63f51a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.27.0.tar.gz:

Publisher: release-python.yml on fulgur-rs/fulgur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyfulgur-0.27.0-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: pyfulgur-0.27.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 7.3 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for pyfulgur-0.27.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 62c45e7652765584ba206b3f8e2cac0c53f1276cb88677a72b03d38a40d491cb
MD5 e4d6d7b142b8978f68d9166a2f2808e1
BLAKE2b-256 4b3188892ebc3b0a8d10aa79b497a612a8030745789bb43c6c76f12368c1ea4f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.27.0-cp39-abi3-win_amd64.whl:

Publisher: release-python.yml on fulgur-rs/fulgur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyfulgur-0.27.0-cp39-abi3-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.27.0-cp39-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 cc372601713b94435fcebee6855f07bd1f23a8305c2a9a670e77c6090298ab8e
MD5 861cafe31351eacc5b15742d2ed06fed
BLAKE2b-256 7a4c8dbce5b26268a601414ebb7d243ea7ab22167d347cdb29777a2494215586

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.27.0-cp39-abi3-musllinux_1_2_x86_64.whl:

Publisher: release-python.yml on fulgur-rs/fulgur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyfulgur-0.27.0-cp39-abi3-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.27.0-cp39-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 2299f06ce11671eac2776d14f9892174e69350c8ecbdde8c92eefb9d5639dfe5
MD5 77d86f71ec4926abc7638f2cf5b04854
BLAKE2b-256 d06cd4cc430512d9aedbd76626ce666a33bde042aa2a2043416ebbc2a0724de4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.27.0-cp39-abi3-musllinux_1_2_aarch64.whl:

Publisher: release-python.yml on fulgur-rs/fulgur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyfulgur-0.27.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.27.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 78e2c6b19052284af65dfd860ee5efe81004a11e2a20ae57a36e8a1af4263144
MD5 2e8013cf8df48f3bce0eb9a4d2b2ba0d
BLAKE2b-256 bbe77c42a54f29444309272a10585fbcd988a854dc20f508403a19c083c80e0b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.27.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release-python.yml on fulgur-rs/fulgur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyfulgur-0.27.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.27.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 5bf951b62fe1bf6351d5739b40dea5de309c065fdadfbd3e94c75716002f3c03
MD5 7edaa97cf90312a3508efeb2863ac497
BLAKE2b-256 e0162bbc5cc1bcc71c2d7f94b6600f701b849fd20d8bb3ad7c127ca2e2713541

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.27.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release-python.yml on fulgur-rs/fulgur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyfulgur-0.27.0-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.27.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e894437545241d6cd44e6ef35dba49f2e21fec4bff41862ed452b80de48c70db
MD5 11e362c6a6fe3d1f2a9a364236b31064
BLAKE2b-256 56e33b201e8b1e8e96609daeccf8816b1cc8dd40de1952b61de25d70e6adde62

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.27.0-cp39-abi3-macosx_11_0_arm64.whl:

Publisher: release-python.yml on fulgur-rs/fulgur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyfulgur-0.27.0-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.27.0-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d5aa62e01a06526e75b2318e31b9199ee941f0edca2b2015775176c0e9da1c33
MD5 0e6ad6064ec6c133c06818a3343d78fc
BLAKE2b-256 9bb34c729289fae803edc28d7eefe8ad8719802205dc4b1ce3ad91f33668a34c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.27.0-cp39-abi3-macosx_10_12_x86_64.whl:

Publisher: release-python.yml on fulgur-rs/fulgur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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