INit

.dockerignore

@@ -0,0 +1,4 @@
+.ruff_cache/
+.venv/
+
+typst

.gitattributes

@@ -1,35 +0,0 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,6 @@
+.ruff_cache/
+.venv/
+
+__pycache__/
+
+document.pdf

Dockerfile

@@ -0,0 +1,67 @@
+FROM ubuntu:24.04
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update && \
+    apt-get upgrade -y && \
+    apt-get install -y --no-install-recommends \
+    git \
+    git-lfs \
+    wget \
+    curl \
+    # python build dependencies \
+    build-essential \
+    libssl-dev \
+    zlib1g-dev \
+    libbz2-dev \
+    libreadline-dev \
+    libsqlite3-dev \
+    libncursesw5-dev \
+    xz-utils \
+    tk-dev \
+    libxml2-dev \
+    libxmlsec1-dev \
+    libffi-dev \
+    liblzma-dev
+
+RUN apt install -y --reinstall ca-certificates && update-ca-certificates -f
+
+RUN useradd -m -u 1001 user
+USER user
+ENV HOME=/home/user
+ENV PATH=/home/user/.local/bin:${PATH}
+WORKDIR ${HOME}/app
+
+RUN wget "https://github.com/typst/typst/releases/download/v0.12.0/typst-x86_64-unknown-linux-musl.tar.xz" && \
+    tar -xf typst-x86_64-unknown-linux-musl.tar.xz && \
+    mv typst-x86_64-unknown-linux-musl/typst . && \
+    rm -rf typst-x86_64-unknown-linux-musl && \
+    rm typst-x86_64-unknown-linux-musl.tar.xz
+
+RUN curl https://pyenv.run | bash
+
+ENV PATH=${HOME}/.pyenv/shims:${HOME}/.pyenv/bin:${PATH}
+
+ARG PYTHON_VERSION=3.13.1
+RUN pyenv install ${PYTHON_VERSION} && \
+    pyenv global ${PYTHON_VERSION} && \
+    pyenv rehash && \
+    pip install --no-cache-dir -U pip setuptools wheel && \
+    pip install packaging ninja
+
+COPY --chown=1000 ./requirements.txt /tmp/requirements.txt
+RUN pip install --no-cache-dir --upgrade -r /tmp/requirements.txt
+
+COPY --chown=1000 . ${HOME}/app
+ENV PYTHONPATH=${HOME}/app \
+    PYTHONUNBUFFERED=1 \
+    GRADIO_ALLOW_FLAGGING=never \
+    GRADIO_NUM_PORTS=1 \
+    GRADIO_SERVER_PORT=7860 \
+    GRADIO_SERVER_NAME=0.0.0.0 \
+    GRADIO_THEME=huggingface \
+    SYSTEM=spaces
+
+EXPOSE 7860
+
+CMD ["python", "app.py"]

README.md

@@ -7,4 +7,68 @@ sdk: docker
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Generate PDF documents using Gradio and Typst
+
+- minijinja to template a Typst document
+- Typst to generate a PDF document
+- Gradio to provide a web interface with user parameters (via Components)
+- Docker to run the app
+
+## Demo
+
+<img src="./demo.jpeg" width="800">
+
+## Install
+
+Clone the repository:
+
+```shell
+git clone https://github.com/egorsmkv/pdf-generator-gradio
+cd pdf-generator-gradio
+```
+
+Install `typst`:
+
+```shell
+cargo install typst-cli
+```
+
+## Development
+
+Create virtual environment and install dependencies:
+
+```shell
+uv venv --python 3.13
+
+source .venv/bin/activate
+
+uv pip install -r requirements.txt
+uv pip install -r requirements-dev.txt
+```
+
+## Run
+
+Run Gradio app locally:
+
+```shell
+export TYPST_BIN=/home/yehor/.cargo/bin/typst
+
+gradio app.py
+```
+
+## Production
+
+Build the Docker image:
+
+```shell
+docker build -t pdf-generator-gradio .
+```
+
+Run:
+
+```shell
+docker run --rm -p 7860:7860 -it pdf-generator-gradio
+
+# Enable Gradio sharing
+docker run --rm -p 7860:7860 -e DO_SHARE=y -it pdf-generator-gradio
+```

app.py

@@ -0,0 +1,189 @@
+import sys
+import subprocess
+from pathlib import Path
+from os import getenv
+
+from importlib.metadata import version
+from PIL import Image
+from minijinja import Environment
+
+import gradio as gr
+
+# Config
+document_name = "document-template.typ"
+
+do_share = getenv("DO_SHARE")
+
+concurrency_limit = getenv("CONCURRENCY_LIMIT", 1)
+
+typst_bin_path = getenv("TYPST_BIN", "/home/user/app/typst")
+
+# App description
+title = "Typst-based PDF generation"
+
+examples = [
+    """
+I begin this story with a neutral statement.
+Basically this is a very silly test.
+""",
+]
+
+description_head = f"""
+# {title}
+
+## Overview
+
+We use https://typst.app to generate a PDF file with some parameters from this Gradio app.
+""".strip()
+
+tech_env = f"""
+#### Environment
+
+- Python: {sys.version}
+""".strip()
+
+
+def app_version(bin_path):
+    return subprocess.run([bin_path, "--version"], capture_output=True, text=True)
+
+
+def typst_compile(typst_bin_path, filename, export_template):
+    args = [typst_bin_path, "compile", filename, export_template]
+    print("Running:", args)
+
+    return subprocess.run(
+        args,
+        capture_output=False,
+    )
+
+
+def convert_document(bin_paths, text):
+    print("Converting...")
+
+    env = Environment(
+        templates={
+            "document": Path("document-template.typ").read_text(),
+        }
+    )
+    formatted_document = env.render_template("document", text=text)
+
+    # Write the rendered document to a temporary file
+    document_file = Path("document.typ")
+    document_file.write_text(formatted_document)
+
+    # Compile the .typ file to a .pdf file
+    c = typst_compile(bin_paths["typst"], "document.typ", "document.pdf")
+    if c.returncode != 0:
+        raise gr.Error("Typst compilation failed.")
+
+    print("Result:", c)
+
+    # Extract the first page of the PDF file
+    c = typst_compile(bin_paths["typst"], "document.typ", "file-{n}.png")
+    if c.returncode != 0:
+        raise gr.Error("Typst exporting to PNGs failed.")
+
+    print("Result:", c)
+
+    first_page = Path("file-1.png")
+    if not first_page.exists():
+        raise gr.Error("The first page has not been exported.")
+
+    # Move the image to an object
+    image = Image.open(first_page.absolute())
+
+    # Remove the temporary files
+    first_page.unlink(missing_ok=True)
+    document_file.unlink(missing_ok=True)
+
+    return image
+
+
+typst_version_info = app_version(typst_bin_path)
+if typst_version_info.returncode != 0:
+    print("Error: Typst version command failed.")
+    exit(1)
+
+r_tech_env = f"""
+#### Typst Environment
+
+```
+{typst_version_info.stdout.strip()}
+```
+""".strip()
+
+tech_libraries = f"""
+#### Libraries
+
+- gradio: {version("gradio")}
+""".strip()
+
+
+def generate_pdf(text, progress=gr.Progress()):
+    if not text:
+        raise gr.Error("Please paste your text.")
+
+    # Remove the previous PDF file and Typst file
+    Path("document.pdf").unlink(missing_ok=True)
+    Path("document.typ").unlink(missing_ok=True)
+
+    gr.Info("Generating the PDF document", duration=1)
+
+    bin_paths = {
+        "typst": typst_bin_path,
+    }
+    image = convert_document(bin_paths, text)
+
+    gr.Success("Finished!", duration=2)
+
+    pdf_file = gr.DownloadButton(
+        label="Download document.pdf",
+        value="./document.pdf",
+        visible=True,
+    )
+
+    return [image, pdf_file]
+
+
+demo = gr.Blocks(
+    title=title,
+    analytics_enabled=False,
+    theme=gr.themes.Base(),
+)
+
+with demo:
+    gr.Markdown(description_head)
+
+    gr.Markdown("## Usage")
+
+    with gr.Row():
+        text = gr.Textbox(label="Text", autofocus=True, max_lines=50)
+
+        with gr.Column():
+            pdf_file = gr.DownloadButton(label="Download PDF", visible=False)
+            preview_image = gr.Image(
+                label="Preview image",
+            )
+
+    gr.Button("Generate").click(
+        generate_pdf,
+        concurrency_limit=concurrency_limit,
+        inputs=text,
+        outputs=[preview_image, pdf_file],
+    )
+
+    with gr.Row():
+        gr.Examples(label="Choose an example", inputs=text, examples=examples)
+
+    gr.Markdown("### Gradio app uses:")
+    gr.Markdown(tech_env)
+    gr.Markdown(r_tech_env)
+    gr.Markdown(tech_libraries)
+
+if __name__ == "__main__":
+    demo.queue()
+
+    if do_share:
+        demo.launch(share=True)
+    else:
+        demo.launch()

document-template.typ

@@ -0,0 +1,32 @@
+= Test
+
+Privided text:
+
+{{ text }}
+
+== Another
+
+- Writing lists in a simple way is great.
+- Nothing complex, start your points with `-`
+  and this will become a list.
+  - Indented lists are created via indentation.
+
++ Numbered lists start with `+` instead of `-`.
++ There is no alternative markup syntax for lists
++ So just remember `-` and `+`, all other symbols
+  wouldn't work in an unintended way.
+  + That is a general property of Typst's markup.
+  + Unlike Markdown, there is only one way
+    to write something with it.
+
+
+I will just mention math ($a + b/c = sum_i x^i$)
+is possible and quite pretty there:
+
+$
+7.32 beta +
+  sum_(i=0)^nabla
+    (Q_i (a_i - epsilon)) / 2
+$
+
+To learn more about math, see corresponding chapter.

requirements-dev.txt

@@ -0,0 +1 @@
+ruff

requirements.txt

@@ -0,0 +1,2 @@
+gradio
+minijinja