用于生成github风格徽章的库和命令行工具
pybadges的Python项目详细描述
皮卡
pybadges是一个python库和命令行工具,允许您创建 Github样式的徽章作为SVG图像。例如:
生成的徽章的美学与此中的视觉设计相匹配 specification。
图书馆的实施受到 Shields.io和javascript gh-badges图书馆。
开始
安装
pybadges可以使用pip:
pip install pybadges
要测试安装是否成功,请尝试:
python -m pybadges --left-text=build --right-text=failure --right-color='#c00' --browser
您将在浏览器中看到这样的徽章:
用法
pybadges既可以从命令行使用,也可以用作python库。
命令行接口是一种很好的方法,可以在以前使用api进行实验 编写python代码。
命令行用法
使用--help
可以找到pybadges命令参数的完整文档。
标志:
python -m pybadges --help
但是下面的用法演示了每个有趣的选项:
python -m pybadges \ --left-text=complete\ --right-text=example \ --left-color=green \ --right-color='#fb3'\ --left-link=http://www.complete.com/ \ --right-link=http://www.example.com \ --logo='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAIAAAD91JpzAAAAD0lEQVQI12P4zwAD/xkYAA/+Af8iHnLUAAAAAElFTkSuQmCC'\ --embed-logo \ --whole-title="Badge Title"\ --left-title="Left Title"\ --right-title="Right Title"\ --browser关于
--logo
和--embed-logo
请注意,--logo
选项可以包含常规url:
python -m pybadges \ --left-text="python"\ --right-text="3.2, 3.3, 3.4, 3.5, 3.6"\ --whole-link="https://www.python.org/"\ --browser \ --logo='https://dev.w3.org/SVG/tools/svgweb/samples/svg-files/python.svg'
如果设置了--logo
选项,也可以设置--embed-logo
选项。
--embed-logo
选项导致在--logo
中提供的url的内容。
嵌入徽章而不是通过链接引用。
使用此选项的优点是不需要额外的http请求 以呈现徽章,并且某些浏览器根本不会加载图像引用。
您可以在浏览器中看到差异:
关于--(whole|left|right)-title
的说明
title
元素通常显示为
pop-up by browsers
但目前
filtered by Github。
库使用
pybadges主要用作python库。
frompybadgesimportbadges=badge(left_text='coverage',right_text='23%',right_color='red')# s is a string that contains the badge data as an svg image.print(s[:40])# => <svg height="20" width="191.0" xmlns="ht
badge()
的关键字参数与命令标志名称相同
除使用下划线而不是
连字符/减号(例如--left-text
=>;left_text=
)
注意事项
pybadges使用预先计算的文本宽度表和 kerning距离 (用于西方雕文)确定徽章的大小。 所以东欧语言的表现可能不如 西欧的:
而在deja vu sans中不存在的字形(默认字体)可能 渲染得非常糟糕:
PyBadges不支持 从右向左书写(例如阿拉伯语、希伯来语)并显示 文本方向可能不正确:
开发
git clone https://github.com/google/pybadges.git cd pybadges python -m virtualenv venv source venv/bin/activate # Installs in edit mode and with development dependencies. pip install -e .[dev] nox
如果您想将更改贡献回pybadges,请阅读 contributer guide.
版本控制
我们使用SemVer进行版本控制。
许可证
此项目在apache许可下获得许可-有关详细信息,请参见LICENSE文件
这不是官方支持的谷歌产品。