/* */

GithubのREADMEでよく見るBadgeの設定の仕方について

こんにちわ&こんばんわ、わかめです。

regonn-curry-fmを視聴されてる方はご存知かもしれないですがregonnさんが現在開発中のOSSpolar_bearに絶賛OSS活動中です。

github.com

今回はそのOSS活動中に初めて知りましたGithubのREADMEへのBadgeの設定方法についてまとめます。またpolar_bearPythonのライブラリということで主にPythonに関連のあるBadgeの設定方法についてのみ言及したいと思います。

PyPI

PyPIでの公開が完了している場合、パッケージ名を入力するだけで下記のようなBadgeを作成してくれるようです。

PyPI version

また生成されたMarkdownに記述されるBadgeへのURLがPyPIへリダイレクトしてくれるようです、試しに上のBadgeをクリックしてみて下さい。

[![PyPI version](https://badge.fury.io/py/polar-bear.svg)](https://badge.fury.io/py/polar-bear)

badge.fury.io

PythonVersion

こちらもPyPIでの公開が完了していれば、パッケージ名を入力するだけでライブラリが対応するPythonのVersionをPyPIから取得してBadgeを作成してくれるようです。

Python Versions

[![Python Versions](https://img.shields.io/pypi/pyversions/polar_bear.svg)](https://pypi.org/project/polar-bear/)

shields.io

参考