Skip to main content

Python bindings for Quillmark - format-first Markdown rendering

Project description

Quillmark — Python bindings

Python bindings for Quillmark's format-first Markdown rendering engine.

Maintained by TTQ.

Installation

pip install quillmark

Quick Start

from quillmark import Quillmark, ParsedDocument, OutputFormat

engine = Quillmark()
quill = engine.quill_from_path("path/to/quill")

markdown = """---
QUILL: my_quill
title: Hello World
---

# Hello
"""

parsed = ParsedDocument.from_markdown(markdown)
result = quill.render(parsed, OutputFormat.PDF)
result.artifacts[0].save("output.pdf")

API Overview

Quillmark

engine = Quillmark()
engine.registered_backends()      # ['typst']
quill = engine.quill_from_path("path/to/quill")
workflow = engine.workflow(quill) # for dynamic assets/fonts

Quill

quill = engine.quill_from_path("path")
result = quill.render(markdown_or_parsed, OutputFormat.PDF)

Workflow

Use workflow when adding dynamic assets/fonts:

workflow = engine.workflow(quill)
workflow.add_asset("logo.png", logo_bytes)
workflow.add_font("Custom.ttf", font_bytes)
result = workflow.render(parsed, OutputFormat.PDF)

Development

uv venv
uv pip install -e ".[dev]"
uv run pytest

License

Apache-2.0

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

quillmark-0.58.0.tar.gz (3.6 MB view details)

Uploaded Source

Built Distributions

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

quillmark-0.58.0-cp310-abi3-win_amd64.whl (14.8 MB view details)

Uploaded CPython 3.10+Windows x86-64

quillmark-0.58.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.5 MB view details)

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

quillmark-0.58.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (15.1 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

quillmark-0.58.0-cp310-abi3-macosx_11_0_arm64.whl (13.9 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

File details

Details for the file quillmark-0.58.0.tar.gz.

File metadata

  • Download URL: quillmark-0.58.0.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.13.1

File hashes

Hashes for quillmark-0.58.0.tar.gz
Algorithm Hash digest
SHA256 fa804e2c81ed71f5edbc4c13bd08c4d879c81ec0779faf30d1889e6eb5cef40f
MD5 02a287a1dd283e15026bd50ab664cd9a
BLAKE2b-256 01bb1626db42130eee32b00045aa45531038f35f042cc97c96c826ee997406c5

See more details on using hashes here.

File details

Details for the file quillmark-0.58.0-cp310-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for quillmark-0.58.0-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 977753bdc3d4bb84ff072a0b7182037c3c973941b55997d9195bbcc57cf6293c
MD5 3177f14ec7a0ab15e1951880088c94eb
BLAKE2b-256 1ba0dd058f70f077a6e02dd64177a1393f2aa19ee96b907c93c0258dc2a83381

See more details on using hashes here.

File details

Details for the file quillmark-0.58.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for quillmark-0.58.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b1aca0c3b75e597ecf03481c8aa0e7b2b04a97a85bd4c0b15561fba21b45f807
MD5 2991f0b88e477dfe8ad29520df041464
BLAKE2b-256 bcca8a0caa6ec1b61db3f4861e5f5e2cfdf8d71ff81f77ea6a1c36f032447eac

See more details on using hashes here.

File details

Details for the file quillmark-0.58.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for quillmark-0.58.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 1db5a70bc4a2169d779d4b0921ad97778972361b7331dcbe0511486130b4aeb9
MD5 4030bc928ea8e1d5380893ca96abba30
BLAKE2b-256 f03719d7dc8268cb984f25a87b497e0009862e10d2b7fa9241f0fd7a1cfb057e

See more details on using hashes here.

File details

Details for the file quillmark-0.58.0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for quillmark-0.58.0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 dc7a5ef0c1fc412e4e21e464e9022fe8e8aa5e11e63ec5ac42096f08a4c991b6
MD5 74466bf8784456d1405f202d25e8b042
BLAKE2b-256 5077d735dbdd2e5bfd0de6436c38db86eaccfbb1f78994ac1fe13f78bc247a7a

See more details on using hashes here.

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