Skip to content

Python Language Support

🛠️ Tools · ⬅ Top

pythonInstall

Install python

Usage

pythonInstall

Install python

When this tool succeeds the python binary is available in the local operating system. Return Code: 1 - If installation fails Return Code: 0 - If installation succeeds

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

pythonUninstall

Uninstall python

Usage

pythonUninstall

Uninstall python

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

pythonPackageInstalled

Is a package installed for python?

Usage

pythonPackageInstalled pipPackage ... [ --help ] [ --handler handler ] [ --any ]

Is a package installed for python? Return Code: 0 - All packages are installed (or at least one package with --any) Return Code: 1 - All packages are not installed (or NO packages are installed with --any)

Arguments

  • pipPackage ... - String. Required. Package name(s) to check.
  • --help - Optional. Flag. Display this help.
  • --handler handler - Optional. Function. Use this error handler instead of the default error handler.
  • --any - Flag. Optional. When specified changes the behavior such that if it returns return code 0 IFF any single package is installed.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

pipInstall

Utility to install python dependencies via pip

Usage

pipInstall [ --help ] [ --handler handler ] pipPackage [ ... ]

Utility to install python dependencies via pip Installs python if it hasn't been using pythonInstall.

Arguments

  • --help - Optional. Flag. Display this help.
  • --handler handler - Optional. Function. Use this error handler instead of the default error handler.
  • pipPackage [ ... ]- `` - String. Required. Pip package name to install.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

pipUninstall

Utility to uninstall python dependencies via pip

Usage

pipUninstall [ --help ] [ --handler handler ] pipPackage [ ... ]

Utility to uninstall python dependencies via pip

Arguments

  • --help - Optional. Flag. Display this help.
  • --handler handler - Optional. Function. Use this error handler instead of the default error handler.
  • pipPackage [ ... ]- `` - String. Required. Pip package name to uninstall.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

pipWrapper

Run pip whether it is installed as a module or

Usage

pipWrapper [ --help ] [ ... ]

Run pip whether it is installed as a module or as a binary

Arguments

  • --help - Optional. Flag. Display this help.
  • ... - Arguments. Optional. Arguments passed to pip

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

pipUpgrade

Utility to upgrade pip correctly

Usage

pipUpgrade [ --help ]

Utility to upgrade pip correctly

Arguments

  • --help - Optional. Flag. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

pythonVirtual

Set up a virtual environment for a project and install

Usage

pythonVirtual --application directory [ --require requirements ] [ pipPackage ... ] [ --help ] [ --handler handler ]

Set up a virtual environment for a project and install dependencies. Also can be used to update dependencies or add them.

When completed, a directory .venv exists in your project containing dependencies.

Arguments

  • --application directory - Directory. Required. Path to project location.
  • --require requirements - File. Optional. Requirements file for project.
  • pipPackage ... - String. Optional. One or more pip packages to install in the virtual environment.
  • --help - Optional. Flag. Display this help.
  • --handler handler - Optional. Function. Use this error handler instead of the default error handler.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error