Anybadge

1.16.0 · active · verified Sat Apr 11

Anybadge is a Python library and command-line tool designed for simple and flexible generation of SVG badges for your projects. It allows users to define custom labels, values, and configurable thresholds to color badges dynamically. The library is actively maintained, with its current version being 1.16.0, and receives regular updates.

Warnings

breaking Python 2.7 support was dropped in version 1.10.0. Projects using older Python versions must upgrade to Python 3.4 or higher.
Fix: Ensure your project runs on Python >= 3.4. Upgrade your Python environment if necessary.
gotcha Earlier versions (prior to v1.16.0) could mishandle malformed thresholds, leading to unexpected badge colors or errors.
Fix: Upgrade to anybadge v1.16.0 or newer. Ensure threshold definitions are correctly formatted (e.g., `{'value': 'color'}`).
gotcha Issues with escaping special characters in badge labels and values were present in versions prior to v1.16.0, potentially causing malformed SVG output.
Fix: Upgrade to anybadge v1.16.0 or newer to benefit from fixes for label and value escaping.
gotcha A package version bug was identified and fixed in v1.16.0, which might have affected how the library reported or used its own version information.
Fix: Upgrade to anybadge v1.16.0 or newer to resolve any internal package versioning inconsistencies.

Install

pip install anybadge Install latest version

Imports

Badge
```
from anybadge import Badge
```
anybadge
```
import anybadge
```
For direct access to the main module or `anybadge.Badge` if not importing `Badge` directly.

Quickstart

This example demonstrates how to create a PyLint score badge using thresholds to determine its color and then save it as an SVG file. Values can be integers, floats, or strings, and custom colors (hex codes or named colors) are supported.

import anybadge

# Define thresholds for coloring the badge based on value
# <2=red, <4=orange, <6=yellow, <10=green
thresholds = {2: 'red', 4: 'orange', 6: 'yellow', 10: 'green'}

# Create a badge instance
badge = anybadge.Badge(
    label='pylint',
    value=2.22,
    thresholds=thresholds
)

# Write the badge to an SVG file
badge.write_badge('pylint.svg')

print('pylint.svg generated.')

view raw JSON →