cartouche-svg 0.3.0

Technical-drawing SVG dashboards for GitHub repositories and profiles.

Cartouche

🇬🇧 English (you are here) · 🇫🇷 Français

Technical-drawing SVG dashboards for GitHub repositories and profiles. Pure SVG primitives, sixteen themes (incl. watermarked variants), two languages, embeddable in any README via <picture>.

PyPI name: cartouche-svg (the bare cartouche slot belongs to an unrelated, abandoned Sphinx extension from 2013). Always pip install cartouche-svg.

[!TIP] The dashboard at the top of this README pulls real data and refreshes every 6 hours. A ★ on the repo means you'll show up as a tick on its own star-history curve before tonight. It's the most self-referential growth hack we could come up with. Yes, we already starred it ourselves — the experiment lacks a control group.

_{Light theme sampler — click any thumbnail for its section in THEMES.md, where every variant lives at full size in light + dark.}

Cartouche takes a GitHub repo (or a whole profile) and renders it as a technical-drawing SVG: grid, double-line frame, annotated star history, health radar, key metrics, and a cartouche — the architectural title block — in the bottom-right corner. Sixteen themes (light + dark, plus watermarked variants for Vellum + Davinci, Botanical + Floral, Blossom + Kawai), two built-in languages (English + French) with extensible custom packs via JSON, all served through the <picture> tag for both color modes.

Contents

• Why
• What gets displayed
• Installation
• CLI usage
• Internationalization
• Themes
• Custom annotations
• Embedding in a README
• Auto-update via GitHub Actions
• Python API
• Architecture
• Known limitations
• Development
• License

Why

Existing solutions (star-history.com, GitHub Charts, etc.) serve images through GitHub's Camo proxy, which means aggressive caching, occasional refresh failures, and zero control over the rendering. Cartouche makes the opposite tradeoff: generate the SVG locally via a GitHub Action, commit it to your repo, and serve it as a versioned file — so it refreshes on the cron cadence you set, is readable by anyone, and is fully styleable to taste.

What gets displayed

Repo dashboard

• FIG. 01 — Star history with peak annotations and endpoint marker
• FIG. 02 — 6-axis radar: stars, forks, commits, code, tests, docs
• FIG. 03 — Cards: stargazers, forks, issues, commits/30d + language breakdown bar

Profile dashboard

• FIG. 01 — Cumulative stars across all the account's public repos
• FIG. 02 — Top 5 repos by stars, with language and commits/30d (long names are truncated with … to keep them off the bars)
• FIG. 03 — 6-axis profile radar: reach, activity, breadth, depth, polyglot, engagement
• FIG. 04 — 53-week trailing contribution heatmap (via GraphQL — requires a token)
• FIG. 05 — Indicators: total stars, total forks, commits/12 months, account age

Both dashboards carry a small Proudly Clauded by @<handle> watermark just below the frame, in the bottom-right corner. The handle is pulled from the data, so anyone running the lib gets their own credit line automatically. To remove or rephrase it, override the proudly_clauded template via --lang-file.

Installation

pip install cartouche-svg

Zero runtime dependencies — Cartouche uses only the standard library (urllib for API calls, json, datetime, math, importlib.resources).

CLI usage

# Repo dashboard (English by default)
cartouche repo Sandjab/Athanor --theme blueprint-light --out dashboard.svg

# Same dashboard in French
cartouche repo Sandjab/Athanor --theme blueprint-light --lang fr --out dashboard.svg

# Profile dashboard
cartouche profile Sandjab --theme drafting-dark --out profile.svg

# List available themes and languages
cartouche themes
cartouche langs

# Test layouts without hitting the API (canned data)
cartouche repo Sandjab/Athanor --mock --theme vellum-light

# Override individual labels with your own JSON pack
cartouche repo Sandjab/Athanor --lang fr --lang-file ./my-overrides.json

# Replace auto-detected callouts on the star line with your own events
cartouche repo Sandjab/Athanor --annotations-file ./events.json

Token resolution: --token > $GITHUB_TOKEN > $GH_TOKEN > anonymous (60 req/h, rarely enough for a profile).

Internationalization

English by default. Switch to French with --lang fr.

Built-in packs

cartouche langs   # → en, fr

Adding a language

Drop a <code>.json file into src/cartouche/lang/, mirroring the schema of en.json (keys: labels, templates, months_short, months_long). The test_lang_has_all_required_keys test will tell you which keys are mandatory. Once dropped and the wheel rebuilt, --lang <code> works out of the box.

Overriding without recompiling

To tweak a few strings ad-hoc without publishing a new pack, write a JSON overlay and pass it via --lang-file:

{
  "labels": {
    "fig_radar_health": "FIG. 02 — VITAL SIGNS",
    "drawn_by": "BY"
  },
  "templates": {
    "n_years": "{n} years"
  }
}

cartouche repo Sandjab/Athanor --lang en --lang-file my-overrides.json --out dashboard.svg

The overlay is deep-merged on top of the base pack: only the keys you specify are replaced, everything else stays intact.

Language pack schema

{
  "code": "xx",
  "name": "My language",
  "labels": {
    "drawn_by": "...",
    "fig_radar_health": "...",
    "card_stargazers": "...",
    ...
  },
  "templates": {
    "fig_star_history": "FIG. 01 — STAR HISTORY · {start} → {end}",
    "first_star_top": "// FIRST STAR — {date}",
    ...
  },
  "months_short": ["JAN", "FEB", ...],
  "months_long":  ["Jan", "Feb", ...]
}

See src/cartouche/lang/en.json for the full key list.

Themes

Sixteen themes in eight families, each with a light and a dark counterpart. The first five families are clean palettes; the last three are watermarked variants that ghost a bundled PNG (Da Vinci plate, floral motif, kawaii character) behind the data layer at low opacity. See THEMES.md for side-by-side previews of every variant.

Family	Light	Dark
Drafting	drafting-light	drafting-dark
Blueprint	blueprint-light	blueprint-dark
Vellum	vellum-light	vellum-dark
Botanical	botanical-light	botanical-dark
Blossom	blossom-light	blossom-dark
Vellum + Davinci	vellum-davinci-light	vellum-davinci-dark
Botanical + Floral	botanical-floral-light	botanical-floral-dark
Blossom + Kawai	blossom-kawai-light	blossom-kawai-dark

• Drafting — pure grayscale. White paper, black ink — no hue at all, series and accent separated by lightness only.
• Blueprint — cyanotype lineage. Pale faded blue or a deep nighttime Prussian blue dive.
• Vellum — cream parchment / sepia. Dark variant: aged leather and gold. For those who want a Beaux-Arts feel rather than engineering.
• Botanical — 19th-century herbarium plate. Sage-and-fern ink on ivory, deep forest at night with candle-pollen accents.
• Blossom — sakura kawaii. Powder-rose on pearl-grey ivory, deep aubergine boudoir at night, neon-soft pink data with mint accents.
• Vellum + Davinci — Vellum palette + Da Vinci plate watermark. Reads as the surface of an old codex with the master draftsman's notebook bleeding through.
• Botanical + Floral — Botanical palette + floral motif watermark. The herbarium feel pushed further into a wallpapered field of flowers.
• Blossom + Kawai — Blossom palette + kawaii character watermark. Sakura stationery, soft mascot ghosted under the cartouche grid.

Custom annotations

By default the repo dashboard auto-detects two callouts on the star history: the first star and the largest single-step spike. Pass --annotations-file path/to/events.json to replace them with your own list of events:

[
  {"date": "2025-12-15", "label_top": "// HACKER NEWS", "label_bottom": "// front page"},
  {"date": "2026-04-01", "label_top": "// SHIPPED v1", "label_bottom": "// public release"},
  {"date": "2026-04-15", "count": 100, "label_top": "// MILESTONE", "label_bottom": "// 100 stars"}
]

• date (required, ISO YYYY-MM-DD) is where the callout anchors on the star-history axis.
• label_top / label_bottom (required) are the two text lines drawn next to the leader line. Convention is // PREFIX for the top line and a more descriptive bottom line, but anything goes.
• count (optional) is the cumulative star count to anchor on the curve. If omitted, Cartouche derives it from the closest star_history entry on or before that date.

Custom annotations replace the auto-detected pair — copy the auto- detected ones into your file if you want to keep them. Only available on the repo dashboard (the profile star line does not have annotations).

Embedding in a README

Serve the right variant based on the visitor's prefers-color-scheme:

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="assets/dashboard-dark.svg">
  <img src="assets/dashboard-light.svg" alt="Cartouche dashboard">
</picture>

Important: use a relative path (assets/...), not an absolute URL. GitHub rewrites external images through its Camo proxy, which breaks the <picture> light/dark mechanism; relative paths are served as-is.

Auto-update via GitHub Actions

Two ready-to-use workflows live in examples/workflows/:

• repo-dashboard.yml — drop into .github/workflows/ of the repo whose dashboard you want. Regenerates and commits every 6 hours.
• profile-dashboard.yml — drop into your profile repo (<handle>/<handle>). Twice a day.

Both use secrets.GITHUB_TOKEN (already available in any Action) and work with no further configuration. To serve a French dashboard, add --lang fr to the cartouche commands in the workflow.

Python API

from cartouche import lang
from cartouche.render import repo
from cartouche.themes import get_theme

# Load a language pack (with optional overlay)
fr = lang.load("fr", overlay_path="my-overrides.json")  # overlay optional

# Load data (mock or via fetch.repo_data())
from cartouche.mock import mock_repo
data = mock_repo("Sandjab", "Athanor", lang=fr)

# Render the SVG
svg = repo.render(data, theme=get_theme("vellum-light"), lang=fr)

Architecture

src/cartouche/
├── themes.py            # 16-theme registry (dict-of-dicts)
├── lang/
│   ├── __init__.py      # load(), list_builtin(), t(), tmpl()
│   ├── en.json          # default language
│   └── fr.json          # French
├── fetch.py             # GitHub REST + GraphQL wrappers, stdlib only
├── mock.py              # canned fixtures for development without API
├── cli.py               # argparse entry point
└── render/
    ├── primitives.py    # frame, grid, cartouche, axes, radar, text
    ├── repo.py          # repo dashboard composer
    └── profile.py       # profile dashboard composer

The render engine is token-agnostic (colors come from themes) and literal-free (strings come from lang). Adding a seventh theme = ~12 lines in THEMES. Adding a language = drop a JSON in lang/. See CLAUDE.md for the architectural invariants in detail.

Known limitations

• The profile dashboard hits /repos/.../stargazers for each public repo; the first run on a viral account can still take a minute, but subsequent runs are near-instant thanks to a 24h disk cache ($XDG_CACHE_HOME/cartouche/). Pass --no-cache to skip it, --cache-ttl 0 to force a one-shot refresh, or --cache-dir PATH to relocate. True incremental refresh (only fetch stars added since last run) isn't implemented yet — when the cache is stale, the timeline is refetched in full.
• Forks are excluded from profile aggregates (filtered out). The dashboard for an individual fork still works normally.
• Web fonts are not embedded — GitHub strips them when rendering SVGs in READMEs. The fallback is a system monospace stack.
• The two auto-detected annotations (first ★, biggest spike) replace each other if you pass --annotations-file; there's no way to augment the auto-detected pair without listing them manually in your overlay.

Development

git clone https://github.com/Sandjab/cartouche
cd cartouche
pip install -e ".[dev]"
pytest                                                 # 128 tests, ~0.3s
python -m cartouche repo Sandjab/Athanor --mock        # smoke test without API
python -m cartouche profile Sandjab --mock --lang fr   # FR variant

For Claude Code CLI: see CLAUDE.md for architecture, invariants, and common tasks.

License

MIT — see LICENSE.