Metadata-Version: 2.1
Name: badge
Version: 2018.11.19
Summary: badge generator
Home-page: https://github.com/looking-for-a-job/badge.py
License: UNKNOWN
Keywords: badge
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
Requires-Dist: format-keys
Requires-Dist: public
Requires-Dist: setuptools

[![](https://img.shields.io/pypi/pyversions/badge.svg?longCache=True)](https://pypi.org/pypi/badge/)

#### Install
```bash
$ [sudo] pip install badge
```

#### Features
+   **md** (default), **rst**, **html**
+   autoformat strings
+   **minimalistic design**

#### Classes

###### `badge.Badge`

badge generator class

attr|default value
-|-
`branch`|`master`
`image`|`''`
`link`|`''`
`markup`|`md`
`title`|`''`
`visible`|`True`

@property|description
-|-
`html`|render to .html
`md`|render as .md
`rst`|render as .rst

#### Examples
```python
>>> class Travis(badge.Badge):
    title = "Travis"
    image = "https://api.travis-ci.org/{fullname}.svg?branch={branch}"
    link = "https://travis-ci.org/{fullname}/"

>>> Travis(fullname="owner/repo") # .md, Markdown by default
'[![Travis](https://api.travis-ci.org/owner/repo.svg?branch=master)](https://travis-ci.org/owner/repo/)'

>>> Travis(fullname="owner/repo").rst # .rst, reStructuredText
'.. image: : https://api.travis-ci.org/owner/repo.svg?branch=master
    : target: https://travis-ci.org/owner/repo/'
```

<p align="center"><a href="https://pypi.org/project/readme-md/">readme-md</a> - README.md generator</p>

