32 lines
936 B
Markdown
32 lines
936 B
Markdown
# Reportist
|
|
|
|
Reportist is a generic **Typst-based report renderer**.
|
|
|
|
It turns structured YAML/JSON report definitions into sober, reproducible PDF documents.
|
|
|
|
```text id="38bc54"
|
|
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 the intended architecture and development rules.
|
|
|
|
## License
|
|
|
|
Software source code is licensed under the **MIT License**.
|
|
|
|
Examples and bundled assets may be subject to their own terms where indicated.
|