docs: improve README with PyPI install, usage examples, and badges#27
docs: improve README with PyPI install, usage examples, and badges#27pjordan wants to merge 2 commits intoUniversal-Commerce-Protocol:mainfrom
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Code Review
This pull request enhances the README.md by adding project badges, updating installation instructions for PyPI and uv, and providing detailed usage and validation examples using Pydantic models. Review feedback suggests streamlining the usage example by removing unused imports and improving the validation example's robustness by moving serialization inside the try-except block to prevent potential NameErrors.
Replace clone-based installation with PyPI instructions (pip/uv), add usage examples showing model imports and validation, add a model package reference table, and add PyPI/license badges. Closes Universal-Commerce-Protocol#1
c0e9413 to
644a98d
Compare
Remove unused LineItem and Total imports from usage example. Move serialization inside try-except block and add missing Checkout import in validation example.
| ## Usage | ||
|
|
||
| The SDK provides typed [Pydantic v2](https://docs.pydantic.dev/) models for all | ||
| UCP schemas. Import models from `ucp_sdk.models.schemas`: |
There was a problem hiding this comment.
This is already mentioned in 34:35. Is it also needed here?
| ## Installation | ||
|
|
||
| For now, you can install the SDK using the following commands: | ||
| Install from PyPI: |
There was a problem hiding this comment.
nit: Could you clarify this is installation on another project? For example: "To use this SDK in your own project, install it from PyPI:"
[...]
Or, if you are managing your project with uv:
[...]
cusell-google
left a comment
There was a problem hiding this comment.
Thanks @pjordan for the improvements!
Summary
pip install ucp-sdk/uv add ucp-sdk)Closes #1
Test plan
🤖 Generated with Claude Code