buildmyiq-sdk

Official Python SDK for BuildMyIQ — a learning, course-authoring, and assessment platform on the Burdenoff platform.

Pre-launch notice: BuildMyIQ is launching in 2026. This package is published ahead of general availability so integrators can build early. There is no live production service yet — join the waitlist at buildmyiq.com to get early access.

This SDK is a thin shell over burdenoff-sdk-libs. It mounts the shared platform modules plus the BuildMyIQ domain module and a standalone sandbox module, and exposes them as one ergonomic, fully typed client.

Features

• Async/await throughout, built on httpx
• Dual-endpoint GraphQL client (workspace + global gateways)
• 23 mounted modules: the shared generic set + buildmyiq + sandbox
• Multiple auth flows: email/password, device code, PKCE, client credentials
• Automatic token refresh
• Typed error hierarchy
• Full type hints with py.typed marker

Installation

pip install buildmyiq-sdk

# Development install
pip install -e ".[dev]"

Quick Start

import asyncio
from buildmyiq_sdk import BuildmyiqSDK


async def main():
    # Defaults to the shared prod gateways and the burdenoff_cli_buildmyiq
    # OIDC client. Override the endpoints for local dev.
    sdk = BuildmyiqSDK()

    # Sign in with email/password
    await sdk.auth.sign_in(email="user@example.com", password="secret")

    # BuildMyIQ-domain operations are nested under sdk.buildmyiq
    courses = await sdk.buildmyiq.courses.list()
    enrollments = await sdk.buildmyiq.enrollments.list()

    # Shared cross-product modules are mounted at the top level
    tags = await sdk.tags.list()

    await sdk.close()


asyncio.run(main())

Nested namespace

Per the platform mandate (no compatibility shim), every module surface is nested under its owning module. The BuildMyIQ domain bundle keeps its sub-entities nested:

await sdk.buildmyiq.courses.list()
await sdk.buildmyiq.modules.list()
await sdk.buildmyiq.lessons.list()
await sdk.buildmyiq.assessments.list()
await sdk.buildmyiq.questions.list()
await sdk.buildmyiq.submissions.list()
await sdk.buildmyiq.enrollments.list()
await sdk.buildmyiq.cohorts.list()
await sdk.buildmyiq.certificates.list()
await sdk.buildmyiq.skills.list()
await sdk.buildmyiq.system.health()

Modules

All methods are async. The following modules are mounted on the BuildmyiqSDK instance: auth, billing, channels, conversations, devportal, export, files, groups, health, integrations, buildmyiq, notifications, organizations, products, rbac, sandbox, scheduler, security, store, support, tags, tours, workspaces.

Configuration

from buildmyiq_sdk import BuildmyiqSDK

sdk = BuildmyiqSDK(
    workspace_endpoint="https://graphqlworkspaces.burdenoff.com/workspaces/graphql",
    global_endpoint="https://graphql.burdenoff.com/global/graphql",
    client_id="burdenoff_cli_buildmyiq",   # default
    oidc_issuer=None,                       # derived from global_endpoint
    api_key=None,
    access_token=None,
    refresh_token=None,
    workspace_token=None,
    timeout=30.0,
    auto_refresh=True,
)

Error Handling

from buildmyiq_sdk import (
    BuildmyiqError,
    AuthenticationError,
    AuthorizationError,
    NetworkError,
    ValidationError,
    RateLimitError,
    DeviceCodeExpiredError,
    DeviceCodeDeniedError,
)

try:
    await sdk.auth.sign_in(email="user@example.com", password="wrong")
except AuthenticationError:
    print("Invalid credentials")
except NetworkError:
    print("Could not reach the API")
except BuildmyiqError as e:
    print(f"SDK error: {e}")

Development

python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

make format        # black + isort
make lint          # flake8
make type-check    # mypy (strict)
make test          # pytest
make sanity        # format-check + lint + type-check + test (cov>=80) + build

License

Proprietary — Copyright Burdenoff Consultancy Services Pvt. Ltd.

Support

• Issues: GitHub Issues