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.export(
        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

Licensing

Oicana is source-available under PolyForm Noncommercial License 1.0.0. You can use it for free in any noncommercial context. For commercial use, please visit the Oicana website for pricing options.

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.3.0.tar.gz (9.1 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.3.0-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file oicana-0.3.0.tar.gz.

File metadata

  • Download URL: oicana-0.3.0.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for oicana-0.3.0.tar.gz
Algorithm Hash digest
SHA256 990569b1bed1e34134bbfe720b5a6ee18a8ad847106fb50c7fbc3a5d743bfd48
MD5 b1ffef02ec178b1127cc13d001560597
BLAKE2b-256 43e0f897983e19196e03cf333fd6cf1e0b5c157b73823d86add44640b5977162

See more details on using hashes here.

Provenance

The following attestation bundles were made for oicana-0.3.0.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.3.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for oicana-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c706c66afc0bdb6664d2b9e2653d1d3a0c53d83262a816eefe44d163a48647b
MD5 ed21c075032e4aa3d645e5b274f11fc5
BLAKE2b-256 ccfed32a57a85111bc8e5a6ffaa1e02f13babf1f707a2ec1f9dd22ac33bb58f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for oicana-0.3.0-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