Generate badges for teams and deliverables
Adds a plugin for sphinx for generating badges for teams and deliverables to use in READMEs, docs sites, etc. A badge corresponds to a tag. This plugin generates an `svg` image containing team tags and the deliverable tags for each repo listed. Each tag corresponds to an SVG image. All the tags are bundled in the same SVG image whose filename corresponds to the repo name. Each badge points to the tag link in the governance website. This not handled yet: - This doesn't handle "unofficial" projects, which would be nice to have. If a project tries to access `project-team.svg` tag, instead of returning 404, we could return a `project:unofficial` badge. - Specialized colors for some tags. We might want to use different colors for some groups. Team tags could be orange, etc. - Group/Order tags generation by tag groups Here's a dummy repo created as an example of how this work would be consumed (or look like): - https://github.com/flaper87/badges-tester Change-Id: Ic70c17b60c0107e40b78bf21dc3a68c558eee06f
This commit is contained in:
Flavio Percoco
parent
156bf0a5fb
commit
da2ceddf9d
151
doc/source/_exts/badges.py
Normal file
151
doc/source/_exts/badges.py
Normal file
@ -0,0 +1,151 @@
|
||||
# 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
|
||||
#
|
||||
# http://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.
|
||||
|
||||
"""
|
||||
Generate badges for the projects
|
||||
"""
|
||||
|
||||
import os
|
||||
from PIL import ImageFont
|
||||
|
||||
import projects
|
||||
|
||||
|
||||
PADDING = 8
|
||||
BASE_TAGS_URL = 'http://governance.openstack.org/reference/tags/'
|
||||
COLOR_SCHEME = {
|
||||
"brightgreen": "#4c1",
|
||||
"green": "#97CA00",
|
||||
"yellow": "#dfb317",
|
||||
"yellowgreen": "#a4a61d",
|
||||
"orange": "#fe7d37",
|
||||
"red": "#e05d44",
|
||||
"blue": "#007ec6",
|
||||
"grey": "#555",
|
||||
"lightgrey": "#9f9f9f",
|
||||
}
|
||||
|
||||
SVG_ROOT = """<?xml version="1.0" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
|
||||
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
%s
|
||||
</svg>
|
||||
"""
|
||||
FLAT_BADGE_TEMPLATE = """<svg id="{left_text}:{right_text}" width="{width}" height="20" y="{svg_y}">
|
||||
<a target="_blank" xlink:href="{link}">
|
||||
<linearGradient id="smooth:{left_text}:{right_text}" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
|
||||
<mask id="round:{left_text}:{right_text}">
|
||||
<rect width="{width}" height="20" rx="3" fill="#fff"/>
|
||||
</mask>
|
||||
|
||||
<g mask="url(#round:{left_text}:{right_text})">
|
||||
<rect width="{left_width}" height="20" fill="#555"/>
|
||||
<rect x="{left_width}" width="{right_width}" height="20" fill="{color}"/>
|
||||
<rect width="{width}" height="20" fill="url(#smooth:{left_text}:{right_text})"/>
|
||||
</g>
|
||||
|
||||
<g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
|
||||
<text x="{left_x}" y="15" fill="#010101" fill-opacity=".3">{left_text}</text>
|
||||
<text x="{left_x}" y="14">{left_text}</text>
|
||||
<text x="{right_x}" y="15" fill="#010101" fill-opacity=".3">{right_text}</text>
|
||||
<text x="{right_x}" y="14">{right_text}</text>
|
||||
</g>
|
||||
</a>
|
||||
</svg>
|
||||
"""
|
||||
|
||||
|
||||
def _generate_badge(left_text, right_text, count,
|
||||
link=None, colorscheme='brightgreen'):
|
||||
|
||||
font = ImageFont.truetype('DejaVuSans.ttf', 11)
|
||||
left_width = font.getsize(left_text)[0] + PADDING
|
||||
right_width = font.getsize(right_text)[0] + PADDING
|
||||
width = left_width + right_width
|
||||
|
||||
data = {
|
||||
'link': link or '',
|
||||
'color': COLOR_SCHEME[colorscheme],
|
||||
'svg_y': (24 * count),
|
||||
'width': width,
|
||||
'left_width': left_width,
|
||||
'left_text': left_text,
|
||||
'left_x': left_width / 2,
|
||||
'right_width': right_width,
|
||||
'right_text': right_text,
|
||||
'right_x': left_width + right_width / 2 - 1,
|
||||
}
|
||||
|
||||
return FLAT_BADGE_TEMPLATE.format(**data)
|
||||
|
||||
|
||||
def _generate_tag_badges(tags):
|
||||
count = 0
|
||||
badges = []
|
||||
|
||||
badges.append(_generate_badge('project', 'official', count).encode('utf-8'))
|
||||
|
||||
for tag in tags:
|
||||
count += 1
|
||||
# NOTE(flaper87): will submit other patches to make these
|
||||
# tags consistent with the rest.
|
||||
if tag in ['starter-kit:compute', 'tc-approved-release']:
|
||||
group, tname = 'tc', tag
|
||||
else:
|
||||
group, tname = tag.split(':')
|
||||
|
||||
link = BASE_TAGS_URL + '%s.html' % tag.replace(':', '_')
|
||||
badges.append(_generate_badge(group, tname, count,
|
||||
link, colorscheme='blue').encode('utf-8'))
|
||||
return badges
|
||||
|
||||
|
||||
def _generate_teams_badges(app):
|
||||
all_teams = projects.get_project_data()
|
||||
files = []
|
||||
|
||||
badges_dir = os.path.join(app.outdir, 'badges')
|
||||
if not os.path.exists(badges_dir):
|
||||
os.mkdir(badges_dir)
|
||||
|
||||
filename = os.path.join(badges_dir, 'project-unofficial.svg')
|
||||
svg = _generate_badge('project', 'unofficial', 0, colorscheme='red').encode('utf-8')
|
||||
with open(filename, 'w') as f:
|
||||
f.write(SVG_ROOT % svg)
|
||||
files.append(filename)
|
||||
|
||||
for team, info in all_teams.items():
|
||||
app.info('generating team badge for %s' % team)
|
||||
|
||||
for name, deliverable in info['deliverables'].items():
|
||||
tags = info.get('tags', []) + deliverable.get('tags', [])
|
||||
badges = _generate_tag_badges(tags)
|
||||
svg = '\n'.join(badges)
|
||||
|
||||
for repo in deliverable.get('repos', []):
|
||||
repo_name = repo.split('/')[1]
|
||||
filename = os.path.join(badges_dir, '%s.svg' % projects.slugify(repo_name))
|
||||
with open(filename, 'w') as f:
|
||||
f.write(SVG_ROOT % svg)
|
||||
files.append(filename)
|
||||
|
||||
return files
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.info('loading badges extension')
|
||||
_generate_teams_badges(app)
|
||||
1
doc/source/badges/.htaccess
Normal file
1
doc/source/badges/.htaccess
Normal file
@ -0,0 +1 @@
|
||||
ErrorDocument 404 /badges/project-unofficial.svg
|
||||
@ -34,6 +34,7 @@ extensions = [
|
||||
'projects',
|
||||
'teams',
|
||||
'tags',
|
||||
'badges',
|
||||
]
|
||||
|
||||
todo_include_todos = True
|
||||
|
||||
@ -4,3 +4,4 @@ oslosphinx>=2.2.0 # Apache-2.0
|
||||
PyYAML>=3.1.0
|
||||
yamllint>=0.5.2
|
||||
requests-cache
|
||||
Pillow>=2.4.0 # PIL License
|
||||
|
||||
Loading…
Reference in New Issue
Block a user