Home

FormaTex Python SDK — Wiki

Welcome to the official wiki for the FormaTex Python SDK (formatex on PyPI).

Quick Links

📦 PyPI	pypi.org/project/formatex
📖 API Docs	formatex.io/docs
🔑 Dashboard	app.formatex.io
🐛 Issues	GitHub Issues
📋 Changelog	CHANGELOG.md

Wiki Pages

• Authentication — API keys, security, rotation
• Error Handling — All exception classes and how to handle them
• Rate Limits — Limits per plan, retry strategy
• Sync vs Async Compilation — When to use each approach
• Multi-File Compilation — Attach images, .bib, .cls files
• Engines — pdflatex vs xelatex vs lualatex vs latexmk
• Migration Guide — Breaking changes between versions

Installation

pip install formatex

Requires Python ≥ 3.9.

Minimal Example

from formatex import FormaTexClient

with FormaTexClient("your-api-key") as client:
    result = client.compile(
        r"\documentclass{article}\begin{document}Hello, \LaTeX!\end{document}"
    )
    with open("output.pdf", "wb") as f:
        f.write(result.pdf)

Get your API key from the dashboard.