Skip to main content

GitHub Pipenv locked dependency version

Pipenv is a dependency manager for Python which manages a virtualenv for projects. It adds/removes packages from your Pipfile as you install/uninstall packages and generates the ever-important Pipfile.lock, which can be checked in to source control in order to produce deterministic builds.

The GitHub Pipenv badges are intended for applications using Pipenv which are hosted on GitHub.

When Pipfile.lock is checked in, the GitHub Pipenv locked dependency version badge displays the locked version of a dependency listed in [packages] or [dev-packages] (or any of their transitive dependencies).

Usually a Python version is specified in the Pipfile, which pipenv lock then places in Pipfile.lock. The GitHub Pipenv Python version badge displays that version.

If your GitHub badge errors, it might be because you hit GitHub's rate limits. You can increase's rate limit by adding the Shields GitHub application using your GitHub account.

Path Parameters
user string REQUIRED

Example: metabolize

repo string REQUIRED

Example: rq-dashboard-on-heroku

packageName string REQUIRED

Example: flask

Query Parameters
style string

Possible values: [flat, flat-square, plastic, for-the-badge, social]

If not specified, the default style for this badge is "flat".

Example: flat

logo string

One of the named logos (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. All simple-icons are referenced using icon slugs. You can click the icon title on simple-icons to copy the slug or they can be found in the file in the simple-icons repository. Further info.

Example: appveyor

logoColor string

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.

Example: violet

logoSize string

Make icons adaptively resize by setting auto. Useful for some wider logos like amd and amg. Supported for simple-icons logos only.

Example: auto

label string

Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)

Example: healthiness

labelColor string

Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: abcdef

color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: fedcba

cacheSeconds string

HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).

Example: 3600

link string[]

Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.