checkPythonPkg

Checks whether the python package is installed and, optionally, check its version.

Parameters

checkPythonPkg: str

Python package to check. Additionally, an optional version check can be added with a test operator.

aliases: checkPythonPkg, CheckPythonPkg, checkPythonPackage, CheckPythonPackage

desc: str (Optional)

The description for the check

substitute: bool (Optional)

Whether to substitute environment variables in check values

default: True

aliases: substitute, env_substitute

Example 1 (yaml)

The checkPythonPkg check in YAML format.

checks:
  PythonPackages:
    geomancy:
      desc: Geomancy python package
      checkPythonPkg: "geomancy>=0.1"

Examples 2 (toml)

The checkPythonPkg check in TOML format.

[checks.PythonPackages.geomancy]
desc = "Geomancy python package"
checkPythonPkg = "geomancy>=0.1"

Example 3 (toml)

The checkPythonPkg check in abbreviated TOML format.

[checks.PythonPackages]
geomancy = { checkPythonPkg = "geomancy>=0.1" }