infrahub-sdk 1.20.0

Python Client to interact with Infrahub

Infrahub by OpsMill

Infrahub by OpsMill is taking a new approach to Infrastructure Management by providing a new generation of datastore to organize and control all the data that defines how an infrastructure should run.

At its heart, Infrahub is built on 3 fundamental pillars:

• Powerful Schema: that's easily extensible
• Unified Version Control: for data and files
• Data Synchronization: with traceability and ownership

Infrahub SDK

The Infrahub Python SDK greatly simplifies how you can interact with Infrahub programmatically.

More information can be found in the Infrahub Python SDK Documentation.

Installation

The Infrahub SDK 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]'

Development setup with UV

If you're developing the SDK and using UV for dependency management, you can install specific dependency groups:

# Install development dependencies
uv sync --all-groups --all-extras

# Install specific groups
uv sync --group tests               # Testing dependencies only
uv sync --group lint                # Linting dependencies only
uv sync --group ctl                 # CLI dependencies only
uv sync --all-groups --all-extras   # All optional dependencies