且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

给python项目在github贴上build和pypi小徽章

更新时间:2022-09-06 16:05:05

效果展示

给python项目在github贴上build和pypi小徽章


示例项目地址:https://github.com/mouday/chinesename

获取第一个徽章build

在项目主目录下创建三个必要文件

给python项目在github贴上build和pypi小徽章


新建.travis.yml,写明python的版本号、需要安装的依赖和测试模块

language: python
python:
    - "3.6"

install:
- pip install -r requirements.txt

script:
  - pytest

新建requirements.txt,写清依赖版本

chinesename==0.0.9

新建test_chinesename.py写pytest测试用例

pytest参考:https://www.jianshu.com/p/c5037bed334a

def test_chinesename():
    pass

将代码提交到github

用github账号登录:https://travis-ci.org/

找到刚刚提交的项目,添加到travis,然后就会自动测试,

测试通过后,点击图标,选择markdown格式,复制粘贴到README.md文件

提交代码就可以看到效果了

给python项目在github贴上build和pypi小徽章


获取pypi徽章

前提,先提交项目到pypi

可参考:Python编程:twine模块打包python项目上传pypi


打开网站:https://shields.io/#/examples/version

找到pypi,点击后填入link和image画线部分信息,就可以看到图标版本已经变成pypi对应的版本了给python项目在github贴上build和pypi小徽章


复制markdown链接,粘贴到README.md文件,再次提交代码,效果就出来了

自定义小徽章

如果觉得上面获取徽章的方式比较麻烦,那么就自定义小徽章

打开往下滑 https://shields.io/

给python项目在github贴上build和pypi小徽章


填入对应的信息,选择样式后,点击make,然后就出现了一个图,csnd支持按照markdown的格式引用

例如:

[![CSDN](https://img.shields.io/badge/CSND-%E5%BD%AD%E4%B8%96%E7%91%9C-brightgreen.svg)](https://blog.csdn.net/mouday)

参考:

文档:https://docs.travis-ci.com/user/languages/python/