Skip to main content

GitHub Pipenv locked dependency version

Pipenv is a dependency manager for Python which manages avirtualenv for projects. It adds/removes packages from your Pipfile as you install/uninstall packages and generates the ever-importantPipfile.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, whichpipenv lock then places in Pipfile.lock. TheGitHub 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 Shields.io's rate limit byadding the Shields GitHub application using your GitHub account.

Path Parameters
user string — REQUIRED
Example: metabolize
repo string — REQUIRED
Example: rq-dashboard-on-heroku
kind string — REQUIRED
packageName string — REQUIRED
Example: flask
Query Parameters
style string

One of: flat (default), flat-square, plastic, for-the-badge, social

Example: flat
logo string

One of the named logos (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using icon slugs which can be found on the simple-icons site or in the slugs.md file in the simple-icons repository.

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
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). The legacy name "colorA" is also supported.

Example: abcdef
color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also 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). The legacy name "maxAge" is also supported.

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.