zachhuff386 / git-shields

Go library for serving shields-style badges with PyPI and Drone support

Git Shields

Git Shields is a Shields service for python projects based on Buckler with support added for drone.io and pypi.

API

Each url has three parts the seperated by forward slashes:

http://gitshields.com/v2/:shield_type/:shield_parms/:shield_color.png

shield type

Can be text, pypi or drone

shield params

Shield params are seperated by a forward slash and are different for each type

• text ⇨ :right_text/:left_text
• pypi ⇨ :pypi_project/:query_type
• drone ⇨ :drone_project_path

sheild color

Color can be one of the predefined colors below or a hex color code, drone badges require two colors separated by a hyphen for the build passing and failing color.

Examples

• http://gitshields.com/v2/text/text/example/brightgreen.png ⇨
• http://gitshields.com/v2/pypi/setuptools/version/green.png ⇨
• http://gitshields.com/v2/pypi/setuptools/day_down/orange.png ⇨
• http://gitshields.com/v2/pypi/setuptools/week_down/red.png ⇨
• http://gitshields.com/v2/pypi/setuptools/month_down/lightgrey.png ⇨
• http://gitshields.com/v2/drone/github.com/pritunl/pritunl/brightgreen-red.png ⇨

Valid Colours

• brightgreen ⇨
• green ⇨
• yellowgreen ⇨
• yellow ⇨
• orange ⇨
• red ⇨
• grey ⇨
• lightgrey ⇨
• blue ⇨

Six digit RGB hexidecimal colour values work as well:

• 804000 -

URL Safe

Buckler API requests are just HTTP GETs, so remember to URL encode!

http://gitshields.com/v2/text/uptime/99.99%25/yellowgreen.png ⇨

Try It Out

Play around with the simple form on gitshields.com

Installing

go get github.com/zachhuff386/git-shields

Alternatively, git clone and go build to run from source.

Thanks

• James Bowes for the orignal buckler project
• Olivier Lacan for the shields repo
• Steve Matteson for Open Sans