ipsdk

Python SDK for making API calls to Itential Platform and Itential Automation Gateway 4.x.

Provides sync and async HTTP clients with automatic authentication, session management, and sensitive data filtering. Single runtime dependency: httpx.

Installation

pip install ipsdk

Or with uv:

uv add ipsdk

Requires Python 3.10+.

Python Version Support

Usage

Platform — basic auth

import ipsdk

platform = ipsdk.platform_factory(
    host="platform.itential.dev",
    user="admin@pronghorn",
    password="your-password"
)

res = platform.get("/health/server")
print(res.json())

Platform — OAuth (client credentials)

import ipsdk

platform = ipsdk.platform_factory(
    host="platform.itential.dev",
    client_id="your-client-id",
    client_secret="your-client-secret"
)

res = platform.get("/adapters")

Gateway

import ipsdk

gateway = ipsdk.gateway_factory(
    host="gateway.itential.dev",
    user="admin@itential",
    password="your-password"
)

res = gateway.get("/devices")

Async

Pass want_async=True to get an async client:

import asyncio
import ipsdk

async def main():
    platform = ipsdk.platform_factory(
        host="platform.itential.dev",
        client_id="your-client-id",
        client_secret="your-client-secret",
        want_async=True
    )
    res = await platform.get("/adapters")
    print(res.json())

asyncio.run(main())

HTTP Methods

All clients support get, post, put, delete, and patch.

path is the relative URI appended to the base URL. params is a dict serialized to a query string. json accepts a list or dict; when provided, sets Content-Type: application/json automatically.

Base URLs:

• Platform: https://host:port
• Gateway: https://host:port/api/v2.0

Configuration

Logging

import ipsdk

ipsdk.logging.set_level(ipsdk.logging.DEBUG)
ipsdk.logging.info("Connected to platform")

Available levels: TRACE (5), DEBUG, INFO, WARNING, ERROR, CRITICAL, FATAL (90), NONE (100).

The @ipsdk.logging.trace decorator logs function entry/exit with timing. Sensitive data filtering (PII, passwords, tokens) is enabled by default and can be extended:

ipsdk.logging.add_sensitive_data_pattern("ssn", r"\d{3}-\d{2}-\d{4}")

Development

# Install dependencies and pre-commit hooks
make install

# Run checks (lint, format, security, tests, license headers)
make ci

# Individual targets
make test        # pytest
make coverage    # pytest --cov (100% required)
make lint        # ruff check
make format      # ruff format
make security    # bandit scan
make license     # check GPL headers

# Test across Python 3.10–3.15
make tox

License

GPL-3.0-or-later. See LICENSE.