# anybadge
Python project for generating badges for your projects
[](https://pypi.org/project/anybadge)
[](https://app.travis-ci.com/github/jongracecox/anybadge)
[](https://pypistats.org/packages/anybadge)
[](https://github.com/jongracecox/anybadge/commits/master)
[](https://github.com/jongracecox/anybadge/blob/master/LICENSE)
[](https://github.com/jongracecox/anybadge/stargazers)
[](https://snyk.io/advisor/python/anybadge)
[](https://www.buymeacoffee.com/jongracecox)
Supports: Python 3.4-3.9 (2.7 support has been dropped)
## Overview
`anybadge` can be used to add badge generation to your Python projects,
and also provides a command line interface.
This utility can be used to generate .svg badge images, using configurable
thresholds for coloring the badges based on the badge value. Many badge
generation tools just provide the ability to specify the color of badge.
`anybadge` allows you to specify the label, badge value, and color, but
it also allows you to specify a set of thresholds that can be used to
select a color based on the badge value.
`anybadge` may be useful for companies developing internally, or any time
making calls to external badge services is not possible, or undesirable.
In this situation using `anybadge` will be easier than running your own
internal badge service.
The package can be imported into your python code, or run direct from the
command line.
## Demo
You can find a [repl.it demo here](https://repl.it/@JonGrace_Cox/anybadge-demo).
This will allow you to see what the package can do and play with it to test outputs.
## Basic usage
### Command line
As an example, if you want to produce a pylint badge, you may run `anybadge`
from the command line like this:
```bash
anybadge -l pylint -v 2.22 -f pylint.svg 2=red 4=orange 8=yellow 10=green
```
This would result in a badge like this:
In this example the label is set to "pylint", the value "2.22", and an
output file called "pylint.svg". The thresholds are provided in pairs
of `<value>=color` Values can be integer or floats for ranges, and
string values are also supported.
### Python
Here is the same example implemented in Python code:
```python
import anybadge
# Define thresholds: <2=red, <4=orange <8=yellow <10=green
thresholds = {2: 'red',
4: 'orange',
6: 'yellow',
10: 'green'}
badge = anybadge.Badge('pylint', 2.22, thresholds=thresholds)
badge.write_badge('pylint.svg')
```
## Installation
`anybadge` is available in PyPi at https://pypi.python.org/pypi/anybadge
You can install the latest release of `anybadge` using `pip`:
```bash
pip install anybadge
```
This will install the Python package, and also make `anybadge` available
as a command line utility.
## Getting help
To get help from the command line utility, just run:
```bash
anybadge --help
```
## Command line usage
### Output
Running the utility with the `--file` option will result in the .svg image being
written to file. Without the `--file` option the `.svg` file content will be
written to stdout, so can be redirected to a file.
### Thresholds
Some thresholds have been built in to save time. To use these thresholds you
can simply specify the template name instead of threshold value/color pairs.
```bash
anybadge --value=<VALUE> --file=<FILE> <TEMPLATE-NAME>
```
For example:
```bash
anybadge --value=2.22 --file=pylint.svg pylint
```
### Colors
Anybadge comes with some pre-defined colors, which can be referred to by name. It also
supports the use of custom colors by using the hex representation of the color. Both color
types can be used in the `default_color`, `text_color` and `thresholds` attributes. Color names are
taken from the [Mozilla color keywords list](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/color_keywords).
Here is a Python example showing use of a named color and a custom color.
```python
import anybadge
badge = anybadge.Badge(label='custom color', value='teal', default_color='teal', num_padding_chars=1)
badge = anybadge.Badge(label='custom color', value='teal', default_color='#008080', num_padding_chars=1)
```
Available named colors are:
| Color Name | Hex | Example |
| ------------- | ------- | ------- |
| aliceblue | #F0F8FF |  |
| antiquewhite | #FAEBD7 |  |
| aqua | #00FFFF |  |
| aquamarine | #7FFFD4 |  |
| azure | #F0FFFF |  |
| beige | #F5F5DC |  |
| bisque | #FFE4C4 |  |
| black | #000000 |  |
| blanchedalmond | #FFEBCD | |
| blue | #0000FF |  |
| blueviolet | #8A2BE2 |  |
| bright_red | #FF0000 |  |
| bright_yellow | #FFFF00 | |
| brown | #A52A2A |  |
| burlywood | #DEB887 |  |
| cadetblue | #5F9EA0 |  |
| chartreuse | #7FFF00 |  |
| chocolate | #D2691E |  |
| coral | #FF7F50 |  |
| cornflowerblue | #6495ED | |
| cornsilk | #FFF8DC |  |
| crimson | #DC143C |  |
| darkblue | #00008B |  |
| darkcyan | #008B8B |  |
| darkgoldenrod | #B8860B | |
| darkgray | #A9A9A9 |  |
| darkgreen | #006400 |  |
| darkkhaki | #BDB76B |  |
| darkmagenta | #8B008B |  |
| darkolivegreen | #556B2F | |
| darkorange | #FF8C00 |  |
| darkorchid | #9932CC |  |
| darkred | #8B0000 |  |
| darksalmon | #E9967A |  |
| darkseagreen | #8FBC8F |  |
| darkslateblue | #483D8B | |
| darkslategray | #2F4F4F | |
| darkturquoise | #00CED1 | |
| darkviolet | #9400D3 |  |
| deeppink | #FF1493 |  |
| deepskyblue | #00BFFF |  |
| dimgray | #696969 |  |
| dodgerblue | #1E90FF |  |
| firebrick | #B22222 |  |
| floralwhite | #FFFAF0 |  |
| forestgreen | #228B22 |  |
| fuchsia | #FF00FF |  |
| gainsboro | #DCDCDC |  |
| ghostwhite | #F8F8FF |  |
| gold | #FFD700 |  |
| goldenrod | #DAA520 |  |
| gray | #808080 |  |
| green | #4C1 |  |
| greenyellow | #ADFF2F |  |
| green_2 | #008000 |  |
| honeydew | #F0FFF0 |  |
| hotpink | #FF69B4 |  |
| indianred | #CD5C5C |  |
| indigo | #4B0082 |  |
| ivory | #FFFFF0 |  |
| khaki | #F0E68C |  |
| lavender | #E6E6FA |  |
| lavenderblush | #FFF0F5 | |
| lawngreen | #7CFC00 |  |
| lemonchiffon | #FFFACD |  |
| lightblue | #ADD8E6 |  |
| lightcoral | #F08080 |  |
| lightcyan | #E0FFFF |  |
| lightgoldenrodyellow | #FAFAD2 | |
| lightgray | #D3D3D3 |  |
| lightgreen | #90EE90 |  |
| lightpink | #FFB6C1 |  |
| lightsalmon | #FFA07A |  |
| lightseagreen | #20B2AA | |
| lightskyblue | #87CEFA |  |
| lightslategray | #778899 | |
| lightsteelblue | #B0C4DE | |
| lightyellow | #FFFFE0 |  |
| light_grey | #9F9F9F |  |
| lime | #00FF00 |  |
| limegreen | #32CD32 |  |
| linen | #FAF0E6 |  |
| maroon | #800000 |  |
| mediumaquamarine | #66CDAA | |
| mediumblue | #0000CD |  |
| mediumorchid | #BA55D3 |  |
| mediumpurple | #9370DB |  |
| mediumseagreen | #3CB371 | |
| mediumslateblue | #7B68EE | |
| mediumspringgreen | #00FA9A | |
| mediumturquoise | #48D1CC | |
| mediumvioletred | #C71585 | |
| midnightblue | #191970 |  |
| mintcream | #F5FFFA |  |
| mistyrose | #FFE4E1 |  |
| moccasin | #FFE4B5 |  |
| navajowhite | #FFDEAD |  |
| navy | #000080 |  |
| oldlace | #FDF5E6 |  |
| olive | #808000 |  |
| olivedrab | #6B8E23 |  |
| orange | #FE7D37 |  |
| orangered | #FF4500 |  |
| orange_2 | #FFA500 |  |
| orchid | #DA70D6 |  |
| palegoldenrod | #EEE8AA | |
| palegreen | #98FB98 |  |
| paleturquoise | #AFEEEE | |
| palevioletred | #DB7093 | |
| papayawhip | #FFEFD5 |  |
| peachpuff | #FFDAB9 |  |
| peru | #CD853F |  |
| pink | #FFC0CB |  |
| plum | #DDA0DD |  |
| powderblue | #B0E0E6 |  |
| purple | #800080 |  |
| rebeccapurple | #663399 | |
| red | #E05D44 |  |
| rosybrown | #BC8F8F |  |
| royalblue | #4169E1 |  |
| saddlebrown | #8B4513 |  |
| salmon | #FA8072 |  |
| sandybrown | #F4A460 |  |
| seagreen | #2E8B57 |  |
| seashell | #FFF5EE |  |
| sienna | #A0522D |  |
| silver | #C0C0C0 |  |
| skyblue | #87CEEB |  |
| slateblue | #6A5ACD |  |
| slategray | #708090 |  |
| snow | #FFFAFA |  |
| springgreen | #00FF7F |  |
| steelblue | #4682B4 |  |
| tan | #D2B48C |  |
| teal | #008080 |  |
| thistle | #D8BFD8 |  |
| tomato | #FF6347 |  |
| turquoise | #40E0D0 |  |
| violet | #EE82EE |  |
| wheat | #F5DEB3 |  |
| white | #FFFFFF |  |
| whitesmoke | #F5F5F5 |  |
| yellow | #DFB317 |  |
| yellowgreen | #9ACD32 |  |
| yellow_green | #A4A61D |  |
### Emojis
It is possible to use emoji characters in badge labels and values. Here are some examples:
These files were created by using the **actual** emoji character in the label/value text. For example:
```python
badge = anybadge.Badge(label="Pipeline status", value="😄")
```
There are some caveats worth mentioning:
- The "look" of the emoji is determined by the client (Emoji characters are placed as-is into the SVG file, and are
rendered client-side)
- Rendering may fail in some viewers and developer IDEs (for example, PyCharm does not render emojis in the svg viewer)
- Emojis can have different widths, so the layout may be affected. You can use `num_label_padding_chars` and
`num_value_padding_chars` to fix (see below)
Here are some examples to show how to use padding to fix layout:
| Badge | Code |
| ----- |----------------------------------------------------------------------|
|  | `anybadge.Badge("Pipeline status", "😄")` |
|  | `anybadge.Badge("Pipeline status", "😄", num_value_padding_chars=1)` |
### Semantic version support
Anybadge supports semantic versions for value and threshold keys. This supports color-coded
badges based on version numbering. Here are some examples:
```python
badge = Badge(
label='Version',
value='3.0.0',
thresholds={'3.0.0': 'red', '3.2.0': 'orange', '999.0.0': 'green'},
semver=True
)
```
In the above example the thresholds equate to the following:
* If value is < 3.0.0 then badge will be red.
* If value is < 3.2.0 then badge will be orange.
* If value is < 999.0.0 then badge will be green.
Each threshold entry is used to define the upper bounds of the threshold. If you don't know the
upper bound for your version number threshold you will need to provide an extreme upper bound -
in this example it is `999.0.0`.
### Examples
#### Pylint using template
```bash
anybadge --value=2.22 --file=pylint.svg pylint
```
#### Pylint using arguments
```bash
anybadge -l pylint -v 2.22 -f pylint.svg 2=red 4=orange 8=yellow 10=green
```
#### Coverage using template
```bash
anybadge --value=65 --file=coverage.svg coverage
```
#### Pipeline, using labeled colors
```bash
anybadge --label=pipeline --value=passing --file=pipeline.svg passing=green failing=red
```
#### Badge with fixed color
```bash
anybadge --label=awesomeness --value="110%" --file=awesomeness.svg --color='#97CA00'
```
#### GitLab Scoped style badge
```bash
anybadge --style=gitlab-scoped --label=Project --value=Archimedes --file=gitlab_scoped.svg --color='#c1115d'
```
#### Thresholds based on semantic versions
```bash
anybadge --label=Version --value=2.4.5 --file=version.svg 1.0.0=red 2.4.6=orange 2.9.1=yellow 999.0.0=green
```
#### Importing in your own app
```python
from anybadge import Badge
test1 = Badge(
label,
value,
font_name='DejaVu Sans,Verdana,Geneva,sans-serif',
font_size=11,
num_padding_chars=0.5,
template='<?xml version="1.0" encoding="UTF-8"?>\n<svg xmlns="http://www.w3.org/2000/svg" width="{{ badge width }}" height="20">\n <linearGradient id="b" x2="0" y2="100%">\n <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>\n <stop offset="1" stop-opacity=".1"/>\n </linearGradient>\n <mask id="a">\n <rect width="{{ badge width }}" height="20" rx="3" fill="#fff"/>\n </mask>\n <g mask="url(#a)">\n <path fill="#555" d="M0 0h{{ color split x }}v20H0z"/>\n <path fill="{{ color }}" d="M{{ color split x }} 0h{{ value width }}v20H{{ color split x }}z"/>\n <path fill="url(#b)" d="M0 0h{{ badge width }}v20H0z"/>\n </g>\n <g fill="{{ label text color }}" text-anchor="middle" font-family="{{ font name }}" font-size="{{ font size }}">\n <text x="{{ label anchor shadow }}" y="15" fill="#010101" fill-opacity=".3">{{ label }}</text>\n <text x="{{ label anchor }}" y="14">{{ label }}</text>\n </g>\n <g fill="{{ value text color }}" text-anchor="middle" font-family="{{ font name }}" font-size="{{ font size }}">\n <text x="{{ value anchor shadow }}" y="15" fill="#010101" fill-opacity=".3">{{ value }}</text>\n <text x="{{ value anchor }}" y="14">{{ value }}</text>\n </g>\n</svg>',
value_prefix='',
value_suffix='',
thresholds=None,
default_color='#4c1',
use_max_when_value_exceeds=True,
value_format=None,
text_color='#fff'
)
test1.write_badge('test1.svg')
```
### Command-line options
The command line options can be viewed using `anybadge --help`.
Examples
--------
Here are some usage specific command line examples that may save time on defining
thresholds.
Pylint::
```
anybadge.py --value=2.22 --file=pylint.svg pylint
anybadge.py --label=pylint --value=2.22 --file=pylint.svg 2=red 4=orange 8=yellow 10=green
```
Coverage::
```
anybadge.py --value=65 --file=coverage.svg coverage
anybadge.py --label=coverage --value=65 --suffix='%%' --file=coverage.svg 50=red 60=orange 80=yellow 100=green
```
CI Pipeline::
```
anybadge.py --label=pipeline --value=passing --file=pipeline.svg passing=green failing=red
```
Python usage
============
For Python API details you can use the inbuilt documentation:
```python
from anybadge import badge
help(badge)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/jongracecox/anybadge",
"name": "anybadge",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Jon Grace-Cox",
"author_email": "jongracecox@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a3/f2/9f55245d6f456b661b38650767410f3b51d66a8530f0e0a43909bd475165/anybadge-1.14.0.tar.gz",
"platform": null,
"description": "# anybadge\n\nPython project for generating badges for your projects\n\n[](https://pypi.org/project/anybadge)\n[](https://app.travis-ci.com/github/jongracecox/anybadge)\n[](https://pypistats.org/packages/anybadge)\n[](https://github.com/jongracecox/anybadge/commits/master)\n[](https://github.com/jongracecox/anybadge/blob/master/LICENSE)\n[](https://github.com/jongracecox/anybadge/stargazers)\n[](https://snyk.io/advisor/python/anybadge)\n\n[](https://www.buymeacoffee.com/jongracecox)\n\nSupports: Python 3.4-3.9 (2.7 support has been dropped)\n\n## Overview\n\n`anybadge` can be used to add badge generation to your Python projects,\nand also provides a command line interface.\n\nThis utility can be used to generate .svg badge images, using configurable\nthresholds for coloring the badges based on the badge value. Many badge\ngeneration tools just provide the ability to specify the color of badge.\n`anybadge` allows you to specify the label, badge value, and color, but\nit also allows you to specify a set of thresholds that can be used to\nselect a color based on the badge value.\n\n`anybadge` may be useful for companies developing internally, or any time\nmaking calls to external badge services is not possible, or undesirable.\nIn this situation using `anybadge` will be easier than running your own\ninternal badge service.\n\nThe package can be imported into your python code, or run direct from the\ncommand line.\n\n## Demo\n\nYou can find a [repl.it demo here](https://repl.it/@JonGrace_Cox/anybadge-demo).\nThis will allow you to see what the package can do and play with it to test outputs.\n\n## Basic usage\n\n### Command line\n\nAs an example, if you want to produce a pylint badge, you may run `anybadge`\nfrom the command line like this:\n\n```bash\nanybadge -l pylint -v 2.22 -f pylint.svg 2=red 4=orange 8=yellow 10=green\n```\n\nThis would result in a badge like this:\n\n\n\nIn this example the label is set to \"pylint\", the value \"2.22\", and an\noutput file called \"pylint.svg\". The thresholds are provided in pairs\nof `<value>=color` Values can be integer or floats for ranges, and\nstring values are also supported.\n\n### Python\n\nHere is the same example implemented in Python code:\n\n```python\nimport anybadge\n\n# Define thresholds: <2=red, <4=orange <8=yellow <10=green\nthresholds = {2: 'red',\n 4: 'orange',\n 6: 'yellow',\n 10: 'green'}\n\nbadge = anybadge.Badge('pylint', 2.22, thresholds=thresholds)\n\nbadge.write_badge('pylint.svg')\n```\n\n## Installation\n\n`anybadge` is available in PyPi at https://pypi.python.org/pypi/anybadge\n\nYou can install the latest release of `anybadge` using `pip`:\n\n```bash\npip install anybadge\n```\n\nThis will install the Python package, and also make `anybadge` available\nas a command line utility.\n\n## Getting help\n\nTo get help from the command line utility, just run:\n\n```bash\nanybadge --help\n```\n\n## Command line usage\n\n### Output\n\nRunning the utility with the `--file` option will result in the .svg image being\nwritten to file. Without the `--file` option the `.svg` file content will be\nwritten to stdout, so can be redirected to a file.\n\n### Thresholds\n\nSome thresholds have been built in to save time. To use these thresholds you\ncan simply specify the template name instead of threshold value/color pairs.\n\n```bash\nanybadge --value=<VALUE> --file=<FILE> <TEMPLATE-NAME>\n```\n\nFor example:\n\n```bash\nanybadge --value=2.22 --file=pylint.svg pylint\n```\n\n### Colors\n\nAnybadge comes with some pre-defined colors, which can be referred to by name. It also\nsupports the use of custom colors by using the hex representation of the color. Both color\ntypes can be used in the `default_color`, `text_color` and `thresholds` attributes. Color names are\ntaken from the [Mozilla color keywords list](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/color_keywords).\n\nHere is a Python example showing use of a named color and a custom color.\n\n```python\nimport anybadge\n\nbadge = anybadge.Badge(label='custom color', value='teal', default_color='teal', num_padding_chars=1)\nbadge = anybadge.Badge(label='custom color', value='teal', default_color='#008080', num_padding_chars=1)\n```\n\nAvailable named colors are:\n\n| Color Name | Hex | Example |\n| ------------- | ------- | ------- |\n| aliceblue | #F0F8FF |  |\n| antiquewhite | #FAEBD7 |  |\n| aqua | #00FFFF |  |\n| aquamarine | #7FFFD4 |  |\n| azure | #F0FFFF |  |\n| beige | #F5F5DC |  |\n| bisque | #FFE4C4 |  |\n| black | #000000 |  |\n| blanchedalmond | #FFEBCD | |\n| blue | #0000FF |  |\n| blueviolet | #8A2BE2 |  |\n| bright_red | #FF0000 |  |\n| bright_yellow | #FFFF00 | |\n| brown | #A52A2A |  |\n| burlywood | #DEB887 |  |\n| cadetblue | #5F9EA0 |  |\n| chartreuse | #7FFF00 |  |\n| chocolate | #D2691E |  |\n| coral | #FF7F50 |  |\n| cornflowerblue | #6495ED | |\n| cornsilk | #FFF8DC |  |\n| crimson | #DC143C |  |\n| darkblue | #00008B |  |\n| darkcyan | #008B8B |  |\n| darkgoldenrod | #B8860B | |\n| darkgray | #A9A9A9 |  |\n| darkgreen | #006400 |  |\n| darkkhaki | #BDB76B |  |\n| darkmagenta | #8B008B |  |\n| darkolivegreen | #556B2F | |\n| darkorange | #FF8C00 |  |\n| darkorchid | #9932CC |  |\n| darkred | #8B0000 |  |\n| darksalmon | #E9967A |  |\n| darkseagreen | #8FBC8F |  |\n| darkslateblue | #483D8B | |\n| darkslategray | #2F4F4F | |\n| darkturquoise | #00CED1 | |\n| darkviolet | #9400D3 |  |\n| deeppink | #FF1493 |  |\n| deepskyblue | #00BFFF |  |\n| dimgray | #696969 |  |\n| dodgerblue | #1E90FF |  |\n| firebrick | #B22222 |  |\n| floralwhite | #FFFAF0 |  |\n| forestgreen | #228B22 |  |\n| fuchsia | #FF00FF |  |\n| gainsboro | #DCDCDC |  |\n| ghostwhite | #F8F8FF |  |\n| gold | #FFD700 |  |\n| goldenrod | #DAA520 |  |\n| gray | #808080 |  |\n| green | #4C1 |  |\n| greenyellow | #ADFF2F |  |\n| green_2 | #008000 |  |\n| honeydew | #F0FFF0 |  |\n| hotpink | #FF69B4 |  |\n| indianred | #CD5C5C |  |\n| indigo | #4B0082 |  |\n| ivory | #FFFFF0 |  |\n| khaki | #F0E68C |  |\n| lavender | #E6E6FA |  |\n| lavenderblush | #FFF0F5 | |\n| lawngreen | #7CFC00 |  |\n| lemonchiffon | #FFFACD |  |\n| lightblue | #ADD8E6 |  |\n| lightcoral | #F08080 |  |\n| lightcyan | #E0FFFF |  |\n| lightgoldenrodyellow | #FAFAD2 | |\n| lightgray | #D3D3D3 |  |\n| lightgreen | #90EE90 |  |\n| lightpink | #FFB6C1 |  |\n| lightsalmon | #FFA07A |  |\n| lightseagreen | #20B2AA | |\n| lightskyblue | #87CEFA |  |\n| lightslategray | #778899 | |\n| lightsteelblue | #B0C4DE | |\n| lightyellow | #FFFFE0 |  |\n| light_grey | #9F9F9F |  |\n| lime | #00FF00 |  |\n| limegreen | #32CD32 |  |\n| linen | #FAF0E6 |  |\n| maroon | #800000 |  |\n| mediumaquamarine | #66CDAA | |\n| mediumblue | #0000CD |  |\n| mediumorchid | #BA55D3 |  |\n| mediumpurple | #9370DB |  |\n| mediumseagreen | #3CB371 | |\n| mediumslateblue | #7B68EE | |\n| mediumspringgreen | #00FA9A | |\n| mediumturquoise | #48D1CC | |\n| mediumvioletred | #C71585 | |\n| midnightblue | #191970 |  |\n| mintcream | #F5FFFA |  |\n| mistyrose | #FFE4E1 |  |\n| moccasin | #FFE4B5 |  |\n| navajowhite | #FFDEAD |  |\n| navy | #000080 |  |\n| oldlace | #FDF5E6 |  |\n| olive | #808000 |  |\n| olivedrab | #6B8E23 |  |\n| orange | #FE7D37 |  |\n| orangered | #FF4500 |  |\n| orange_2 | #FFA500 |  |\n| orchid | #DA70D6 |  |\n| palegoldenrod | #EEE8AA | |\n| palegreen | #98FB98 |  |\n| paleturquoise | #AFEEEE | |\n| palevioletred | #DB7093 | |\n| papayawhip | #FFEFD5 |  |\n| peachpuff | #FFDAB9 |  |\n| peru | #CD853F |  |\n| pink | #FFC0CB |  |\n| plum | #DDA0DD |  |\n| powderblue | #B0E0E6 |  |\n| purple | #800080 |  |\n| rebeccapurple | #663399 | |\n| red | #E05D44 |  |\n| rosybrown | #BC8F8F |  |\n| royalblue | #4169E1 |  |\n| saddlebrown | #8B4513 |  |\n| salmon | #FA8072 |  |\n| sandybrown | #F4A460 |  |\n| seagreen | #2E8B57 |  |\n| seashell | #FFF5EE |  |\n| sienna | #A0522D |  |\n| silver | #C0C0C0 |  |\n| skyblue | #87CEEB |  |\n| slateblue | #6A5ACD |  |\n| slategray | #708090 |  |\n| snow | #FFFAFA |  |\n| springgreen | #00FF7F |  |\n| steelblue | #4682B4 |  |\n| tan | #D2B48C |  |\n| teal | #008080 |  |\n| thistle | #D8BFD8 |  |\n| tomato | #FF6347 |  |\n| turquoise | #40E0D0 |  |\n| violet | #EE82EE |  |\n| wheat | #F5DEB3 |  |\n| white | #FFFFFF |  |\n| whitesmoke | #F5F5F5 |  |\n| yellow | #DFB317 |  |\n| yellowgreen | #9ACD32 |  |\n| yellow_green | #A4A61D |  |\n\n### Emojis\n\nIt is possible to use emoji characters in badge labels and values. Here are some examples:\n\n\n\n\n\n\nThese files were created by using the **actual** emoji character in the label/value text. For example:\n\n```python\nbadge = anybadge.Badge(label=\"Pipeline status\", value=\"\ud83d\ude04\")\n```\n\nThere are some caveats worth mentioning:\n- The \"look\" of the emoji is determined by the client (Emoji characters are placed as-is into the SVG file, and are\n rendered client-side)\n- Rendering may fail in some viewers and developer IDEs (for example, PyCharm does not render emojis in the svg viewer)\n- Emojis can have different widths, so the layout may be affected. You can use `num_label_padding_chars` and\n `num_value_padding_chars` to fix (see below)\n\nHere are some examples to show how to use padding to fix layout:\n\n| Badge | Code |\n| ----- |----------------------------------------------------------------------|\n|  | `anybadge.Badge(\"Pipeline status\", \"\ud83d\ude04\")` |\n|  | `anybadge.Badge(\"Pipeline status\", \"\ud83d\ude04\", num_value_padding_chars=1)` |\n\n### Semantic version support\n\nAnybadge supports semantic versions for value and threshold keys. This supports color-coded\nbadges based on version numbering. Here are some examples:\n\n```python\nbadge = Badge(\n label='Version',\n value='3.0.0',\n thresholds={'3.0.0': 'red', '3.2.0': 'orange', '999.0.0': 'green'},\n semver=True\n)\n```\n\nIn the above example the thresholds equate to the following:\n\n* If value is < 3.0.0 then badge will be red.\n* If value is < 3.2.0 then badge will be orange.\n* If value is < 999.0.0 then badge will be green.\n\nEach threshold entry is used to define the upper bounds of the threshold. If you don't know the\nupper bound for your version number threshold you will need to provide an extreme upper bound -\nin this example it is `999.0.0`.\n\n### Examples\n\n#### Pylint using template\n```bash\nanybadge --value=2.22 --file=pylint.svg pylint\n```\n\n\n#### Pylint using arguments\n```bash\nanybadge -l pylint -v 2.22 -f pylint.svg 2=red 4=orange 8=yellow 10=green\n```\n\n\n#### Coverage using template\n```bash\nanybadge --value=65 --file=coverage.svg coverage\n```\n\n\n#### Pipeline, using labeled colors\n```bash\nanybadge --label=pipeline --value=passing --file=pipeline.svg passing=green failing=red\n```\n\n\n#### Badge with fixed color\n```bash\nanybadge --label=awesomeness --value=\"110%\" --file=awesomeness.svg --color='#97CA00'\n```\n\n\n#### GitLab Scoped style badge\n```bash\nanybadge --style=gitlab-scoped --label=Project --value=Archimedes --file=gitlab_scoped.svg --color='#c1115d'\n```\n\n\n#### Thresholds based on semantic versions\n```bash\nanybadge --label=Version --value=2.4.5 --file=version.svg 1.0.0=red 2.4.6=orange 2.9.1=yellow 999.0.0=green\n```\n\n#### Importing in your own app\n```python\nfrom anybadge import Badge\n\ntest1 = Badge(\n label,\n value,\n font_name='DejaVu Sans,Verdana,Geneva,sans-serif',\n font_size=11,\n num_padding_chars=0.5,\n template='<?xml version=\"1.0\" encoding=\"UTF-8\"?>\\n<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"{{ badge width }}\" height=\"20\">\\n <linearGradient id=\"b\" x2=\"0\" y2=\"100%\">\\n <stop offset=\"0\" stop-color=\"#bbb\" stop-opacity=\".1\"/>\\n <stop offset=\"1\" stop-opacity=\".1\"/>\\n </linearGradient>\\n <mask id=\"a\">\\n <rect width=\"{{ badge width }}\" height=\"20\" rx=\"3\" fill=\"#fff\"/>\\n </mask>\\n <g mask=\"url(#a)\">\\n <path fill=\"#555\" d=\"M0 0h{{ color split x }}v20H0z\"/>\\n <path fill=\"{{ color }}\" d=\"M{{ color split x }} 0h{{ value width }}v20H{{ color split x }}z\"/>\\n <path fill=\"url(#b)\" d=\"M0 0h{{ badge width }}v20H0z\"/>\\n </g>\\n <g fill=\"{{ label text color }}\" text-anchor=\"middle\" font-family=\"{{ font name }}\" font-size=\"{{ font size }}\">\\n <text x=\"{{ label anchor shadow }}\" y=\"15\" fill=\"#010101\" fill-opacity=\".3\">{{ label }}</text>\\n <text x=\"{{ label anchor }}\" y=\"14\">{{ label }}</text>\\n </g>\\n <g fill=\"{{ value text color }}\" text-anchor=\"middle\" font-family=\"{{ font name }}\" font-size=\"{{ font size }}\">\\n <text x=\"{{ value anchor shadow }}\" y=\"15\" fill=\"#010101\" fill-opacity=\".3\">{{ value }}</text>\\n <text x=\"{{ value anchor }}\" y=\"14\">{{ value }}</text>\\n </g>\\n</svg>',\n value_prefix='',\n value_suffix='',\n thresholds=None,\n default_color='#4c1',\n use_max_when_value_exceeds=True,\n value_format=None,\n text_color='#fff'\n)\n\ntest1.write_badge('test1.svg')\n```\n\n### Command-line options\n\nThe command line options can be viewed using `anybadge --help`.\n\nExamples\n--------\n\nHere are some usage specific command line examples that may save time on defining\nthresholds.\n\nPylint::\n\n```\nanybadge.py --value=2.22 --file=pylint.svg pylint\nanybadge.py --label=pylint --value=2.22 --file=pylint.svg 2=red 4=orange 8=yellow 10=green\n```\n\nCoverage::\n\n```\nanybadge.py --value=65 --file=coverage.svg coverage\nanybadge.py --label=coverage --value=65 --suffix='%%' --file=coverage.svg 50=red 60=orange 80=yellow 100=green\n```\n\nCI Pipeline::\n\n```\nanybadge.py --label=pipeline --value=passing --file=pipeline.svg passing=green failing=red\n```\n\nPython usage\n============\n\nFor Python API details you can use the inbuilt documentation:\n\n```python\nfrom anybadge import badge\nhelp(badge)\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Simple, flexible badge generator for project badges.",
"version": "1.14.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8c7cb73d5c07ca0389088caf550f24d1",
"sha256": "8711a7f7f45317c62a460f14084f005ba665cbebdf2a94e7df53bc3ab35df4c9"
},
"downloads": -1,
"filename": "anybadge-1.14.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8c7cb73d5c07ca0389088caf550f24d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 27258,
"upload_time": "2022-08-24T22:43:34",
"upload_time_iso_8601": "2022-08-24T22:43:34.358189Z",
"url": "https://files.pythonhosted.org/packages/f7/44/71df611ee7e19c852caa829bac653662dafec909dbe3e1b99b5ad419cefc/anybadge-1.14.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "528f54374bebbbac96fc13042be870e7",
"sha256": "47f06e0a6320d3e5eac55c712dc0bab71b9ed85353c591d448653c5a0740783f"
},
"downloads": -1,
"filename": "anybadge-1.14.0.tar.gz",
"has_sig": false,
"md5_digest": "528f54374bebbbac96fc13042be870e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 29606,
"upload_time": "2022-08-24T22:43:36",
"upload_time_iso_8601": "2022-08-24T22:43:36.187484Z",
"url": "https://files.pythonhosted.org/packages/a3/f2/9f55245d6f456b661b38650767410f3b51d66a8530f0e0a43909bd475165/anybadge-1.14.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-08-24 22:43:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jongracecox",
"github_project": "anybadge",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "anybadge"
}
JSON
