Installation

$ [sudo] pip install shields

Features

• autoformat strings
• shields.io parameters: style, for-the-badge, social), label, logo, logoWidth, colorA, colorB, maxAge, longCache
• shields.io styles: flat (default), plastic, flat-square, for-the-badge, social

Classes

class	__doc__
shields._badge.Badge	shields.io custom Badge
shields.npm.V	npm Version badge
shields.pypi.L	pypi License badge
shields.pypi.Pyversions	pypi pyversions badge
shields.pypi.V	pypi Version badge

Examples

static badge

>>> shields.Badge(subject="subject", status="status", color="blue", maxAge=3600)
'[![](https://img.shields.io/badge/subject-status-blue.svg)]()'

pypi badges

>>> shields.pypi.V("django")
'[![](https://img.shields.io/pypi/v/django.svg)](https://pypi.org/pypi/name/)'

>>> shields.pypi.Pyversions("django")
'[![](https://img.shields.io/pypi/pyversions/django.svg)](https://pypi.org/pypi/name/)'

>>> shields.pypi.L("django")
'[![](https://img.shields.io/pypi/l/django.svg)](https://pypi.org/pypi/name/)'

subclass

>>> class New(shields.Abstract):
    path = "npm/v/{name}.svg"
    link = "https://www.npmjs.com/package/{name}"

>>> Npm(name="jquery")
'[![](https://img.shields.io/npm/v/jquery.svg)](https://www.npmjs.com/package/jquery)'

Links

• shields.io

python-readme-generator