/all-badge

Generate custom badges, git tag badges and coverage badges.

Primary LanguagePythonMIT LicenseMIT

All-badge

build pypi

Script to generate badges based in coverage-badge. Generates coverage badge, git tag badge and you can make your own.

Badge styles from shields.io

Instalation

pip install all_badge

Examples:

Coverage

all_badge -f -cov -s flat -o cov.svg

15%

45%

65%

80%

93%

97%

Git

all_badge -c brightgreen -f -git -s flat -o git.svg

Gitlab example 1

all_badge -c blue -f -git -s flat -o git.svg

Gitlab example 2

Custom

all_badge -c brightgreen -o version.svg -f -t 'made by' -v Carlosmart -s flat

Custom 1

all_badge -c brightgreen -o version.svg -f -t 'made by' -v Carlosmart -s for-the-badge

Custom 2

all_badge -c brightgreen -f -t 'made by' -v Carlosmart -s flat-square -o media/example-custom-3.svg

Custom 3

Usage:

usage: all_badge [-h] [-o FILEPATH] [-p] [-f] [-q] [-version] [-git] [-cov]
                 [-t TEXT] [-v VALUE] [-c COLOR] [-s STYLE]

Generate badges

optional arguments:
  -h, --help   show this help message and exit
  -o FILEPATH  Save the file to the specified path.
  -p           Plain color mode. Standard green badge.
  -f           Force overwrite image, use with -o key.
  -q           Don't output any non-error messages.
  --version    Show version.
  -git         Build badge for git tag.
  -cov         Build badge for coverage.
  -t TEXT      Badge text.
  -v VALUE     Badge value.
  -c COLOR     Badge color.
  -s STYLE     Badge style.

Contributing

Install requirements:

pip install -e ".[test]"

Run tests

pytest .