Skip to main content

Status build shields for Sloth CI powered by

Project description

Status build badges for Sloth CI apps, powered by


.. code-block:: bash

$ pip install sloth-ci.ext.shields_io


#. Enable the extension in the server config:

.. code-block:: yaml
:caption: sloth.yml for

# Use the module sloth_ci.ext.shields_io.
module: shields_io

# Badge label. You can use the ``{app}`` and ``{timestamp}`` placeholders for app name and build timestamp.
# label: "My Sloth CI Status for {app}" # default is ``Sloth CI: {app}``

# Badge status. You can use ``{status}``, ``{app}``, and ``{timestamp}`` placeholders build status, app name, and build timestamp
# status: "{status}" # default is ``{status}, {timestamp}``

# Badge style: ``plastic``, ``flat``, ``flat-square``, or ``social``
# style: social # default is ``flat``

# Badge format: svg, png, jpg, or gif
# format: png # default is svg

# Color map for build statuses
# colors:
# INFO: green # default is ``brightgreen``
# WARNING: yellowgreen # default is ``yellow``
# ERROR: orange # default is ``red``

All params are optional.

#. Use the URL http://host:port/app?action=shield to get your badge.

You can customize the badge on the fly by passing ``label``, ``style``, and ``format`` query params:

- http://host:port/app?action=shield&label=Build%20for%20{app}
- http://host:port/app?action=shield&style=social
- http://host:port/app?action=shield&format=png

Project details

Download files

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

Files for sloth-ci.ext.shields_io, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size sloth_ci.ext.shields_io-1.0.5-py3-none-any.whl (5.4 kB) File type Wheel Python version 3.5 Upload date Hashes View
Filename, size sloth-ci.ext.shields_io-1.0.5.tar.gz (2.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page