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

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.14.0

0.13.0

0.12.0

0.11.0

0.10.0

0.9.0

This version

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.8.0.tar.gz (493.7 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.8.0-cp39-abi3-win_amd64.whl (7.0 MB view details)

Uploaded CPython 3.9+Windows x86-64

pyfulgur-0.8.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (7.2 MB view details)

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

pyfulgur-0.8.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (6.8 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ ARM64

pyfulgur-0.8.0-cp39-abi3-macosx_11_0_arm64.whl (6.5 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

pyfulgur-0.8.0-cp39-abi3-macosx_10_12_x86_64.whl (6.8 MB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for pyfulgur-0.8.0.tar.gz
Algorithm Hash digest
SHA256 c1c81324f7dd3806b1f27bc890124b26c8c309ce86d515f0a8d6e881dc058e7d
MD5 5aad766df4484257d3f1f89fcfcc58e8
BLAKE2b-256 a3d3a9cda927e6967f1ba825b44057346985b0b04b9f349415138273e33a923c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.8.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.8.0-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: pyfulgur-0.8.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 7.0 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.8.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 0f278e244ae2f085897f59db14b33b09569a12c9b6564608d3a6067ae60d132b
MD5 f543a7d2a824b84fd822249ad9fbb2b8
BLAKE2b-256 b8920e1c23e9f335bff4ed351a3aca6300629bfc6beb157d7f947eec5434232a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.8.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.8.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.8.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 834c4774470fdf5cb162d38d91ab9fbd253d686d9ccab54dd64fbcf44d14a256
MD5 ec3563f7b495fcf2bec9fabcd0878cdb
BLAKE2b-256 58a8999fc97f7ff4ba752eaa288f9e800ea81656c7a8a50822d30e48866c100e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.8.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.8.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.8.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 9779c19100388c53d42d92f2bbb39ff97ff2c21e8590a08bf04bfbdaccc4dd00
MD5 32c35873094e73b4607ca527a5c1d855
BLAKE2b-256 17cae7150da2f63e1f3f1138f4a57e698a4d4740f2ac547bfe4719b71b0a32f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.8.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.8.0-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.8.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4757e4c70e4d15a5ce54699d771fe1c548253728b444bc85d3133aaf233ebd78
MD5 69e28997646bbbfdbb5fd566529574e1
BLAKE2b-256 3be74d3bd8b3c6f08cdfcf71392adf7c9eb89f616ed160dae4e7c63587c608d7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.8.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.8.0-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for pyfulgur-0.8.0-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d682778706d2b008f38f31558ace45fb1d44de993ab1e557c06997e66240536e
MD5 0299edbe992af24bf4b5c0785dcc5551
BLAKE2b-256 55e39c4f5d7987fa964a8c11a698befa5b39d373a698409820e65ca28cd0692f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyfulgur-0.8.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