UCP Python SDK
Official Python library for the Universal Commerce Protocol (UCP).
Overview
This repository contains the Python SDK for the Universal Commerce Protocol (UCP). It provides Pydantic models for UCP schemas, making it easy to build UCP-compliant applications in Python.
UCP Version Compatibility
Each version of the Python SDK is generated against a specific version of the UCP schema:
| SDK Version | UCP Schema Version |
|---|---|
0.4.x |
2026-04-08 |
0.3.x |
2026-01-23 |
0.2.x / 0.1.x |
2026-01-11 |
Installation
To use this SDK in your own project, install it from PyPI:
pip install ucp-sdk
Or, if you are managing your project with uv:
uv add ucp-sdk
Usage
The example below parses a UCP checkout response and reads typed fields:
from ucp_sdk.models.schemas.shopping.checkout import Checkout
# Parse a UCP checkout response
checkout = Checkout.model_validate(checkout_data)
# Access typed fields
print(checkout.status) # "incomplete" | "ready_for_complete" | ...
print(checkout.currency) # ISO 4217 currency code
for item in checkout.line_items:
print(f"{item.item.title}: {item.quantity}")
Available model packages
| Package | Description |
|---|---|
ucp_sdk.models.schemas.shopping |
Checkout, cart, catalog, order, payment models |
ucp_sdk.models.schemas.shopping.types |
Line items, totals, buyer, fulfillment, signals |
ucp_sdk.models.schemas.transports |
REST, MCP, and embedded protocol bindings |
ucp_sdk.models.schemas |
Service definitions, capabilities, payment handlers |
Validation
All models support Pydantic validation and serialization:
from pydantic import ValidationError
from ucp_sdk.models.schemas.shopping.checkout import Checkout
# Validate data against UCP schemas
try:
checkout = Checkout.model_validate(checkout_data)
# Serialize to JSON-compatible dict
checkout_dict = checkout.model_dump(exclude_none=True)
except ValidationError as e:
print(e.errors())
Development
Prerequisites
This project uses uv for dependency management.
Setup
# Clone the repository
git clone https://github.com/Universal-Commerce-Protocol/python-sdk.git
cd python-sdk
# Install dependencies
uv sync
Generating Pydantic Models
The models are automatically generated from the JSON schemas in the UCP Specification.
To regenerate the models:
uv sync
./generate_models.sh <version>
Where <version> is the version of the UCP specification to use (for example,
"2026-04-08").
If no version is specified, the main branch of the
UCP repo will be used.
The generated code is automatically formatted using ruff.
Running Tests
Run the schema preprocessing test suite with:
python -m unittest discover -s tests -p "test_*.py"
Contributing
We welcome community contributions. See our Contribution Guide for details.
License
UCP is an open-source project under the Apache License 2.0.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ucp_sdk-0.4.4.tar.gz.
File metadata
- Download URL: ucp_sdk-0.4.4.tar.gz
- Upload date:
- Size: 63.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8c90c03dc4ba605110d1422d57b47f7bd3ab10f2434ca847f9e6eefc9b7ea372
|
|
| MD5 |
e3ac7bfeceb7358456ca665f61741dbb
|
|
| BLAKE2b-256 |
9a1038ff48b28a1387de10371f61194b90f8aa1ee0764e00c92f2fd80caedc52
|
Provenance
The following attestation bundles were made for ucp_sdk-0.4.4.tar.gz:
Publisher:
release.yml on Universal-Commerce-Protocol/python-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ucp_sdk-0.4.4.tar.gz -
Subject digest:
8c90c03dc4ba605110d1422d57b47f7bd3ab10f2434ca847f9e6eefc9b7ea372 - Sigstore transparency entry: 2334091618
- Sigstore integration time:
-
Permalink:
Universal-Commerce-Protocol/python-sdk@ba23d978b772eeea615bbb46767b8ed74b8dddfd -
Branch / Tag:
refs/tags/v2026-04-08-4 - Owner: https://github.com/Universal-Commerce-Protocol
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@ba23d978b772eeea615bbb46767b8ed74b8dddfd -
Trigger Event:
release
-
Statement type:
File details
Details for the file ucp_sdk-0.4.4-py3-none-any.whl.
File metadata
- Download URL: ucp_sdk-0.4.4-py3-none-any.whl
- Upload date:
- Size: 167.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a686336624f5535a1f7cedb96cb49fc90db7e6c5f65384d899f4730abe8af392
|
|
| MD5 |
8fcce3ea4ace58158f0058fad3e7c60e
|
|
| BLAKE2b-256 |
cd6fed84ef08ebd9c1548d6748d3da84ff3ac04db72c0ae688e7168b5b701d00
|
Provenance
The following attestation bundles were made for ucp_sdk-0.4.4-py3-none-any.whl:
Publisher:
release.yml on Universal-Commerce-Protocol/python-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ucp_sdk-0.4.4-py3-none-any.whl -
Subject digest:
a686336624f5535a1f7cedb96cb49fc90db7e6c5f65384d899f4730abe8af392 - Sigstore transparency entry: 2334091622
- Sigstore integration time:
-
Permalink:
Universal-Commerce-Protocol/python-sdk@ba23d978b772eeea615bbb46767b8ed74b8dddfd -
Branch / Tag:
refs/tags/v2026-04-08-4 - Owner: https://github.com/Universal-Commerce-Protocol
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@ba23d978b772eeea615bbb46767b8ed74b8dddfd -
Trigger Event:
release
-
Statement type:
