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.4.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.4.0-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oicana-0.4.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.4.0.tar.gz
Algorithm Hash digest
SHA256 7a690e3f94b3eaf371f0e84107f6074c6c93e0a4aaab8bb301f3cffc0c5a92d9
MD5 5aa70540adec00dbbf1275d234ebceae
BLAKE2b-256 45b793133adbe2aea655e68b9624b35322552534c178b87722c6a24869720d2a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: oicana-0.4.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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c0138c325ea31754a699243e89b9ad77aeae7136de1092362fda5d99cd310ac
MD5 b9e68e8fcc0c2b67882d62db865e8b84
BLAKE2b-256 f486b887d6d9b666ed179648ba78503eda1be14990a1e264849bc08ae271a8ed

See more details on using hashes here.

Provenance

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