Skip to content

Commit 1bd8b48

Browse files
committed
docs(readme): address PR review comments and fix prettier formatting
1 parent b7b9078 commit 1bd8b48

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,22 @@ Python.
3737

3838
## Installation
3939

40-
Install from PyPI:
40+
To use this SDK in your own project, install it from PyPI:
4141

4242
```bash
4343
pip install ucp-sdk
4444
```
4545

46-
Or with [uv](https://docs.astral.sh/uv/):
46+
Or, if you are managing your project with [uv](https://docs.astral.sh/uv/):
4747

4848
```bash
4949
uv add ucp-sdk
5050
```
5151

5252
## Usage
5353

54-
The SDK provides typed [Pydantic v2](https://docs.pydantic.dev/) models for all
55-
UCP schemas. Import models from `ucp_sdk.models.schemas`:
54+
The SDK provides typed Pydantic v2 models for all UCP schemas. Import models
55+
from `ucp_sdk.models.schemas`:
5656

5757
```python
5858
from ucp_sdk.models.schemas.shopping.checkout import Checkout
@@ -69,12 +69,12 @@ for item in checkout.line_items:
6969

7070
### Available model packages
7171

72-
| Package | Description |
73-
|---------|-------------|
74-
| `ucp_sdk.models.schemas.shopping` | Checkout, cart, order, payment models |
75-
| `ucp_sdk.models.schemas.shopping.types` | Line items, totals, buyer, fulfillment, etc. |
76-
| `ucp_sdk.models.schemas.transports` | REST, MCP, and embedded protocol bindings |
77-
| `ucp_sdk.models.schemas` | Service definitions, capabilities, payment handlers |
72+
| Package | Description |
73+
| --------------------------------------- | --------------------------------------------------- |
74+
| `ucp_sdk.models.schemas.shopping` | Checkout, cart, order, payment models |
75+
| `ucp_sdk.models.schemas.shopping.types` | Line items, totals, buyer, fulfillment, etc. |
76+
| `ucp_sdk.models.schemas.transports` | REST, MCP, and embedded protocol bindings |
77+
| `ucp_sdk.models.schemas` | Service definitions, capabilities, payment handlers |
7878

7979
### Validation
8080

@@ -86,7 +86,7 @@ from ucp_sdk.models.schemas.shopping.checkout import Checkout
8686

8787
# Validate data against UCP schemas
8888
try:
89-
checkout = Checkout.model_validate(data)
89+
checkout = Checkout.model_validate(checkout_data)
9090
# Serialize to JSON-compatible dict
9191
checkout_dict = checkout.model_dump(exclude_none=True)
9292
except ValidationError as e:

0 commit comments

Comments
 (0)