hellopivot-sdk 0.1.0

Official Python SDK for the Pivot REST API

hellopivot-sdk

Official Python SDK for the Pivot REST API.

This SDK is generated from apps/rest/openapi.yaml with openapi-python-client. To keep hardcoded code to a minimum, nearly all request/response models and endpoint functions are generated code.

Installation

pip install hellopivot-sdk

Quick start

import os

from hellopivot_sdk import AuthenticatedClient
from hellopivot_sdk.api.spaces import get_spaces_by_organization_id

client = AuthenticatedClient(
    base_url="https://api.pivot.app",
    token=os.environ["PIVOT_API_KEY"],
)

with client as authenticated_client:
    response = get_spaces_by_organization_id.sync(
        organization_id="your-org-id",
        offset=0,
        client=authenticated_client,
    )
    print(response)

Development

This project uses uv for dependency management and packaging.

cd libs/pivot-python-sdk
uv sync --group dev
uv run --group dev python scripts/codegen.py
uv run --group dev ruff check --select I .
uv run --group dev pytest
uv build

Regenerating from OpenAPI

Run this any time apps/rest/openapi.yaml changes:

pnpm nx codegen pivot-python-sdk

Generated files live in libs/pivot-python-sdk/src/hellopivot_sdk/. Do not edit generated files manually.