reportist/README.md

60 lines
2.1 KiB
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](AGENT.md) for repository ownership and development rules.
[AGENTS-TASKS.md](AGENTS-TASKS.md) tracks migration passes, completed work,
acceptance criteria, and the next-pass handoff.
## Render a report
Requirements: Python 3.11+, the pinned packages in `requirements.txt`, Typst
0.15 or newer, and the fonts selected by the report. The examples use DejaVu
Sans and DejaVu Sans Mono.
```bash
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements.txt
.venv/bin/python tools/render.py examples/example-report.yaml \
--output output/example-report.pdf
```
The CLI validates before rendering and works from outside the repository. It
refuses an existing output unless `--force` is explicit. Exit 0 means a PDF was
published, 1 means input, validation, asset, Typst, or I/O failure, and 2 means
invalid CLI usage. Branding and logo paths come from report data; reports without
branding use neutral colors and no logo.
## Contract validation
The version-1 schema, standalone validator, and synthetic examples are available.
See [contract documentation](docs/report-contract.md) for setup and validation commands.
The first generic PDF rendering slice is implemented. Long-content visual review
and clean-clone verification remain 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.