tracing-platform-sdk 1.0.1

Official Python SDK for the Tracing Platform

Tracing Platform Python SDK

Official Python SDK for the Tracing Platform — EPCIS 2.0 supply chain traceability with DID + Blockchain anchoring.

Installation

pip install tracing-platform-sdk

Requirements

• Python 3.8+
• aiohttp >= 3.8.0
• pydantic >= 2.0.0

Quick Start

import asyncio
from tracing_sdk import TracingClient, TracingClientOptions

async def main():
    client = TracingClient(TracingClientOptions(
        base_url="https://api.tracingplatform.com",
        client_id="your_client_id",
        client_secret="your_client_secret",
    ))

    # Commission a new LOT
    event = await client.commission.create({
        "signerDidHash": "did:neo:abc123",
        "productId": 1,
        "lotCode": "LOT-2024-001",
        "quantity": 100,
        "uom": "KGM",
        "productionDate": "2024-01-15",
        "bizLocation": "urn:epc:id:sgln:...",
        "bizStep": "commissioning",
        "disposition": "active",
        "readPoint": "urn:epc:id:sgln:...",
    })
    print(event)

asyncio.run(main())

Authentication

The SDK uses OAuth2 client_credentials flow automatically:

client = TracingClient(TracingClientOptions(
    base_url="https://api.tracingplatform.com",
    client_id="your_client_id",       # from API Credentials page
    client_secret="your_client_secret",
    scopes=["commission.write", "shipping.read"],  # optional — omit for full access
))

Tokens are cached and refreshed automatically.

Available Modules

Module	Access	Description
client.commission	commission.read/write	LOT genesis events
client.aggregation	aggregation.read/write	Pack/unpack containers
client.shipping	shipping.read/write	Shipment creation + ASN
client.receiving	receiving.read/write	QC + custody transfer
client.transformation	transformation.read/write	Input LOTs → Output LOT
client.recall	recall.read/write	Recall alerts management
client.custody	custody.read	Custody ledger overview
client.traceability	traceability.read	LOT timeline + tree
client.anchor	anchor.read	Blockchain verification
client.products	products.read/write	Product catalog
client.did_profile	did_profile.read/write	DID + location management
client.members	members.read/write	Team member management
client.auth	—	Token introspection
client.ops	ops.write	Batch supply chain operations

Error Handling

from tracing_sdk import TracingClient, AuthError, ValidationError, NotFoundError

try:
    event = await client.commission.create(...)
except AuthError:
    print("Invalid credentials or expired token")
except ValidationError as e:
    print(f"Validation failed: {e}")
except NotFoundError:
    print("Resource not found")

Pagination

from tracing_sdk import PaginationHelper

# Fetch all pages automatically
all_events = await PaginationHelper.fetch_all(
    client.commission.list,
    params={"page": 1, "limit": 50},
)

License

MIT