Skip to main content

badge image class

Project description

Install

$ [sudo] pip install badges

Features

  • md, rst support
  • autoformat strings with instance and class variables
  • minimalistic design, easy subclassing
  • CircleCI, Travis, ... badge classes

Examples

# format attributes - {attrname}
>>> class CustomBadge(badges.Badge):
    branch = "master"
    link = "https://site.com/{fullname}"
    image = "https://site.com/{fullname}?branch={branch}.svg"

>>> CustomBadge(fullname="owner/repo")
'[![](https://site.com/owner/repo?branch=master.svg)](https://site.com/owner/repo)'

# format @property - {0.propname}
>>> class CustomBadge(badges.Badge):
    branch = "master"
    link = "https://site.com/{0.fullname}"
    image = "https://site.com/{0.fullname}?branch={branch}.svg"

    @property
    def fullname(self):
        return "/".join(os.getcwd().split("/")[-2:])

>>> CustomBadge()
'[![](https://site.com/owner/repo?branch=master.svg)](https://site.com/owner/repo)'

Sources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

badges-0.0.1.tar.gz (3.3 kB view details)

Uploaded Source

File details

Details for the file badges-0.0.1.tar.gz.

File metadata

  • Download URL: badges-0.0.1.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for badges-0.0.1.tar.gz
Algorithm Hash digest
SHA256 bb8f830525ffa07b074b3c502cab4278398d4bb8b267be447a1d64a62e9f09a5
MD5 01674cd9ef7a603d57a1d198ee497bcc
BLAKE2b-256 0514ce6d8c4a69ae54979e3e37ab0573f3242ebf1770785321648e88f4711e83

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page