Skip to content

v0.2.2

Choose a tag to compare

@ihassan8 ihassan8 released this 05 May 00:56
· 19 commits to main since this release

What's Changed

Fixes

  • CLI flags now use hyphens consistently — all subcommands (single, batch, coverage, preset) use --left-text, --left-color, --badge-name, --output-path etc.
  • Fixed Python 3.8 compatibility: dict[str, Preset]Dict[str, Preset] in presets.py
  • Fixed circle_frame.svg using deprecated xlink:href → plain href (SVG 2 compatible)
  • Fixed BadgeGenerator log level validation — invalid strings now raise ValueError immediately
  • Fixed --coverage-xml flag name in error messages and preset descriptions
  • Fixed stale "GitLab-specific" descriptions in pyproject.toml and BadgeGenerator docstring
  • Fixed get_lines_of_code returning "0" silently in --all preset mode
  • Added warning when tomli is unavailable on Python < 3.11 (previously silent fallback)

Documentation

  • Migrated from MkDocs to Zensical for docs builds (zensical.toml replaces mkdocs.yml)
  • Animated hero, carousel, stat counters, and typing subtitle on docs homepage
  • All CLI examples updated to hyphenated flag names
  • Development install instructions updated to use pip install -e ".[dev]"

CI / Packaging

  • Removed setup.pypyproject.toml exclusively manages build, version (setuptools_scm), and deps
  • Separated runtime, dev, and docs dependencies into distinct extras
  • Added _version.py to .gitignore — prevents dirty workspace version strings on CI
  • Docs deployment now uses publish-zensical.yml shared workflow

Installation

pip install badgeshield==0.2.2

Full Changelog: 0.2.1...0.2.2