skaldr

Turn one YAML file into one polished, self-contained HTML report page. You describe what the report says — findings, tables, a pipeline, the numbers — and skaldr owns how it looks: layout, spacing, colour, light/dark, all decided once, here. No design work, no CSS, no drift.

See it → sales pipeline · warehouse count (rendered from examples/sales-pipeline.yaml and data/example.yaml).

Install

brew install alex-yanchenko/tap/skaldr     # recommended (macOS/Linux)
uv tool install skaldr                     # or, with uv
pipx install skaldr                        # or, with pipx

All three put a skaldr command on your PATH. (From a checkout, uv run skaldr … works without installing.)

Use

skaldr report.yaml                 # → out/report.html
skaldr report.yaml -o review.html  # choose the output path
skaldr report.yaml --watch -o review.html  # re-render on every save (live edit→preview; Ctrl-C to stop)
skaldr report.yaml --pdf report.pdf  # a ready-to-share PDF (drives a headless Chrome/Chromium)
open review.html                   # a self-contained file — open it, host it, or share it

That's the whole tool: point it at a content file, get an HTML page (or a PDF). A few more commands help you write the content file and share the result:

skaldr --guide                     # the authoring guide: every block, the rules, a full example
skaldr --write-schema page.schema.json   # JSON Schema for your editor's YAML language server
skaldr report.yaml --embed -o out.html   # Artifact-ready fragment (no <html> skeleton) to publish as a claude.ai Artifact
skaldr --check report.yaml         # validate against the schema, write nothing (exits non-zero on error)
skaldr --check reports/*.yaml      # validate a whole set at once — for a pre-commit hook or CI
skaldr --emit-json report.yaml     # print the normalised model as JSON on stdout (for tooling/agents)
skaldr --extract-source report.html  # recover the YAML source embedded in a render (a file or an http(s) URL)

For a PDF, use --pdf (above): it prints the page's print styling with a headless browser you already have — the reliable way to a shareable PDF. (Printing a published Artifact doesn't work: it's a sandboxed frame the browser flattens to a snapshot, so the print CSS never applies.) --pdf needs a Chrome/Chromium/Edge on the machine; set SKALDR_BROWSER to point at one if it isn't auto-found.

There are no styling flags — everything is in the content file.

The content file

version: 1
meta:
  title: "Q3 Warehouse Inventory Count — Discrepancies & Fixes"
  subtitle: ["Reconciled review of the 10,000-unit cycle count."]
  source: "WMS export"          # optional; feeds the provenance footer
  date: "Q3 2026"               # optional; never auto-now (builds are reproducible)
  toc: true                     # optional; auto table-of-contents from level-2 headings
  hero: true                    # optional; larger display title + subtitle in a tinted band
badges:                         # author-declared vocabulary (see below)
  FLOOR:  { label: "Floor",  tone: amber, legend: "Fixable on the floor before the next count." }
  SYSTEM: { label: "System", tone: blue,  legend: "Defect in the scanning/labeling pipeline." }
blocks:
  - { type: heading, text: "Overview" }
  - { type: text, body: "Prose with **bold**, *italic*, `code`, ~~strike~~ and [links](https://x)." }
  - { type: cards, items: [{ label: "Matched cleanly", value: 8500, of: 10000, tone: success }] }
  # … more blocks

Top level is version · meta · optional badges · blocks — nothing else. Every block carries a type discriminator; the model is a pydantic discriminated union, so an unknown type, a field from the wrong block, or an unknown key each fails with a precise blocks.3.items.2.value-style error before anything renders.

Blocks: heading · text · list · fact_strip · key_value · cards · badge_row · callout · status_list · meter · table · code · quote · image · timeline · flow (a directional pipeline — arrow or step style, optional loop) · section (collapsible) · grid (bounded 6-column layout, with optional per-cell emphasis panels). The table is the workhorse — typed columns, grouped subtotals, sub-rows, colour-only indicator dots, row-level tone, and a reconcile block that hard-fails the build if the counts don't sum to a declared total. Badges are declared once and chip onto table rows, cards, timeline entries, and flow nodes alike. Prose fields take a small markdown subset (**bold**, *italic*, `code`, ~~strike~~, links); raw HTML is never interpreted.

Full reference: skaldr --guide (source: src/skaldr/skill/GUIDE.md), data/example.yaml (a file exercising every block), and schema/page.schema.json.

Guarantees

  • One self-contained file — inline CSS, system fonts, no external resources; the page carries its own <!doctype> + <meta charset> so it renders correctly from file://, any static host, or a claude.ai Artifact.
  • Validation is the product — structural mistakes fail the build with a field path, never reach the reader's eyes.
  • Derived, not authored — number formatting, percentages, subtotals, the legend, the TOC, and the provenance footer are all computed, so they can't drift from the data.
  • Light & dark — the palette follows the viewer's OS theme; a small corner menu lets the reader switch theme and page width.

Let an AI write it

skaldr ships Claude skills, so you can skip the YAML and just ask. Install them once:

skaldr --install-skill      # copies skaldr's skills into ~/.claude/skills (survives upgrades)
skaldr --install-plan-rule  # optional: also have the AI keep its working plans as live skaldr docs

--install-skill installs the core authoring skill and task-specific ones: a presentation builder (skaldr-presentation) that writes a word-for-word teleprompter runbook (with color-coded live/recording cues) and drives the audience deck into the org's real brand template, and a reflection helper (skaldr-reflect) that turns your experience of authoring with skaldr into a ranked, actionable pain-points report for the maintainer. Each lands in its own ~/.claude/skills/<name>/.

Skills keep themselves current. After a brew upgrade skaldr, an installed skill refreshes itself the next time you run skaldr — no need to re-run --install-skill. It only ever refreshes a skill you already installed (never creates one), never touches a symlinked skill (a contributor's live-edit link), and never interferes with a render. Set SKALDR_SKILL_SYNC=0 to turn the auto-refresh off.

--install-plan-rule is a separate, optional step: it adds a short, marker-delimited rule to ~/.claude/CLAUDE.md that steers the AI to author its working plans as live skaldr docs (rendered with --watch so you can follow along). Delete that skaldr:plan-rule block to opt out; re-running it refreshes the block in place. --install-skill never touches CLAUDE.md on its own.

Then in Claude Code (or Cowork), ask in plain language — "make me a skaldr report on this data export: what's clean, what's broken, and the fix" — and it writes the content file and renders the page. The skill reads the current guide from the tool itself (skaldr --guide), so it stays correct across upgrades without reinstalling.

Development

uv run skaldr data/example.yaml -o out/example.html   # run from a checkout
uv run pytest                                          # tests

Project links

Data verified by PyPI on Aug 7, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.11.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for KeeperKeys from gravatar.com KeeperKeys

Credits

Author: Alex Yanchenko

GitHub Statistics

Data verified by PyPI on Aug 7, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Tags

report html yaml components jinja

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skaldr-2.7.0.tar.gz (107.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skaldr-2.7.0-py3-none-any.whl (117.0 kB view details)

Uploaded Python 3

File details

Details for the file skaldr-2.7.0.tar.gz.

File metadata

  • Download URL: skaldr-2.7.0.tar.gz
  • Upload date:
  • Size: 107.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for skaldr-2.7.0.tar.gz
Algorithm Hash digest
SHA256 84f3ebb3444c053089a9acc4ef60e3f7ee3928d3d34de7a6248d0a43969cf092
MD5 25b212d0ccc588b1e79211b6103de4c0
BLAKE2b-256 1f6e55d26b91014faeee7593c883cc911e416279475d75255a6ddfef59c46e05

See more details on using hashes here.

Provenance

The following attestation bundles were made for skaldr-2.7.0.tar.gz:

Publisher: publish.yml on alex-yanchenko/skaldr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file skaldr-2.7.0-py3-none-any.whl.

File metadata

  • Download URL: skaldr-2.7.0-py3-none-any.whl
  • Upload date:
  • Size: 117.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for skaldr-2.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1c669a813712ec1219180214f2c1c4f3fdeb67b1ddc28febeaa70e3d0c80f5c2
MD5 aae9078e8b10ad8789c42536c5cf6463
BLAKE2b-256 5d5e31f765d4078f8a221d4c4e7ee4515824f5192d9a08f1d351d7c49d9380a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for skaldr-2.7.0-py3-none-any.whl:

Publisher: publish.yml on alex-yanchenko/skaldr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.11.1

2 files

2.11.0

2 files

2.10.0

2 files

2.9.0

2 files

2.8.0

2 files

This release

2.7.0 This release

2 files

2.6.0

2 files

2.5.0

2 files

2.4.0

2 files

2.3.0

2 files

2.2.1

2 files

2.2.0

2 files

2.1.0

2 files

2.0.0

2 files

1.4.0

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page