Skip to content

Helpful Links

BadgeShield

Dependencies

  • Typer — CLI framework powering badgeshield's subcommands
  • Rich — terminal output, progress bars, and error panels
  • Jinja2 — SVG template rendering
  • Pillow — optional; enables accurate font metrics and logo tinting
  • pylogshield — structured logging used internally

SVG & Badge Ecosystem

  • SVG specification (W3C) — reference for understanding generated SVG output
  • shields.io — popular hosted badge service (requires network; badgeshield is the offline alternative)
  • Simple Icons — brand icon SVGs suitable for use as badgeshield logos

Python Tooling

  • coverage.py — generates coverage.xml consumed by badgeshield coverage
  • pytest — test runner; JUnit XML output supported by badgeshield preset tests
  • setuptools-scm — version tagging from git used by badgeshield internally

Documentation

  • Zensical — static site generator used for this documentation
  • mkdocstrings — auto-generates API reference from docstrings