Skip to main content

Installing infrahub-sdk

The Infrahub SDK for Python is available on PyPI and can be installed using the pip package installer. It is recommended to install the SDK into a virtual environment.

python3 -m venv .venv
source .venv/bin/activate
pip install infrahub-sdk

Installing optional extras

Extras can be installed as part of the Python SDK and are not installed by default.

ctl

The ctl extra provides the infrahubctl command, which allows you to interact with an Infrahub instance.

pip install 'infrahub-sdk[ctl]'

tests

The tests extra provides all the components for the testing framework of Transforms, Queries and Checks.

pip install 'infrahub-sdk[tests]'

all

Installs infrahub-sdk together with all the extras.

pip install 'infrahub-sdk[all]'