Skip to main content

PDF templating with Typst

Project description

Oicana

Dynamic PDF Generation based on Typst.

Oicana offers seamless PDF templating. Define your templates in Typst, specify dynamic inputs, and generate high quality PDFs from your application code.

Installation

uv add oicana

Quick Start

import json
from oicana import Template, CompilationMode

# Load your template
with open("template.zip", "rb") as f:
    template_bytes = f.read()

# Create template and compile
with Template(template_bytes) as template:
    pdf = template.compile(
        json_inputs={
            "invoice": json.dumps({
                "number": "INV-001",
                "items": [{"name": "Service", "price": 100}]
            })
        },
        export={"format": "pdf"},
        mode=CompilationMode.PRODUCTION,
    )

    # Save the PDF
    with open("output.pdf", "wb") as f:
        f.write(pdf)

Features

  • Multi-platform: Works on Linux, macOS, and Windows
  • Powerful Layouting: Full access to Typst's functionality
  • Performant: Native Rust performance via PyO3
  • Type Safe: Full type hints for IDE support
  • Pythonic: Context managers, dataclasses, and enums

Documentation

For more information, visit https://oicana.com/docs

License

This project is licensed under the PolyForm Noncommercial License 1.0.0. See the LICENSE.md file for details.

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

oicana-0.1.0a5.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

oicana-0.1.0a5-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file oicana-0.1.0a5.tar.gz.

File metadata

  • Download URL: oicana-0.1.0a5.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for oicana-0.1.0a5.tar.gz
Algorithm Hash digest
SHA256 c71b44ba4299aa64e3075bd6e563c81e3e649b043bdd21cd02eb61e2a4bd7d05
MD5 6910d6b701c6c6b2a05803fd8c9e1e43
BLAKE2b-256 6f68e05e0e767ddafb08d642fc6c957ecfb106a360f49c48ee5d5a401c14813c

See more details on using hashes here.

Provenance

The following attestation bundles were made for oicana-0.1.0a5.tar.gz:

Publisher: publish-integration-python.yml on oicana/oicana

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

File details

Details for the file oicana-0.1.0a5-py3-none-any.whl.

File metadata

  • Download URL: oicana-0.1.0a5-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for oicana-0.1.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 ec7c2fbf67682ea90dde22e5386be031338f12046c6fbca43edee44971228901
MD5 92846d1a1fd032ab811029884fe78608
BLAKE2b-256 16238af53d0020f716af2897ef905630b025f1aeb882a530640d58f81ed3f7b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for oicana-0.1.0a5-py3-none-any.whl:

Publisher: publish-integration-python.yml on oicana/oicana

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