Lerking/anybadge
1
0
Fork 0
mirror of https://github.com/jongracecox/anybadge.git synced 2026-01-04 19:32:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add ability to choose text color (#6)

Browse Source
This commit is contained in:
Jon Grace-Cox
2017-09-27 21:12:41 -04:00
parent 43b42bc2d8
commit 2925295a0a
4 changed files with 240 additions and 217 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -1,5 +1,6 @@
# 0.2.0 # 0.2.0
- Removed bright green color (including pylint and coverage defaults) (#7) - Removed bright green color (including pylint and coverage defaults) (#7)
- Add ability to choose text color (#6)
# 0.1.0 # 0.1.0
- Initial release. - Initial release.

429
README.rst
View File

@@ -49,10 +49,10 @@ Here is the same example implemented in Python code::
import anybadge import anybadge
# Define thresholds: <2=red, <4=orange <8=yellow <10=green # Define thresholds: <2=red, <4=orange <8=yellow <10=green
thresholds = {thresholds={2: 'red', thresholds = {2: 'red',
4: 'orange', 4: 'orange',
6: 'yellow', 6: 'yellow',
10: 'green',}) 10: 'green'}
badge = anybadge.Badge('pylint', 2.22, thresholds=thresholds) badge = anybadge.Badge('pylint', 2.22, thresholds=thresholds)
@@ -91,39 +91,43 @@ Options
------- -------
These are the command line options:: These are the command line options::
positional arguments: positional arguments:
args Pairs of <upper>=<color>. For example 2=red 4=orange args Pairs of <upper>=<color>. For example 2=red 4=orange
8=yellow 10=green. Read this as "Less 6=yellow 8=good. Read this as "Less than 2 = red, less
than 2 = red, less than 4 = orange...". than 4 = orange...".
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
-l LABEL, --label LABEL -l LABEL, --label LABEL
The badge label. The badge label.
-v VALUE, --value VALUE -v VALUE, --value VALUE
The badge value. The badge value.
-m VALUE_FORMAT, --value-format VALUE_FORMAT -m VALUE_FORMAT, --value-format VALUE_FORMAT
Formatting string for value (e.g. "%.2f" for 2dp Formatting string for value (e.g. "%.2f" for 2dp
floats) floats)
-c COLOR, --color COLOR -c COLOR, --color COLOR
For fixed color badges use --colorto specify the badge For fixed color badges use --colorto specify the badge
color. color.
-p PREFIX, --prefix PREFIX -p PREFIX, --prefix PREFIX
Optional prefix for value. Optional prefix for value.
-s SUFFIX, --suffix SUFFIX -s SUFFIX, --suffix SUFFIX
Optional suffix for value. Optional suffix for value.
-d PADDING, --padding PADDING -d PADDING, --padding PADDING
Number of characters to pad on either side of the Number of characters to pad on either side of the
badge text. badge text.
-n FONT, --font FONT "DejaVu Sans,Verdana,Geneva,sans-serif" -n FONT, --font FONT "DejaVu Sans,Verdana,Geneva,sans-serif"
-z FONT_SIZE, --font-size FONT_SIZE -z FONT_SIZE, --font-size FONT_SIZE
Font size. Font size.
-t TEMPLATE, --template TEMPLATE -t TEMPLATE, --template TEMPLATE
Location of alternative template .svg file. Location of alternative template .svg file.
-u, --use-max Use the maximum threshold color when the value exceeds -u, --use-max Use the maximum threshold color when the value exceeds
the maximum threshold. the maximum threshold.
-f FILE, --file FILE Output file location. -f FILE, --file FILE Output file location.
-o, --overwrite Overwrite output file if it already exists. -o, --overwrite Overwrite output file if it already exists.
-r TEXT_COLOR, --text-color TEXT_COLOR
Text color. Single value affects both labeland value
colors. A comma separated pair affects label and value
text respectively.
Examples Examples
-------- --------
@@ -149,186 +153,187 @@ Python usage
============ ============
Here is the output of ``help(anybadge)``:: Here is the output of ``help(anybadge)``::
Help on module anybadge: Help on module anybadge:
NAME NAME
anybadge - anybadge anybadge - anybadge
FILE FILE
anybadge.py /home/jon/Git/anybadge/anybadge.py
DESCRIPTION DESCRIPTION
A Python module for generating badges for your projects, with a focus on A Python module for generating badges for your projects, with a focus on
simplicity and flexibility. simplicity and flexibility.
CLASSES CLASSES
__builtin__.object __builtin__.object
Badge Badge
class Badge(__builtin__.object)
| Badge class used to generate badges.
|
| Examples:
|
| Create a simple green badge:
|
| >>> badge = Badge('label', 123, default_color='green')
|
| Write a badge to file, overwriting any existing file:
|
| >>> badge = Badge('label', 123, default_color='green')
| >>> badge.write_badge('demo.svg', overwrite=True)
|
| Here are a number of examples showing thresholds, since there
| are certain situations that may not be obvious:
|
| >>> badge = Badge('pipeline', 'passing', thresholds={'passing': 'green', 'failing': 'red'})
| >>> badge.badge_color
| 'green'
|
| 2.32 is not <2
| 2.32 is < 4, so 2.32 yields orange
| >>> badge = Badge('pylint', 2.32, thresholds={2: 'red',
| ... 4: 'orange',
| ... 8: 'yellow',
| ... 10: 'green'})
| >>> badge.badge_color
| 'orange'
|
| 6 is not <6
| 6 is < 8, so 6 yields green
| >>> badge = Badge('pylint', 6, thresholds={2: 'red',
| ... 4: 'orange',
| ... 8: 'yellow',
| ... 10: 'green'})
| >>> badge.badge_color
| 'green'
|
| 11 is not <10, but use_max_when_value_exceeds defaults to
| True, so 11 yields green
| >>> badge = Badge('pylint', 11, thresholds={2: 'red',
| ... 4: 'orange',
| ... 8: 'yellow',
| ... 10: 'green'})
| >>> badge.badge_color
| 'green'
|
| 11 is not <10, and use_max_when_value_exceeds is set to
| False, so 11 yields the default color '#a4a61d'
| >>> badge = Badge('pylint', 11, use_max_when_value_exceeds=False,
| ... thresholds={2: 'red', 4: 'orange', 8: 'yellow',
| ... 10: 'green'})
| >>> badge.badge_color
| '#a4a61d'
|
| Methods defined here:
|
| __init__(self, 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 xmln...hor }}" y="14">{{ value }}</text>\n </g>\n</svg>', value_prefix='', value_suffix='', thresholds=None, default_color='#a4a61d', use_max_when_value_exceeds=True, value_format=None)
| Constructor for Badge class.
|
| get_text_width(self, text)
| Return the width of text.
|
| This implementation assumes a fixed font of:
|
| font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"
| >>> badge = Badge('x', 1, font_name='DejaVu Sans,Verdana,Geneva,sans-serif', font_size=11)
| >>> badge.get_text_width('pylint')
| 42
|
| write_badge(self, file_path, overwrite=False)
| Write badge to file.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| get_font_width(font_name, font_size)
| Return the width multiplier for a font.
|
| >>> Badge.get_font_width('DejaVu Sans,Verdana,Geneva,sans-serif', 11)
| 7
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
|
| badge_color
| Find the badge color based on the thresholds.
|
| badge_color_code
| Return the color code for the badge.
|
| badge_svg_text
| The badge SVG text.
|
| badge_width
| The total width of badge.
|
| >>> badge = Badge('pylint', '5', font_name='DejaVu Sans,Verdana,Geneva,sans-serif',
| ... font_size=11)
| >>> badge.badge_width
| 91
|
| color_split_position
| The SVG x position where the color split should occur.
|
| font_width
| Return the badge font width.
|
| label_anchor
| The SVG x position of the middle anchor for the label text.
|
| label_anchor_shadow
| The SVG x position of the label shadow anchor.
|
| label_width
| The SVG width of the label text.
|
| value_anchor
| The SVG x position of the middle anchor for the value text.
|
| value_anchor_shadow
| The SVG x position of the value shadow anchor.
|
| value_is_float
| Identify whether the value text is a float.
|
| value_is_int
| Identify whether the value text is an int.
|
| value_type
| The Python type associated with the value.
|
| value_width
| The SVG width of the value text.
FUNCTIONS class Badge(__builtin__.object)
main() | Badge class used to generate badges.
Generate a badge based on command line arguments. |
| Examples:
parse_args() |
Parse the command line arguments. | Create a simple green badge:
|
| >>> badge = Badge('label', 123, default_color='green')
|
| Write a badge to file, overwriting any existing file:
|
| >>> badge = Badge('label', 123, default_color='green')
| >>> badge.write_badge('demo.svg', overwrite=True)
|
| Here are a number of examples showing thresholds, since there
| are certain situations that may not be obvious:
|
| >>> badge = Badge('pipeline', 'passing', thresholds={'passing': 'green', 'failing': 'red'})
| >>> badge.badge_color
| 'green'
|
| 2.32 is not <2
| 2.32 is < 4, so 2.32 yields orange
| >>> badge = Badge('pylint', 2.32, thresholds={2: 'red',
| ... 4: 'orange',
| ... 8: 'yellow',
| ... 10: 'green'})
| >>> badge.badge_color
| 'orange'
|
| 8 is not <8
| 8 is <4, so 8 yields orange
| >>> badge = Badge('pylint', 6, thresholds={2: 'red',
| ... 4: 'orange',
| ... 8: 'yellow',
| ... 10: 'green'})
| >>> badge.badge_color
| 'green'
|
| 10 is not <8, but use_max_when_value_exceeds defaults to
| True, so 10 yields green
| >>> badge = Badge('pylint', 11, thresholds={2: 'red',
| ... 4: 'orange',
| ... 8: 'yellow',
| ... 10: 'green'})
| >>> badge.badge_color
| 'green'
|
| 11 is not <10, and use_max_when_value_exceeds is set to
| False, so 11 yields the default color '#a4a61d'
| >>> badge = Badge('pylint', 11, use_max_when_value_exceeds=False,
| ... thresholds={2: 'red', 4: 'orange', 8: 'yellow',
| ... 10: 'green'})
| >>> badge.badge_color
| '#a4a61d'
|
| Methods defined here:
|
| __init__(self, 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 xmln...hor }}" y="14">{{ value }}</text>\n </g>\n</svg>', value_prefix='', value_suffix='', thresholds=None, default_color='#a4a61d', use_max_when_value_exceeds=True, value_format=None, text_color='#fff')
| Constructor for Badge class.
|
| get_text_width(self, text)
| Return the width of text.
|
| This implementation assumes a fixed font of:
|
| font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11"
| >>> badge = Badge('x', 1, font_name='DejaVu Sans,Verdana,Geneva,sans-serif', font_size=11)
| >>> badge.get_text_width('pylint')
| 42
|
| write_badge(self, file_path, overwrite=False)
| Write badge to file.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| get_font_width(font_name, font_size)
| Return the width multiplier for a font.
|
| >>> Badge.get_font_width('DejaVu Sans,Verdana,Geneva,sans-serif', 11)
| 7
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
|
| badge_color
| Find the badge color based on the thresholds.
|
| badge_color_code
| Return the color code for the badge.
|
| badge_svg_text
| The badge SVG text.
|
| badge_width
| The total width of badge.
|
| >>> badge = Badge('pylint', '5', font_name='DejaVu Sans,Verdana,Geneva,sans-serif',
| ... font_size=11)
| >>> badge.badge_width
| 91
|
| color_split_position
| The SVG x position where the color split should occur.
|
| font_width
| Return the badge font width.
|
| label_anchor
| The SVG x position of the middle anchor for the label text.
|
| label_anchor_shadow
| The SVG x position of the label shadow anchor.
|
| label_width
| The SVG width of the label text.
|
| value_anchor
| The SVG x position of the middle anchor for the value text.
|
| value_anchor_shadow
| The SVG x position of the value shadow anchor.
|
| value_is_float
| Identify whether the value text is a float.
|
| value_is_int
| Identify whether the value text is an int.
|
| value_type
| The Python type associated with the value.
|
| value_width
| The SVG width of the value text.
DATA FUNCTIONS
BADGE_TEMPLATES = {'coverage': {'label': 'coverage', 'suffix': '%', 't... main()
COLORS = {'green': '#97CA00', 'lightgrey': '#9f... Generate a badge based on command line arguments.
DEFAULT_COLOR = '#a4a61d'
DEFAULT_FONT = 'DejaVu Sans,Verdana,Geneva,sans-serif'
DEFAULT_FONT_SIZE = 11
FONT_WIDTHS = {'DejaVu Sans,Verdana,Geneva,sans-serif': {11: 7}}
NUM_PADDING_CHARS = 0.5
TEMPLATE_SVG = '<?xml version="1.0" encoding="UTF-8"?>\n<svg xmln...ho...
__summary__ = 'A simple, flexible badge generator.'
__title__ = 'anybadge'
__uri__ = 'https://github.com/jongracecox/anybadge'
__version__ = '0.1.0.dev1'
__version_info__ = ('0', '1', '0', 'dev1')
version = '0.1.0.dev1'
VERSION parse_args()
0.1.0.dev1 Parse the command line arguments.
DATA
BADGE_TEMPLATES = {'coverage': {'label': 'coverage', 'suffix': '%', 't...
COLORS = {'green': '#97CA00', 'lightgrey': '#9f9f9f', 'orange': '#fe7d...
DEFAULT_COLOR = '#a4a61d'
DEFAULT_FONT = 'DejaVu Sans,Verdana,Geneva,sans-serif'
DEFAULT_FONT_SIZE = 11
DEFAULT_TEXT_COLOR = '#fff'
FONT_WIDTHS = {'DejaVu Sans,Verdana,Geneva,sans-serif': {11: 7}}
NUM_PADDING_CHARS = 0.5
TEMPLATE_SVG = '<?xml version="1.0" encoding="UTF-8"?>\n<svg xmln...ho...
__summary__ = 'A simple, flexible badge generator.'
__title__ = 'anybadge'
__uri__ = 'https://github.com/jongracecox/anybadge'
__version__ = '0.2.0.dev1'
__version_info__ = ('0', '2', '0', 'dev1')
version = '0.2.0.dev1'
VERSION
0.2.0.dev1

25
anybadge.py
View File

@@ -9,7 +9,7 @@ import os
import re import re
# Package information # Package information
version = __version__ = "0.2.0.dev1" version = __version__ = "0.1.0.dev2"
__version_info__ = tuple(re.split('[.-]', __version__)) __version_info__ = tuple(re.split('[.-]', __version__))
__title__ = "anybadge" __title__ = "anybadge"
__summary__ = "A simple, flexible badge generator." __summary__ = "A simple, flexible badge generator."
@@ -21,6 +21,7 @@ DEFAULT_FONT = 'DejaVu Sans,Verdana,Geneva,sans-serif'
DEFAULT_FONT_SIZE = 11 DEFAULT_FONT_SIZE = 11
NUM_PADDING_CHARS = 0.5 NUM_PADDING_CHARS = 0.5
DEFAULT_COLOR = '#a4a61d' DEFAULT_COLOR = '#a4a61d'
DEFAULT_TEXT_COLOR = '#fff'
# Dictionary for looking up approx pixel widths of # Dictionary for looking up approx pixel widths of
# supported fonts and font sizes. # supported fonts and font sizes.
@@ -57,9 +58,11 @@ TEMPLATE_SVG = """<?xml version="1.0" encoding="UTF-8"?>
<path fill="{{ color }}" d="M{{ color split x }} 0h{{ value width }}v20H{{ color split x }}z"/> <path fill="{{ color }}" d="M{{ color split x }} 0h{{ value width }}v20H{{ color split x }}z"/>
<path fill="url(#b)" d="M0 0h{{ badge width }}v20H0z"/> <path fill="url(#b)" d="M0 0h{{ badge width }}v20H0z"/>
</g> </g>
<g fill="#fff" text-anchor="middle" font-family="{{ font name }}" font-size="{{ font size }}"> <g fill="{{ label text color }}" text-anchor="middle" font-family="{{ font name }}" font-size="{{ font size }}">
<text x="{{ label anchor shadow }}" y="15" fill="#010101" fill-opacity=".3">{{ label }}</text> <text x="{{ label anchor shadow }}" y="15" fill="#010101" fill-opacity=".3">{{ label }}</text>
<text x="{{ label anchor }}" y="14">{{ label }}</text> <text x="{{ label anchor }}" y="14">{{ label }}</text>
</g>
<g fill="{{ value text color }}" text-anchor="middle" font-family="{{ font name }}" font-size="{{ font size }}">
<text x="{{ value anchor shadow }}" y="15" fill="#010101" fill-opacity=".3">{{ value }}</text> <text x="{{ value anchor shadow }}" y="15" fill="#010101" fill-opacity=".3">{{ value }}</text>
<text x="{{ value anchor }}" y="14">{{ value }}</text> <text x="{{ value anchor }}" y="14">{{ value }}</text>
</g> </g>
@@ -141,7 +144,7 @@ class Badge(object):
def __init__(self, label, value, font_name=DEFAULT_FONT, font_size=DEFAULT_FONT_SIZE, def __init__(self, label, value, font_name=DEFAULT_FONT, font_size=DEFAULT_FONT_SIZE,
num_padding_chars=NUM_PADDING_CHARS, template=TEMPLATE_SVG, num_padding_chars=NUM_PADDING_CHARS, template=TEMPLATE_SVG,
value_prefix='', value_suffix='', thresholds=None, default_color=DEFAULT_COLOR, value_prefix='', value_suffix='', thresholds=None, default_color=DEFAULT_COLOR,
use_max_when_value_exceeds=True, value_format=None): use_max_when_value_exceeds=True, value_format=None, text_color=DEFAULT_TEXT_COLOR):
"""Constructor for Badge class.""" """Constructor for Badge class."""
self.label = label self.label = label
self.value = value self.value = value
@@ -156,6 +159,14 @@ class Badge(object):
self.template = template self.template = template
self.thresholds = thresholds self.thresholds = thresholds
self.default_color = default_color self.default_color = default_color
# text_color can be passed as a single value or a pair of comma delimited values
text_colors = text_color.split(',')
self.label_text_color = text_colors[0]
self.value_text_color = text_colors[0]
if len(text_colors) > 1:
self.value_text_color = text_colors[1]
self.use_max_when_value_exceeds = use_max_when_value_exceeds self.use_max_when_value_exceeds = use_max_when_value_exceeds
@property @property
@@ -263,6 +274,8 @@ class Badge(object):
.replace('{{ value anchor }}', str(self.value_anchor)) \ .replace('{{ value anchor }}', str(self.value_anchor)) \
.replace('{{ value anchor shadow }}', str(self.value_anchor_shadow)) \ .replace('{{ value anchor shadow }}', str(self.value_anchor_shadow)) \
.replace('{{ color }}', self.badge_color_code) \ .replace('{{ color }}', self.badge_color_code) \
.replace('{{ label text color }}', self.label_text_color) \
.replace('{{ value text color }}', self.value_text_color) \
.replace('{{ color split x }}', str(self.color_split_position)) \ .replace('{{ color split x }}', str(self.color_split_position)) \
.replace('{{ value width }}', str(self.badge_width - self.color_split_position)) .replace('{{ value width }}', str(self.badge_width - self.color_split_position))
@@ -414,6 +427,10 @@ examples:
parser.add_argument('-f', '--file', type=str, help='Output file location.') parser.add_argument('-f', '--file', type=str, help='Output file location.')
parser.add_argument('-o', '--overwrite', action='store_true', parser.add_argument('-o', '--overwrite', action='store_true',
help='Overwrite output file if it already exists.') help='Overwrite output file if it already exists.')
parser.add_argument('-r', '--text-color', type=str, help='Text color. Single value affects both label'
'and value colors. A comma separated pair '
'affects label and value text respectively.',
default=DEFAULT_TEXT_COLOR)
parser.add_argument('args', nargs=argparse.REMAINDER, help='Pairs of <upper>=<color>. ' parser.add_argument('args', nargs=argparse.REMAINDER, help='Pairs of <upper>=<color>. '
'For example 2=red 4=orange 6=yellow 8=good. ' 'For example 2=red 4=orange 6=yellow 8=good. '
'Read this as "Less than 2 = red, less than 4 = orange...".') 'Read this as "Less than 2 = red, less than 4 = orange...".')
@@ -452,7 +469,7 @@ def main():
default_color=args.color, num_padding_chars=args.padding, font_name=args.font, default_color=args.color, num_padding_chars=args.padding, font_name=args.font,
font_size=args.font_size, template=args.template, font_size=args.font_size, template=args.template,
use_max_when_value_exceeds=args.use_max, thresholds=threshold_dict, use_max_when_value_exceeds=args.use_max, thresholds=threshold_dict,
value_format=args.value_format) value_format=args.value_format, text_color=args.text_color)
if args.file: if args.file:
# Write badge SVG to file # Write badge SVG to file

2
test.py
View File

@@ -10,6 +10,6 @@ if __name__ == '__main__':
thresholds={2: 'red', 4: 'orange', 6: 'green', 8: 'brightgreen'} thresholds={2: 'red', 4: 'orange', 6: 'green', 8: 'brightgreen'}
badge = anybadge.Badge('test', '2.22', value_suffix='%', badge = anybadge.Badge('test', '2.22', value_suffix='%',
thresholds=thresholds) thresholds=thresholds, text_color='#010101,#101010')
print(badge.badge_svg_text) print(badge.badge_svg_text)