Python SDK

Planned Python SDK for typed ConformaESG data integrations.

The Python SDK target package is conformaesg. It is designed for ERP, MES, PIM, PLM and middleware integrations that need typed access to ConformaESG core data APIs.

Warning

The Python SDK is planned and documented from the implementation design. Installation commands and APIs become definitive only when the package is published.

Quickstart

Python
import os


from conformaesg import ConformaClient
from conformaesg.models import SupplierCreate


client = ConformaClient(
    base_url=os.environ["CONFORMA_BASE_URL"],
    api_key=os.environ["CONFORMA_API_KEY"],
)


supplier = client.suppliers.create(
    SupplierCreate(
        name="Acme Textiles Ltd",
        category="TEXTILES",
        country="IT",
    )
)


print(supplier.id)

Public resource clients

Resource clientPurpose
client.suppliersSuppliers, certifications and supplier-owned document helpers
client.product_materialsSupplier products, company products, fabrics, yarns and fibers
client.chemicalsChemical product catalog
client.purchasesPurchase orders, lifecycle transitions, logs and purchase documents
client.documentsGeneric document metadata, presign, complete and download
client.traceabilityProduct journeys, processing stages and batch records

ProductMaterialsClient exposes nested clients: supplier_products, company_products, fabrics, yarns and fibers.

TraceabilityClient exposes nested clients: product_journeys and batch_records.

Explicitly out of scope

The Python SDK does not manage login, logout, refresh, CSRF, credential recovery, API key generation, account users, operators, admin endpoints or billing endpoints. Those APIs remain outside the data-integration SDK scope.

Python SDK docs