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

Added changelog and extended README.md. (#4)

Browse Source
This commit is contained in:
Jon Grace-Cox
2017-09-12 19:26:38 -04:00
parent a5ff11669d
commit 311dee665d
2 changed files with 222 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md Normal file
View File

@@ -0,0 +1,2 @@
# 0.1.0
- Initial release.

224
README.md
View File

@@ -11,10 +11,14 @@ This utility can be used to generate .svg badge images, using configurable
thresholds for coloring the badges based on the badge value. Many badge thresholds for coloring the badges based on the badge value. Many badge
generation tools just provide the ability to specify the color of 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 `anybadge` allows you to specify the label, badge value, and color, but
is also allows you to specify a set of thresholds that can be used to it also allows you to specify a set of thresholds that can be used to
select a color based on the badge value. select a color based on the badge value.
The package can be imported into your python code, or run direct from the
command line.
# Basic usage # Basic usage
## Command line
As an example, if you want to produce a pylint badge, you may run `anybadge` As an example, if you want to produce a pylint badge, you may run `anybadge`
from the command line like this: from the command line like this:
@@ -27,6 +31,24 @@ output file called "pylint.svg". The thresholds are provided in pairs
of `<value>=color`. Values can be integer or floats for ranges, and of `<value>=color`. Values can be integer or floats for ranges, and
string values are also supported. string values are also supported.
## Python
Here is the same example implemented in Python code:
```python
import anybadge
# Define thresholds: <2 = red, <4=orange <6=yello <8=green <10=brightgreen
thresholds = {thresholds={2: 'red',
4: 'orange',
6: 'yellow',
8: 'green',
10: 'brightgreen'})
badge = anybadge.Badge('pylint', 2.22, thresholds=thresholds)
badge.write_badge('pylint.svg')
```
# Installation # Installation
You can install the latest release of `anybadge` using `pip`: You can install the latest release of `anybadge` using `pip`:
@@ -44,7 +66,7 @@ To get help from the command line utility, just run:
anybadge --help anybadge --help
``` ```
# Usage # Command line usage
## Output ## Output
Running the utility with the `--file` option will result in the .svg image being Running the utility with the `--file` option will result in the .svg image being
@@ -55,7 +77,8 @@ written to stdout, so can be redirected to a file.
Some thresholds have been built in to save time. To use these thresholds you 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. can simply specify the template name instead of threshold value/color pairs.
## Command line options ## Options
These are the command line options:
``` ```
positional arguments: positional arguments:
@@ -95,7 +118,7 @@ optional arguments:
## Examples ## Examples
Here are some usage specific examples that may save time on defining Here are some usage specific command line examples that may save time on defining
thresholds. thresholds.
### Pylint ### Pylint
@@ -123,3 +146,196 @@ anybadge.py --label=coverage --value=65 --suffix='%%' --file=coverage.svg 50=red
``` ```
anybadge.py --label=pipeline --value=passing --file=pipeline.svg passing=green failing=red anybadge.py --label=pipeline --value=passing --file=pipeline.svg passing=green failing=red
``` ```
# Python usage
Here is the output of `help(anybadge)`:
```
Help on module anybadge:
NAME
anybadge - anybadge
FILE
anybadge.py
DESCRIPTION
A Python module for generating badges for your projects, with a focus on
simplicity and flexibility.
CLASSES
__builtin__.object
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',
| ... 6: 'yellow',
| ... 8: 'green',
| ... 10: 'brightgreen'})
| >>> badge.badge_color
| 'orange'
|
| 6 is not <6
| 6 is < 8, so 6 yields green
| >>> badge = Badge('pylint', 6, thresholds={2: 'red',
| ... 4: 'orange',
| ... 6: 'yellow',
| ... 8: 'green',
| ... 10: 'brightgreen'})
| >>> badge.badge_color
| 'green'
|
| 11 is not <10, but use_max_when_value_exceeds defaults to
| True, so 11 yields brightgreen
| >>> badge = Badge('pylint', 11, thresholds={2: 'red',
| ... 4: 'orange',
| ... 6: 'yellow',
| ... 8: 'green',
| ... 10: 'brightgreen'})
| >>> badge.badge_color
| 'brightgreen'
|
| 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', 6: 'yellow',
| ... 8: 'green', 10: 'brightgreen'})
| >>> 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
main()
Generate a badge based on command line arguments.
parse_args()
Parse the command line arguments.
DATA
BADGE_TEMPLATES = {'coverage': {'label': 'coverage', 'suffix': '%', 't...
COLORS = {'brightgreen': '#4c1', 'green': '#97CA00', 'lightgrey': '#9f...
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
0.1.0.dev1
```