用于生成Githubstyle徽章的库和命令行工具
pybadges-trend的Python项目详细描述
皮獾趋势
pybadges trend是Brian Quinlan的pybadges库的一个分支。 此分叉的更改是put forward to be merged into the upstream library。但是,从那以后 不是布莱恩的回应,我想用这个版本,我要发布 单独在PyPI上。如果这些变化被合并到上游,在某个时候,我 把这个叉子归档。在
pybadges是一个Python库和命令行工具,允许您创建 Github样式的徽章作为SVG图像。例如:
除了pybadges允许的之外,pybadges trend还支持嵌入 可选图像(110 x 14),位于左右文本之间。下面是一个例子:
生成的徽章的美学与视觉设计相匹配 specification。在
图书馆的实施受到 Shields.io和JavaScript gh-badges库。在
入门
安装
pybadges可以使用pip安装:
pip install pybadges
要测试安装是否成功,请尝试:
^{pr2}$您将在浏览器中看到这样的徽章:
使用
pybadges既可以从命令行使用,也可以用作Python库。在
以前,命令行界面是一种很好的API实验方法 编写Python代码。在
你也可以看看example server。在
命令行用法
可以使用--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
和{请注意,--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可用于在web上提供徽章图像。在
server-example 包含从中提供徽章图像的示例 Flask server。在
注意事项
- 在
pybadges使用预先计算的文本宽度和 kerning距离 (对于西方象形文字)决定徽章的大小。 因此,东欧语言的表现可能不如 西欧国家:
在似曾相识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,请阅读 contributor guide.
版本控制
{a15}用于版本控制。在
许可证
这个项目是在Apache许可下授权的-有关详细信息,请参阅LICENSE文件
这不是一个官方支持的Google产品。在
- 项目
标签: