Python SDK Installation

Install and configure the planned ConformaESG Python SDK.

The target package name is conformaesg. The planned supported Python version is >=3.10.

Warning

The package is not documented here as a published artifact yet. Treat these commands as the target installation interface until the SDK release notes confirm package availability.

Install

Shell
pip install conformaesg

With uv:

Shell
uv add conformaesg

With Poetry:

Shell
poetry add conformaesg

Configure

base_url must include the API prefix, normally /api/v1.

Shell
export CONFORMA_BASE_URL="{{BASE_URL}}/api/v1"
export CONFORMA_API_KEY="your-pat-from-secret-manager"
Python
import os


from conformaesg import ConformaClient


client = ConformaClient(
    base_url=os.environ["CONFORMA_BASE_URL"],
    api_key=os.environ["CONFORMA_API_KEY"],
    timeout=30.0,
    user_agent="my-erp-sync/1.0",
)

The SDK sends its own user agent in the form conformaesg-python/<version> and may append the application user agent when configured.

Smoke test

Python
from conformaesg import ConformaClient


client = ConformaClient.from_env()


page = client.suppliers.list(limit=1)
print(page.items)

Use a read-only PAT scope for smoke tests whenever possible.