Generic Typst-based report renderer. Turns structured YAML/JSON reports into sober, reproducible PDF documents.
Go to file
Dandaedre e2ada627d0
Reportist CI Reportist passed all currently implemented CI checks.
Beffroi/reportist/pipeline/head This commit looks good Details
feat: define generic report v1 contract and YAML JSON validator
2026-09-15 16:32:36 +02:00
docs feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +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
tests feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
tools feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
.gitignore feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
AGENT.md Add AGENT.md 2026-09-15 14:50:21 +02:00
AGENTS-TASKS.md feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
Jenkinsfile feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
LICENSE Initial commit 2026-09-15 14:49:58 +02:00
README.md feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
requirements.in feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
requirements.txt feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00

README.md

Reportist

Reportist is a generic Typst-based report renderer.

It turns structured YAML/JSON report definitions into sober, reproducible PDF documents.

report.yaml
    ↓
 Reportist
    ↓
report.pdf

The project handles report structure, validation, presentation, themes and rendering. It is intentionally independent from the systems producing the information contained in a report.

Reportist originates from the reporting tooling developed for the Beffroi diagnostics workflow, but is designed to be usable independently.

Status

🚧 Early development / migration

The renderer is currently being extracted and generalized from the previous typst_reporter project.

See AGENT.md for repository ownership and development rules. AGENTS-TASKS.md tracks migration passes, completed work, acceptance criteria, and the next-pass handoff.

Contract validation

The version-1 schema, standalone validator, and synthetic examples are available. See contract documentation for setup and validation commands. Collection/analysis and PDF rendering are still separate migration tasks.

License

Software source code is licensed under the MIT License.

Examples and bundled assets may be subject to their own terms where indicated.