badgepy 1.0.0__py3-none-any.whl

badgepy/__init__.py

@@ -0,0 +1,252 @@
+# Copyright 2018 The pybadge Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Creates a github-style badge as a SVG image.
+
+This package seeks to generate semantically-identical output to the JavaScript
+gh-badges library
+(https://github.com/badges/shields/blob/master/doc/gh-badges.md)
+
+>>> badge(left_text='coverage', right_text='23%', right_color='red')
+'<svg...</svg>'
+>>> badge(left_text='build', right_text='green', right_color='green',
+...       whole_link="http://www.example.com/")
+'<svg...</svg>'
+>>> # base64-encoded PNG image
+>>> image_data = 'iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAIAAAD91JpzAAAAD0lEQVQI12P4zwAD/xkYAA/+Af8iHnLUAAAAAElFTkSuQmCC'
+>>> badge(left_text='build', right_text='green', right_color='green',
+...       logo="data:image/png;base64," + image_data)
+'<svg...</svg>'
+"""
+
+import base64
+import mimetypes
+from typing import Optional
+import urllib.parse
+from xml.dom import minidom
+
+import filetype
+import jinja2
+import requests
+
+from badgepy import text_measurer
+from badgepy import precalculated_text_measurer
+from badgepy.version import __version__
+
+_JINJA2_ENVIRONMENT = jinja2.Environment(
+    trim_blocks=True,
+    lstrip_blocks=True,
+    loader=jinja2.PackageLoader('badgepy', '.'),
+    autoescape=jinja2.select_autoescape(['svg']))
+
+# Use the same color scheme as describe in:
+# https://github.com/badges/shields/blob/master/lib/colorscheme.json
+
+_NAME_TO_COLOR = {
+    'brightgreen': '#4c1',
+    'green': '#97CA00',
+    'yellow': '#dfb317',
+    'yellowgreen': '#a4a61d',
+    'orange': '#fe7d37',
+    'red': '#e05d44',
+    'blue': '#007ec6',
+    'grey': '#555',
+    'gray': '#555',
+    'lightgrey': '#9f9f9f',
+    'lightgray': '#9f9f9f',
+    'critical': '#e05d44',
+    'important': '#fe7d37',
+    'success': '#4c1',
+    'informational': '#007ec6',
+    'inactive': '#9f9f9f',
+}
+
+
+def _remove_blanks(node):
+    for x in node.childNodes:
+        if x.nodeType == minidom.Node.TEXT_NODE:
+            if x.nodeValue:
+                x.nodeValue = x.nodeValue.strip()
+        elif x.nodeType == minidom.Node.ELEMENT_NODE:
+            _remove_blanks(x)
+
+
+def _embed_image(url: str) -> str:
+    parsed_url = urllib.parse.urlparse(url)
+
+    if parsed_url.scheme == 'data':
+        return url
+    elif parsed_url.scheme.startswith('http'):
+        r = requests.get(url)
+        r.raise_for_status()
+        content_type = r.headers.get('content-type')
+        if content_type is None:
+            raise ValueError('no "Content-Type" header')
+        content_type, image_type = content_type.split('/')
+        if content_type != 'image':
+            raise ValueError(
+                'expected an image, got "{0}"'.format(content_type))
+        image_data = r.content
+    elif parsed_url.scheme:
+        raise ValueError('unsupported scheme "{0}"'.format(parsed_url.scheme))
+    else:
+        with open(url, 'rb') as f:
+            image_data = f.read()
+        kind = filetype.guess(image_data)
+        image_type = kind.extension if kind is not None else None
+        if not image_type:
+            mime_type, _ = mimetypes.guess_type(url, strict=False)
+            if not mime_type:
+                raise ValueError('not able to determine file type')
+            else:
+                content_type, image_type = mime_type.split('/')
+                if content_type != 'image':
+                    raise ValueError('expected an image, got "{0}"'.format(
+                        content_type or 'unknown'))
+
+    encoded_image = base64.b64encode(image_data).decode('ascii')
+    return 'data:image/{};base64,{}'.format(image_type, encoded_image)
+
+
+def badge(
+    left_text: str,
+    right_text: Optional[str] = None,
+    left_link: Optional[str] = None,
+    right_link: Optional[str] = None,
+    center_link: Optional[str] = None,
+    whole_link: Optional[str] = None,
+    logo: Optional[str] = None,
+    left_color: str = '#555',
+    right_color: str = '#007ec6',
+    center_color: Optional[str] = None,
+    measurer: Optional[text_measurer.TextMeasurer] = None,
+    left_title: Optional[str] = None,
+    right_title: Optional[str] = None,
+    center_title: Optional[str] = None,
+    whole_title: Optional[str] = None,
+    right_image: Optional[str] = None,
+    center_image: Optional[str] = None,
+    embed_logo: bool = False,
+    embed_right_image: bool = False,
+    embed_center_image: bool = False,
+    id_suffix: str = '',
+) -> str:
+    """Creates a github-style badge as an SVG image.
+
+    >>> badge(left_text='coverage', right_text='23%', right_color='red')
+    '<svg...</svg>'
+    >>> badge(left_text='build', right_text='green', right_color='green',
+    ...       whole_link="http://www.example.com/")
+    '<svg...</svg>'
+
+    Args:
+        left_text: The text that should appear on the left-hand-side of the
+            badge e.g. "coverage".
+        right_text: The text that should appear on the right-hand-side of the
+            badge e.g. "23%".
+        left_link: The URL that should be redirected to when the left-hand text
+            is selected.
+        right_link: The URL that should be redirected to when the right-hand
+            text is selected.
+        whole_link: The link that should be redirected to when the badge is
+            selected. If set then left_link and right_right may not be set.
+        logo: A url representing a logo that will be displayed inside the
+            badge. Can be a data URL e.g. "data:image/svg+xml;utf8,<svg..."
+        left_color: The color of the part of the badge containing the left-hand
+            text. Can be an valid CSS color
+            (see https://developer.mozilla.org/en-US/docs/Web/CSS/color) or a
+            color name defined here:
+            https://github.com/badges/shields/blob/master/badge-maker/lib/color.js
+        right_color: The color of the part of the badge containing the
+            right-hand text. Can be an valid CSS color
+            (see https://developer.mozilla.org/en-US/docs/Web/CSS/color) or a
+            color name defined here:
+            https://github.com/badges/shields/blob/master/badge-maker/lib/color.js
+        measurer: A text_measurer.TextMeasurer that can be used to measure the
+            width of left_text and right_text.
+        embed_logo: If True then embed the logo image directly in the badge.
+            This can prevent an HTTP request and some browsers will not render
+            external image referenced. When True, `logo` must be a HTTP/HTTPS
+            URI or a filesystem path. Also, the `badge` call may raise an
+            exception if the logo cannot be loaded, is not an image, etc.
+        whole_title: The title attribute to associate with the entire badge.
+            See https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title.
+        left_title: The title attribute to associate with the left part of the
+            badge.
+            See https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title.
+        right_title: The title attribute to associate with the right part of
+            the badge.
+            See https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title.
+        id_suffix: The suffix of the id attributes used in the SVG's elements.
+            Use to prevent duplicate ids if several badges are embedded on the
+            same page.
+    """
+    if measurer is None:
+        measurer = (
+            precalculated_text_measurer.PrecalculatedTextMeasurer.default())
+
+    if (left_link or right_link or center_link) and whole_link:
+        raise ValueError(
+            'whole_link may not bet set with left_link, right_link, or center_link'
+        )
+
+    if center_image and not (right_image or right_text):
+        raise ValueError('cannot have a center_image without a right element')
+
+    if (center_image and not center_color) or (not center_image and
+                                               center_color):
+        raise ValueError('must have both a center_image and a center_color')
+
+    if logo and embed_logo:
+        logo = _embed_image(logo)
+
+    if right_image and embed_right_image:
+        right_image = _embed_image(right_image)
+
+    if center_image and embed_center_image:
+        center_image = _embed_image(center_image)
+
+    if center_color:
+        center_color = _NAME_TO_COLOR.get(center_color, center_color)
+
+    right_text_width = None
+    if right_text:
+        right_text_width = measurer.text_width(right_text) / 10.0
+
+    template = _JINJA2_ENVIRONMENT.get_template('badge-template-full.svg')
+
+    svg = template.render(
+        left_text=left_text,
+        right_text=right_text,
+        left_text_width=measurer.text_width(left_text) / 10.0,
+        right_text_width=right_text_width,
+        left_link=left_link,
+        right_link=right_link,
+        whole_link=whole_link,
+        center_link=center_link,
+        logo=logo,
+        left_color=_NAME_TO_COLOR.get(left_color, left_color),
+        right_color=_NAME_TO_COLOR.get(right_color, right_color),
+        center_color=center_color,
+        left_title=left_title,
+        right_title=right_title,
+        center_title=center_title,
+        whole_title=whole_title,
+        right_image=right_image,
+        center_image=center_image,
+        id_suffix=id_suffix,
+    )
+    xml = minidom.parseString(svg)
+    _remove_blanks(xml)
+    xml.normalize()
+    return xml.documentElement.toxml()

badgepy/__main__.py

@@ -0,0 +1,209 @@
+# Copyright 2018 The pybadge Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Output a github-style badge as an SVG image given some text and colors.
+
+For more information, run:
+$ python3 -m badgepy --help
+"""
+
+import argparse
+import sys
+import tempfile
+import webbrowser
+
+sys.path.append('/home/nick/git/badgepy/')
+import badgepy
+from badgepy.version import __version__
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        'badgepy',
+        description='generate a github-style badge given some text and colors')
+
+    parser.add_argument(
+        '--left-text',
+        default='license',
+        help='the text to show on the left-hand-side of the badge')
+    parser.add_argument(
+        '--right-text',
+        default=None,
+        help='the text to show on the right-hand-side of the badge')
+    parser.add_argument(
+        '--left-link',
+        default=None,
+        help='the url to redirect to when the left-hand of the badge is ' +
+        'clicked')
+    parser.add_argument(
+        '--right-link',
+        default=None,
+        help='the url to redirect to when the right-hand of the badge is ' +
+        'clicked')
+    parser.add_argument(
+        '--center-link',
+        default=None,
+        help='the url to redirect to when the center of the badge is ' +
+        'clicked')
+    parser.add_argument('--whole-link',
+                        default=None,
+                        help='the url to redirect to when the badge is clicked')
+    parser.add_argument(
+        '--logo',
+        default=None,
+        help='a URI reference to a logo to display in the badge')
+    parser.add_argument(
+        '--left-color',
+        default='#555',
+        help='the background color of the left-hand-side of the badge')
+    parser.add_argument(
+        '--right-color',
+        default='#007ec6',
+        help='the background color of the right-hand-side of the badge')
+    parser.add_argument(
+        '--center-color',
+        default=None,
+        help='the background color of the right-hand-side of the badge')
+    parser.add_argument('--browser',
+                        action='store_true',
+                        default=False,
+                        help='display the badge in a browser tab')
+    parser.add_argument(
+        '--use-pil-text-measurer',
+        action='store_true',
+        default=False,
+        help='use the PilMeasurer to measure the length of text (kerning may '
+        'be more precise for non-Western languages. ' +
+        '--deja-vu-sans-path must also be set.')
+    parser.add_argument(
+        '--deja-vu-sans-path',
+        default=None,
+        help='the path to the ttf font file containing DejaVu Sans. If not ' +
+        'present on your system, you can download it from ' +
+        'https://www.fontsquirrel.com/fonts/dejavu-sans')
+    parser.add_argument(
+        '--left-title',
+        default=None,
+        help='the title to associate with the left part of the badge. See '
+        'https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title')
+    parser.add_argument(
+        '--right-title',
+        default=None,
+        help='the title to associate with the right part of the badge. See '
+        'https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title')
+    parser.add_argument(
+        '--center-title',
+        default=None,
+        help='the title to associate with the center part of the badge. See '
+        'https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title')
+    parser.add_argument(
+        '--whole-title',
+        default=None,
+        help='the title to associate with the entire badge. See '
+        'https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title')
+    parser.add_argument(
+        '--right-image',
+        default=None,
+        help='the image to associate with the right-hand side of the badge')
+    parser.add_argument(
+        '--center-image',
+        default=None,
+        help='the image to associate with the center of the badge')
+    parser.add_argument(
+        '--embed-logo',
+        nargs='?',
+        type=lambda x: x.lower() in ['y', 'yes', 't', 'true', '1', ''],
+        const='yes',
+        default='no',
+        help='if the logo is specified then include the image data directly in '
+        'the badge (this will prevent a URL fetch and may work around the '
+        'fact that some browsers do not fetch external image references); '
+        'only works if --logo is a HTTP/HTTPS URI or a file path')
+    parser.add_argument(
+        '--embed-right-image',
+        nargs='?',
+        type=lambda x: x.lower() in ['y', 'yes', 't', 'true', '1', ''],
+        const='yes',
+        default='no',
+        help=
+        'if the right image is specified then include the image data directly in '
+        'the badge (this will prevent a URL fetch and may work around the '
+        'fact that some browsers do not fetch external image references); '
+        'only works if --logo is a HTTP/HTTPS URI or a file path')
+    parser.add_argument(
+        '--embed-center-image',
+        nargs='?',
+        type=lambda x: x.lower() in ['y', 'yes', 't', 'true', '1', ''],
+        const='yes',
+        default='no',
+        help=
+        'if the center image is specified then include the image data directly in '
+        'the badge (this will prevent a URL fetch and may work around the '
+        'fact that some browsers do not fetch external image references); '
+        'only works if --logo is a HTTP/HTTPS URI or a file path')
+    parser.add_argument(
+        '-v',
+        '--version',
+        action='version',
+        version='%(prog)s {version}'.format(version=__version__))
+    args = parser.parse_args()
+
+    if (args.left_link or args.right_link or
+            args.center_link) and args.whole_link:
+        print('argument --whole-link: cannot be set with ' +
+              '--left-link, --right-link, or --center_link',
+              file=sys.stderr)
+        sys.exit(1)
+
+    measurer = None
+    if args.use_pil_text_measurer:
+        if args.deja_vu_sans_path is None:
+            print('argument --use-pil-text-measurer: must also set ' +
+                  '--deja-vu-sans-path',
+                  file=sys.stderr)
+            sys.exit(1)
+        from badgepy import pil_text_measurer
+        measurer = pil_text_measurer.PilMeasurer(args.deja_vu_sans_path)
+
+    badge = badgepy.badge(left_text=args.left_text,
+                           right_text=args.right_text,
+                           left_link=args.left_link,
+                           right_link=args.right_link,
+                           center_link=args.center_link,
+                           whole_link=args.whole_link,
+                           logo=args.logo,
+                           left_color=args.left_color,
+                           right_color=args.right_color,
+                           center_color=args.center_color,
+                           measurer=measurer,
+                           left_title=args.left_title,
+                           right_title=args.right_title,
+                           center_title=args.center_title,
+                           whole_title=args.whole_title,
+                           right_image=args.right_image,
+                           center_image=args.center_image,
+                           embed_logo=args.embed_logo,
+                           embed_right_image=args.embed_right_image,
+                           embed_center_image=args.embed_center_image)
+
+    if args.browser:
+        _, badge_path = tempfile.mkstemp(suffix='.svg')
+        with open(badge_path, 'w') as f:
+            f.write(badge)
+
+        webbrowser.open_new_tab('file://' + badge_path)
+    else:
+        print(badge, end='')
+
+
+main()

badgepy/badge-template-full.svg

@@ -0,0 +1,80 @@
+{% set logo_width = 14 if logo else 0 %}
+{% set logo_padding = 3 if (logo and left_text) else 0 %}
+{% set image_width = 107 if center_image else 0 %}
+{% set left_width = left_text_width + 10 + logo_width + logo_padding %}
+{% set center_width = image_width + 10 if center_image else 0 %}
+{% set right_width = center_width + right_text_width + 10 if right_text else 0 %}
+{% set id_smooth = 'smooth' + id_suffix %}
+{% set id_round = 'round' + id_suffix %}
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="{{ left_width + right_width }}" height="20">
+  {% if whole_title %}
+    <title>{{ whole_title }}</title>
+  {% endif %}
+  <linearGradient id="{{ id_smooth }}" x2="0" y2="100%">
+      <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+    <stop offset="1" stop-opacity=".1"/>
+  </linearGradient>
+
+  <clipPath id="{{ id_round }}">
+    <rect width="{{ left_width + right_width }}" height="20" rx="3" fill="#fff"/>
+  </clipPath>
+
+  <g clip-path="url(#{{ id_round }})">
+    
+    <rect width="{{ left_width }}" height="20" fill="{{ left_color }}"> 
+      {% if left_title %}
+        <title>{{ left_title }}</title>
+      {% endif %}
+    </rect>
+    
+    {% if center_image %}
+    <rect x="{{ left_width }}" width="{{ center_width }}" height="20" fill="{{ center_color }}"> 
+      {% if center_title %}
+        <title>{{ center_title }}</title>
+      {% endif %}
+    </rect>
+    {% endif %}
+
+    <rect x="{{ left_width + center_width }}" width="{{ right_width }}" height="20" fill="{{ right_color }}">
+      {% if right_title %}
+        <title>{{ right_title }}</title>
+      {% endif %}
+    </rect>
+
+    <rect width="{{ left_width + right_width }}" height="20" fill="url(#{{ id_smooth }})"/>
+  </g>
+
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    {% if logo %}
+      <image x="5" y="3" width="{{ logo_width }}" height="14" xlink:href="{{ logo}}"/>
+    {% endif %}
+    <text x="{{ (((left_width+logo_width+logo_padding)/2)+1)*10 }}" y="150" fill="#010101" fill-opacity=".3" transform="scale(0.1)" textLength="{{ (left_width-(10+logo_width+logo_padding))*10 }}" lengthAdjust="spacing">{{ left_text }}</text>
+    <text x="{{ (((left_width+logo_width+logo_padding)/2)+1)*10 }}" y="140" transform="scale(0.1)" textLength="{{ (left_width-(10+logo_width+logo_padding))*10 }}" lengthAdjust="spacing">{{ left_text }}</text>
+    {% if center_image %}
+      <image x="{{ left_width }}" y="3" width="{{ center_width }}" height="14" xlink:href="{{ center_image }}"/>
+    {% endif %}
+    {% if right_image %}
+      <image x="{{ left_width + center_width }}" y="3" width="{{ right_width }}" height="14" xlink:href="{{ right_image }}"/>
+    {% endif %}
+    {% if right_text %}
+        <text x="{{ (left_width+center_width/2+right_width/2-1)*10 }}" y="150" fill="#010101" fill-opacity=".3" transform="scale(0.1)" textLength="{{ (right_width-center_width-10)*10 }}" lengthAdjust="spacing">{{ right_text }}</text>
+        <text x="{{ (left_width+center_width/2+right_width/2-1)*10 }}" y="140" transform="scale(0.1)" textLength="{{ (right_width-center_width-10)*10 }}" lengthAdjust="spacing">{{ right_text }}</text>
+    {% endif %}
+
+  {% if left_link or whole_link %}
+    <a xlink:href="{{ left_link or whole_link }}">
+      <rect width="{{ left_width }}" height="20" fill="rgba(0,0,0,0)"/>
+    </a>
+  {% endif %}
+  {% if center_image and (center_width or whole_link) %}
+    <a xlink:href="{{ center_link or whole_link }}">
+      <rect x="{{ left_width }}" width="{{ center_width }}" height="20" fill="rgba(0,0,0,0)"/>
+    </a>
+  {% endif %}
+  {% if right_link or whole_link %}
+    <a xlink:href="{{ right_link or whole_link }}">
+      <rect x="{{ left_width + center_width }}" width="{{ right_width }}" height="20" fill="rgba(0,0,0,0)"/>
+    </a>
+  {% endif %}
+  </g>
+</svg>