https://github.com/andrewpetrochenkov/shields.py

shields.io badges
https://github.com/andrewpetrochenkov/shields.py

python readme

Last synced: about 2 months ago
JSON representation

shields.io badges

• Host: GitHub
• URL: https://github.com/andrewpetrochenkov/shields.py
• Owner: andrewpetrochenkov
• License: unlicense
• Created: 2018-06-20T15:16:57.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-12-03T21:25:49.000Z (over 4 years ago)
• Last Synced: 2024-11-05T01:06:09.876Z (7 months ago)
• Topics: python, readme
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 5
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


[![](https://img.shields.io/pypi/v/shields.svg?maxAge=3600)](https://pypi.org/project/shields/)

[![](https://img.shields.io/badge/License-Unlicense-blue.svg?longCache=True)](https://unlicense.org/)

[![](https://github.com/andrewp-as-is/shields.py/workflows/tests42/badge.svg)](https://github.com/andrewp-as-is/shields.py/actions)

### Installation

```bash

$ [sudo] pip install shields

```

#### Features

+   autoformat strings

+   [shields.io](http://shields.io/) **parameters**: `style`, `for-the-badge`, `social`), `label`, `logo`, `logoWidth`, `colorA`, `colorB`, `maxAge`, `longCache`

+   [shields.io](http://shields.io/) **styles**: `flat` (default), `plastic`, `flat-square`, `for-the-badge`, `social`

#### Examples

static badge [![](https://img.shields.io/badge/subject-status-blue.svg)]()

```python

>>> shields.Badge(subject="subject", status="status", color="blue", maxAge=3600)

'[![](https://img.shields.io/badge/subject-status-blue.svg)]()'

```

##### pypi badges

[![](https://img.shields.io/pypi/v/django.svg)](https://pypi.org/pypi/django/)

[![](https://img.shields.io/pypi/pyversions/django.svg)](https://pypi.org/pypi/django/)

[![](https://img.shields.io/pypi/l/django.svg)](https://pypi.org/pypi/django/)

[![](https://img.shields.io/pypi/wheel/django.svg)](https://pypi.org/pypi/django/)

[![](https://img.shields.io/pypi/format/django.svg)](https://pypi.org/pypi/django/)

[![](https://img.shields.io/pypi/implementation/django.svg)](https://pypi.org/pypi/django/)

[![](https://img.shields.io/pypi/status/django.svg)](https://pypi.org/pypi/django/)

```python

>>> 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

```python

>>> 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](http://shields.io/)



    readme42.com