Ignore & README

This commit is contained in:
Dandaedre 2026-09-15 15:14:58 +02:00
parent 8b94966d26
commit d33bb4a16f
2 changed files with 134 additions and 2 deletions

104
.gitignore vendored Normal file
View File

@ -0,0 +1,104 @@
# =============================================================================
# Reportist
# Generic structured-data -> Typst -> PDF renderer
# =============================================================================
# OS
.DS_Store
.AppleDouble
Thumbs.db
Desktop.ini
# Editors
.idea/
.vscode/
*.swp
*.swo
*~
.#*
#*#
# Temporary files
*.tmp
*.temp
*.bak
*.old
*.orig
tmp/
temp/
.tmp/
.cache/
# Python
**pycache**/
*.py[cod]
.venv/
venv/
.pytest_cache/
.mypy_cache/
.ruff_cache/
.pyright/
.coverage
.coverage.*
htmlcov/
*.egg-info/
# Rust, if tooling is introduced
target/
# Build / generated output
build/
dist/
output/
outputs/
out/
artifacts/
# Reportist PDFs are generated artifacts.
# Source examples belong in examples/.
*.pdf
# Local configuration
.env
.env.*
!.env.example
.local/
config.local.*
*.local.yaml
*.local.yml
*.local.json
*.local.toml
# Secrets / credentials
*.secret
*.secrets
secrets/
credentials/
credentials.json
*.key
*.pem
*.p12
*.pfx
# Test output
coverage/
test-results/
junit.xml
# Runtime
*.pid
*.pid.lock
*.stackdump
core
core.*
# Archives
*.zip
*.tar
*.tar.gz
*.tgz
*.7z
# -----------------------------------------------------------------------------
# Intentionally tracked
# -----------------------------------------------------------------------------
#
# Do NOT globally ignore:
#
# *.typ
# *.yaml / *.yml
# *.json
# *.toml
# *.svg / *.png
#
# Templates, schemas, synthetic examples and reusable assets are source files.
#
# uv.lock / Cargo.lock should normally be committed when applicable.
# =============================================================================

View File

@ -1,3 +1,31 @@
# reportist
# Reportist
Generic Typst-based report renderer. Turns structured YAML/JSON reports into sober, reproducible PDF documents.
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.