Skip to content

docs: add sample walkthrough prerequisites #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carolinerg1 merged 1 commit into from
Aug 17, 2026
Merged

docs: add sample walkthrough prerequisites #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,15 +162,17 @@ uv run checkout_lifecycle_test.py \

## Example Walkthrough: Running against the Python Sample Server

For a quick demonstration or local development, you can run the suite against the reference Python sample server included in this repository.
For a quick demonstration or local development, you can run the suite against the reference Python sample server from the separate [`samples`](https://github.com/Universal-Commerce-Protocol/samples) repository.

NOTE: These instructions assume the commands are executed from the directory containing this README.
NOTE: These instructions assume the `samples`, `python-sdk`, and `conformance` repositories are sibling directories and commands are executed from the directory containing this README.

### Prerequisites

Sync dependencies for the test suite and the sample server:
Clone the sample server and SDK next to this repository, then sync both environments:

```bash
git clone https://github.com/Universal-Commerce-Protocol/samples.git ../samples
git clone https://github.com/Universal-Commerce-Protocol/python-sdk.git ../python-sdk
uv sync
uv sync --directory ../samples/rest/python/server/
```
Expand Down
Loading