Generic Typst-based report renderer. Turns structured YAML/JSON reports into sober, reproducible PDF documents.
Go to file
Dandaedre fe421e4ffa
Reportist CI All report validation and rendering checks passed.
Beffroi/reportist/pipeline/head This commit looks good Details
test: remove unused requirements input
2026-09-16 02:04:52 +02:00
docs test: remove unused requirements input 2026-09-16 02:04:52 +02:00
examples feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
schema feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
templates refactor: remove Python from Reportist runtime 2026-09-16 00:20:21 +02:00
tests test: remove unused requirements input 2026-09-16 02:04:52 +02:00
tools simplify: publish rendered PDFs with move 2026-09-16 01:55:25 +02:00
.gitignore feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
Jenkinsfile build: replace make with test script 2026-09-16 01:31:01 +02:00
LICENSE Initial commit 2026-09-15 14:49:58 +02:00
README.md docs: focus readme on standalone report making 2026-09-16 02:03:08 +02:00
requirements.txt test: remove unused requirements input 2026-09-16 02:04:52 +02:00
test.sh build: replace make with test script 2026-09-16 01:31:01 +02:00

README.md

Reportist

Reportist is a standalone structured-report maker. Give it a YAML or JSON report definition and it produces a PDF with Typst. It has no dependency on the Beffroi integration repository or diagnostic tools.

Render one report

bash tools/render.sh examples/example-report.yaml --output report.pdf

The renderer validates the input, loads an optional report-relative logo, and writes the completed PDF. Existing output requires --force.

Render every report in a directory

bash tools/render-all.sh /path/to/reports --output-dir /path/to/pdfs

Validate without rendering

bash tools/validate.sh examples/example-report.yaml
bash tools/validate-all.sh /path/to/reports

Start with examples/example-report.yaml or the smaller examples/minimal-report.json. See docs/report-contract.md for all fields and docs/development.md for tests and template development.