Releases: ihassan8/badgeshield
Releases · ihassan8/badgeshield
Minor change
v0.2.2
What's Changed
Fixes
- CLI flags now use hyphens consistently — all subcommands (
single,batch,coverage,preset) use--left-text,--left-color,--badge-name,--output-pathetc. - Fixed Python 3.8 compatibility:
dict[str, Preset]→Dict[str, Preset]inpresets.py - Fixed
circle_frame.svgusing deprecatedxlink:href→ plainhref(SVG 2 compatible) - Fixed
BadgeGeneratorlog level validation — invalid strings now raiseValueErrorimmediately - Fixed
--coverage-xmlflag name in error messages and preset descriptions - Fixed stale "GitLab-specific" descriptions in
pyproject.tomlandBadgeGeneratordocstring - Fixed
get_lines_of_codereturning"0"silently in--allpreset mode - Added warning when
tomliis unavailable on Python < 3.11 (previously silent fallback)
Documentation
- Migrated from MkDocs to Zensical for docs builds (
zensical.tomlreplacesmkdocs.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.py—pyproject.tomlexclusively manages build, version (setuptools_scm), and deps - Separated runtime, dev, and docs dependencies into distinct extras
- Added
_version.pyto.gitignore— prevents dirty workspace version strings on CI - Docs deployment now uses
publish-zensical.ymlshared workflow
Installation
pip install badgeshield==0.2.2Full Changelog: 0.2.1...0.2.2
0.1.0
fix: cross-platform compat, SVG accuracy, docs overhaul, and CI matrix
- badge_generator.py: replace os.path with pathlib; cross-platform
absolute-path guard using PurePosixPath + PureWindowsPath; fix
right_width/total_width formula alignment with label.svg template - label.svg: remove redundant {% set %} blocks that overrode Python
context; replace xlink:href with href; clean up xmlns:xlink - circle.svg: remove deprecated xlink namespace and attribute
- pill.svg, banner.svg: add aria-label, role=img, and <title> for
accessibility - badge_template.svg: delete unreferenced dead template file
- tests: fix snapshot I/O encoding (utf-8); fix style context key
assertions; parametrize absolute-path test to cover Windows paths;
update snapshots - docs: restructure usage.md parameters table into constructor vs
generate_badge() sections; fix Colors import to public API; add
per-entry style to batch example; remove phantom render_badge/BadgeSVG
references from all docs; add PILL/BANNER/audit/style content - README.md: 3→5 templates; add styles; remove phantom in-memory section;
fix coverage color threshold wording - release.yml: add pull_request trigger and cross-platform test matrix
(ubuntu/windows/macos × Python 3.8–3.12) - Remove stale superpowers plan/spec docs