Skip to main content

SVG Jinja templates + YAML config = PDF documents

Project description

pdfbaker

Create PDF documents from YAML-configured SVG templates.

Quickstart

Installation

pdfbaker is available on PyPI and can be installed using pipx:

pipx install pdfbaker

If you don't have pipx yet, install it first:

sudo apt install pipx
pipx ensurepath

Optional Dependencies

  • For SVG to PDF conversion, CairoSVG is used by default. If you need Inkscape instead, install it:

    sudo apt install inkscape
    
  • For PDF compression, install Ghostscript:

    sudo apt install ghostscript
    
  • If you want to embed particular fonts, they need to be installed. For example for Roboto fonts:

    sudo apt install fonts-roboto
    

Basic Usage

  1. Create your document design in an SVG editor
  2. Replace text with variables using Jinja2 (e.g., {{ title }})
  3. Configure your content in YAML
  4. Generate PDFs with:
pdfbaker bake <config_file>

This will produce your PDF files in a dist/ directory where your configuration file lives. It will also create a build/ directory with intermediate files, which is only kept if you specify --debug.

Examples

For working examples, see the examples directory.
Create all PDFs with:

pdfbaker bake examples/examples.yml

Documentation

( on GitHub )

Development

This project uses uv for dependency management. The uv.lock file ensures reproducible builds.

Create and activate the virtual environment:

uv venv
source .venv/bin/activate

Install development dependencies:

uv sync --dev

Tests

Run tests:

pytest

View test coverage:

pytest --cov=pdfbaker --cov-report=term-missing

Pre-commit hook

If you want to commit changes, install pre-commit and run

pre-commit install

This ensures the same checks run locally as in GitHub CI.

Project details


Download files

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

Source Distribution

pdfbaker-0.4.1.tar.gz (70.5 kB view details)

Uploaded Source

Built Distribution

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

pdfbaker-0.4.1-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file pdfbaker-0.4.1.tar.gz.

File metadata

  • Download URL: pdfbaker-0.4.1.tar.gz
  • Upload date:
  • Size: 70.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.13

File hashes

Hashes for pdfbaker-0.4.1.tar.gz
Algorithm Hash digest
SHA256 28ecd00218cbc63f93758ae18f2df558745abd9f221e8eb688fbbbd034c378ce
MD5 dcf01732289f939fe81d7a28a3a5b9e5
BLAKE2b-256 8185ce334128f07ae6f423ef8db1c65c6a74c96261eb253068ebcb5f4735d9b2

See more details on using hashes here.

File details

Details for the file pdfbaker-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: pdfbaker-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.13

File hashes

Hashes for pdfbaker-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6edc9469b7f821a4f9cbaf7015e66df1ca0b2ca59d579418a482cc2ade1a9a5b
MD5 628cd89caee67f3cabc569d0a8b4c01f
BLAKE2b-256 13aebeabc1b2f40e7d3581645c95d5351e70ef5de58f6820f56b4f89c2f8c5d2

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