x402/python/CONTRIBUTING.md

300 lines
6.8 KiB
Markdown
Raw Permalink Normal View History

Development v2 (#705) * chore: move packages, examples and e2e clients/servers/facilitators to legacy subfolders * feat: added @x402/core to /typescript/packages * feat: added @x402/evm to /typescript/packages/mechanism * feat: added @x402/svm to /typescript/packages/mechanism * feat: added @x402/extensions to /typescript/packages * feat: added @x402/fetch to /typescript/packages/http * feat: added @x402/axios to /typescript/packages/http * feat: added @x402/paywall to /typescript/packages/http * feat: added @x402/express to /typescript/packages/http * feat: added @x402/hono to /typescript/packages/http * feat: added @x402/next to /typescript/packages/http * chore: update /typescript pnpm packaging * feat: added core files to /go * feat: added evm mechanism to /go * feat: added svm mechanism to /go * feat: added extensions to /go * feat: added gin to /go/http * feat: added tests to /go * feat: rewrote e2e test suite system * feat: added axios client to e2e suite * feat: added fetch client to e2e suite * feat: added go http client to e2e suite * feat: added express server to e2e suite * feat: added hono server to e2e suite * feat: added next server to e2e suite * feat: added gin server to e2e suite * feat: added typescript facilitator to e2e suite * feat: added go facilitator to e2e suite * feat: added fetch example to examples/typescript/clients * feat: added axios example to examples/typescript/clients * feat: added advanced example to examples/typescript/clients * feat: added custom example to examples/typescript/clients * feat: added express example to examples/typescript/servers * feat: added hono example to examples/typescript/servers * feat: added advanced example to examples/typescript/servers * feat: added custom example to examples/typescript/servers * feat: added facilitator example to examples/typescript * chore: update /examples/typescript pnpm packaging * feat: added http client to examples/go/clients * feat: added advanced client to examples/go/clients * feat: added custom client to examples/go/clients * feat: added gin server to examples/go/servers * feat: added advanced server to examples/go/servers * feat: added custom server to examples/go/servers * feat: added facilitator to examples/go * chore: updated github workflows * fix: typescript examples fotmat/lint * v2: next example (#706) * fix legacy example builds * add next example * fix format * upgrade to next 16 * fix legacy build * fix e2e tests * V2: next api wrapper (#707) * add next route wrapper * add protected api to example page * add unit tests * fix missing settle failure check * added e2e tests for withX402 * add SettleResponse to ProcessSettleResultResponse * add requirements to payment-header * feat: add v2 support to x402.org facilitator * feat: dynamically load bazaar extension in Next only when used * fix: x402Facilitator in typescript calling onAfterVerify instead on onVerifyFailure on failure * feat: add ERC1271 and ERC6492 support to Typescript facilitator * feat: update typescript facilitator example & e2e test for ERC1271/ERC6492 support * feat: add ERC1271 and ERC6492 support to Go facilitators * feat: update go facilitator example & e2e test for ERC1271/ERC6492 support * v2: express fixes + unit tests (#712) * add express fixes from v1 * add units test for express/hono * added fetch/axios unit tests * v2: Clean up paywall (#710) * Remove cdpClientKey and sessionTokenEndpoint from PaywallConfig Remove Onramp functionality from EvmPaywall Remove Coinbase fields from paywall template generation * Migrate site to @x402/next with v2 protocol support * Clean up tests * remove CDP onramp from core paywall * Update templates and build process * Format * Lockfile * mock templates for CI * Format * Generate new templates * Format * v2: facilitator sync fix (#716) * update next/react versions * update site to next 16, tailwind 4 and fix env vars * fix initializeOnStart pattern * security: bump quic-go dependency for security fix GHSA-47m2-4cr7-mhcw * v2:fix ts advanced/custom examples (#717) * fix ts examples * add clients/advanced/preferred-network example * feat: improved e2e cli for external facilitator testing * feat: updated evm & svm signer interfaces in go * feat: updated evm & svm signer interfaces in typescript * feat: reverted SupportedKind's kinds structure in go * feat: reverted SupportedKind's kinds structure in typescript * feat: refactor facilitator SVM signer interface in typescript * go example fixes (#719) * feat: cleanup go bazaar extension * V2: docs update (#729) * ts example docs * improve ts package docs * feat: dynamic bazaar import for all server middleware * feat: allow dynamic response building for 402 response in typescript * feat: allow dynamic response building for 402 response in go * feat: added withBazaar HTTPFacilitatorClient wrapper * feat: added linting to go * fix: lint go * improve go example docs (#733) * feat: Solana PR review feedback in typescript * feat: Solana PR review feedback in go * fix: locks & paywall gen after rebase off main * fix: format * docs: improve @x402/extensions README with comprehensive documentation (#731) * First draft of contributor docs (#738) Correct ts contributing Clean up contribution guidelines * feat: updated specs for v2 * fix: merge with main, fixed lock * v2: go settlement failure and initOnStart fixes (#720) * go settlement failure and initOnStart fixes * update go unit tests * update readmes * feat: review & improve examples & READMEs * v2: add multiple payment options for go (#743) * add multiple payment options for go * fix SyncFacilitatorOnStart * v2: add hooks for advanced go example (#745) * add hooks for advanced go example * fix legacy ts deps * feat: added server initialization validation * feat: added @x402 package workflows * v2: add miniapp and mcp examples (#746) * add miniapp example * fix format * add mcp example * fix format * v2: add manifest to miniapp example (#751) * add manifest to miniapp * fix format * feat: x402 website redesign (#750) * port new website to public repo * chore: update pnpm-lock.yaml with motion dependency * feat: add x402 V2 launch blog post and update hero code snippet - Add /writing/x402-v2-launch blog post page - Add blog images (blog_intro.png, blog_x402_layers.png, homepage_build5.png) - Enable Writing nav link in NavBar and Footer - Update hero code snippet to show V2 SDK usage - Fix CodeSnippet to support multi-line code * feat: edit nav for mobile * Revert "feat: edit nav for mobile" This reverts commit 475999a2a84f1fab875cd0fe2bb74d44dba7e1bd. * feat: add ecosystem page and minor home page tweaks * feat: fix typography in ecosystem * homepage qa fixes * feat: add ecosystem icons and fix halftone * cleanup assets * fix: minor bug on faq * feat: add hamburger menu to mobile * Update README (#755) * Update readme * Install instructions and typos * feat: update site sample code & reduce supported networks * fix: v1 header in README updated to v2 --------- Co-authored-by: phdargen <p.dargent@cern.ch> Co-authored-by: A. McDermott <amanda.p.mcdermott@gmail.com> Co-authored-by: Vedant Anand <136731196+VedantAnand17@users.noreply.github.com> Co-authored-by: Faris Habib <frs@hbb.dev> Co-authored-by: erikreppel-cb <erik.reppel@coinbase.com>
2025-12-11 07:41:57 -08:00
# Python SDK Contributing Guide
Guide for developing and contributing to the x402 Python SDK.
## Contents
- [Repository Structure](#repository-structure)
- [Development Setup](#development-setup)
- [Development Workflow](#development-workflow)
- [Adding Features](#adding-features)
- [Testing](#testing)
- [Code Quality](#code-quality)
- [Changelog](#changelog)
Development v2 (#705) * chore: move packages, examples and e2e clients/servers/facilitators to legacy subfolders * feat: added @x402/core to /typescript/packages * feat: added @x402/evm to /typescript/packages/mechanism * feat: added @x402/svm to /typescript/packages/mechanism * feat: added @x402/extensions to /typescript/packages * feat: added @x402/fetch to /typescript/packages/http * feat: added @x402/axios to /typescript/packages/http * feat: added @x402/paywall to /typescript/packages/http * feat: added @x402/express to /typescript/packages/http * feat: added @x402/hono to /typescript/packages/http * feat: added @x402/next to /typescript/packages/http * chore: update /typescript pnpm packaging * feat: added core files to /go * feat: added evm mechanism to /go * feat: added svm mechanism to /go * feat: added extensions to /go * feat: added gin to /go/http * feat: added tests to /go * feat: rewrote e2e test suite system * feat: added axios client to e2e suite * feat: added fetch client to e2e suite * feat: added go http client to e2e suite * feat: added express server to e2e suite * feat: added hono server to e2e suite * feat: added next server to e2e suite * feat: added gin server to e2e suite * feat: added typescript facilitator to e2e suite * feat: added go facilitator to e2e suite * feat: added fetch example to examples/typescript/clients * feat: added axios example to examples/typescript/clients * feat: added advanced example to examples/typescript/clients * feat: added custom example to examples/typescript/clients * feat: added express example to examples/typescript/servers * feat: added hono example to examples/typescript/servers * feat: added advanced example to examples/typescript/servers * feat: added custom example to examples/typescript/servers * feat: added facilitator example to examples/typescript * chore: update /examples/typescript pnpm packaging * feat: added http client to examples/go/clients * feat: added advanced client to examples/go/clients * feat: added custom client to examples/go/clients * feat: added gin server to examples/go/servers * feat: added advanced server to examples/go/servers * feat: added custom server to examples/go/servers * feat: added facilitator to examples/go * chore: updated github workflows * fix: typescript examples fotmat/lint * v2: next example (#706) * fix legacy example builds * add next example * fix format * upgrade to next 16 * fix legacy build * fix e2e tests * V2: next api wrapper (#707) * add next route wrapper * add protected api to example page * add unit tests * fix missing settle failure check * added e2e tests for withX402 * add SettleResponse to ProcessSettleResultResponse * add requirements to payment-header * feat: add v2 support to x402.org facilitator * feat: dynamically load bazaar extension in Next only when used * fix: x402Facilitator in typescript calling onAfterVerify instead on onVerifyFailure on failure * feat: add ERC1271 and ERC6492 support to Typescript facilitator * feat: update typescript facilitator example & e2e test for ERC1271/ERC6492 support * feat: add ERC1271 and ERC6492 support to Go facilitators * feat: update go facilitator example & e2e test for ERC1271/ERC6492 support * v2: express fixes + unit tests (#712) * add express fixes from v1 * add units test for express/hono * added fetch/axios unit tests * v2: Clean up paywall (#710) * Remove cdpClientKey and sessionTokenEndpoint from PaywallConfig Remove Onramp functionality from EvmPaywall Remove Coinbase fields from paywall template generation * Migrate site to @x402/next with v2 protocol support * Clean up tests * remove CDP onramp from core paywall * Update templates and build process * Format * Lockfile * mock templates for CI * Format * Generate new templates * Format * v2: facilitator sync fix (#716) * update next/react versions * update site to next 16, tailwind 4 and fix env vars * fix initializeOnStart pattern * security: bump quic-go dependency for security fix GHSA-47m2-4cr7-mhcw * v2:fix ts advanced/custom examples (#717) * fix ts examples * add clients/advanced/preferred-network example * feat: improved e2e cli for external facilitator testing * feat: updated evm & svm signer interfaces in go * feat: updated evm & svm signer interfaces in typescript * feat: reverted SupportedKind's kinds structure in go * feat: reverted SupportedKind's kinds structure in typescript * feat: refactor facilitator SVM signer interface in typescript * go example fixes (#719) * feat: cleanup go bazaar extension * V2: docs update (#729) * ts example docs * improve ts package docs * feat: dynamic bazaar import for all server middleware * feat: allow dynamic response building for 402 response in typescript * feat: allow dynamic response building for 402 response in go * feat: added withBazaar HTTPFacilitatorClient wrapper * feat: added linting to go * fix: lint go * improve go example docs (#733) * feat: Solana PR review feedback in typescript * feat: Solana PR review feedback in go * fix: locks & paywall gen after rebase off main * fix: format * docs: improve @x402/extensions README with comprehensive documentation (#731) * First draft of contributor docs (#738) Correct ts contributing Clean up contribution guidelines * feat: updated specs for v2 * fix: merge with main, fixed lock * v2: go settlement failure and initOnStart fixes (#720) * go settlement failure and initOnStart fixes * update go unit tests * update readmes * feat: review & improve examples & READMEs * v2: add multiple payment options for go (#743) * add multiple payment options for go * fix SyncFacilitatorOnStart * v2: add hooks for advanced go example (#745) * add hooks for advanced go example * fix legacy ts deps * feat: added server initialization validation * feat: added @x402 package workflows * v2: add miniapp and mcp examples (#746) * add miniapp example * fix format * add mcp example * fix format * v2: add manifest to miniapp example (#751) * add manifest to miniapp * fix format * feat: x402 website redesign (#750) * port new website to public repo * chore: update pnpm-lock.yaml with motion dependency * feat: add x402 V2 launch blog post and update hero code snippet - Add /writing/x402-v2-launch blog post page - Add blog images (blog_intro.png, blog_x402_layers.png, homepage_build5.png) - Enable Writing nav link in NavBar and Footer - Update hero code snippet to show V2 SDK usage - Fix CodeSnippet to support multi-line code * feat: edit nav for mobile * Revert "feat: edit nav for mobile" This reverts commit 475999a2a84f1fab875cd0fe2bb74d44dba7e1bd. * feat: add ecosystem page and minor home page tweaks * feat: fix typography in ecosystem * homepage qa fixes * feat: add ecosystem icons and fix halftone * cleanup assets * fix: minor bug on faq * feat: add hamburger menu to mobile * Update README (#755) * Update readme * Install instructions and typos * feat: update site sample code & reduce supported networks * fix: v1 header in README updated to v2 --------- Co-authored-by: phdargen <p.dargent@cern.ch> Co-authored-by: A. McDermott <amanda.p.mcdermott@gmail.com> Co-authored-by: Vedant Anand <136731196+VedantAnand17@users.noreply.github.com> Co-authored-by: Faris Habib <frs@hbb.dev> Co-authored-by: erikreppel-cb <erik.reppel@coinbase.com>
2025-12-11 07:41:57 -08:00
## Repository Structure
The Python SDK is a single package using `uv` for dependency management.
```
python/
└── x402/
├── pyproject.toml
├── uv.lock
├── src/
│ └── x402/
│ ├── __init__.py
│ ├── types.py # Core types (Pydantic models)
│ ├── encoding.py # Base64 encoding utilities
│ ├── exact.py # Exact scheme implementation
│ ├── facilitator.py # Facilitator client
│ ├── clients/
│ │ ├── base.py # Base client logic
│ │ ├── httpx.py # httpx client integration
│ │ └── requests.py # requests client integration
│ ├── fastapi/
│ │ └── middleware.py # FastAPI middleware
│ └── flask/
│ └── middleware.py # Flask middleware
└── tests/
├── clients/
├── fastapi_tests/
└── flask_tests/
```
## Development Setup
### Prerequisites
- Python >= 3.10
- [uv](https://docs.astral.sh/uv/) (recommended) or pip
### Installation with uv
```bash
cd python/x402
# Install uv if you don't have it
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install dependencies
uv sync --all-extras --dev
```
### Installation with pip
```bash
cd python/x402
pip install -e ".[dev]"
```
## Development Workflow
### Common Commands
From the `python/x402/` directory:
| Command | Description |
|---------|-------------|
| `uv sync --dev` | Install/update dependencies |
| `uv run pytest` | Run tests |
| `uvx ruff check` | Lint code |
| `uvx ruff check --fix` | Lint and fix |
| `uvx ruff format` | Format code |
### Running the Package Locally
```bash
# Install in development mode
uv sync --dev
# Import and use
uv run python -c "from x402 import PaymentRequirements; print(PaymentRequirements)"
```
## Adding Features
### Adding a New HTTP Client
To add support for a new HTTP client library:
1. Create a new file in `src/x402/clients/`:
```python
# src/x402/clients/your_client.py
from x402.clients.base import BaseX402Client
class x402YourClient(BaseX402Client):
"""x402 client wrapper for your-library."""
def __init__(self, account, **kwargs):
super().__init__(account)
# Initialize your client
# Implement payment handling hooks
```
2. Export from `src/x402/clients/__init__.py`
3. Add tests in `tests/clients/test_your_client.py`
### Adding a New Framework Middleware
To add middleware for a new web framework:
1. Create a new directory in `src/x402/`:
```
src/x402/your_framework/
├── __init__.py
└── middleware.py
```
2. Implement the middleware pattern. Reference `src/x402/fastapi/middleware.py` or `src/x402/flask/middleware.py`.
3. Key responsibilities:
- Check for payment header on protected routes
- Return 402 with `PaymentRequiredResponse` if no/invalid payment
- Call facilitator to verify and settle payments
- Add `X-PAYMENT-RESPONSE` header on success
4. Add the dependency to `pyproject.toml`:
```toml
dependencies = [
# ... existing deps
"your-framework>=1.0.0",
]
```
5. Add tests in `tests/your_framework_tests/`
### Adding a New Chain Mechanism
See [New Chains](../CONTRIBUTING.md#new-chains) in the root contributing guide for protocol-level requirements.
To add support for a new blockchain in Python:
1. Create the mechanism file in `src/x402/your_chain.py`
```python
# src/x402/your_chain.py
from x402.types import PaymentPayload, PaymentRequirements
def sign_payload(
payload: PaymentPayload,
requirements: PaymentRequirements,
signer: YourChainSigner
) -> PaymentPayload:
"""Sign a payment payload for your chain."""
# Implement signing logic
pass
```
2. Integrate with the client in `src/x402/clients/base.py`
3. Reference `src/x402/exact.py` for the existing EVM implementation pattern
## Testing
### Running Tests
```bash
# All tests
uv run pytest
# Specific test file
uv run pytest tests/test_types.py
# Specific test
uv run pytest tests/test_types.py::test_payment_requirements
# With verbose output
uv run pytest -v
# With coverage
uv run pytest --cov=x402
```
### Test Organization
```
tests/
├── clients/
│ ├── test_base.py
│ ├── test_httpx.py
│ └── test_requests.py
├── fastapi_tests/
│ └── test_middleware.py
├── flask_tests/
│ └── test_middleware.py
├── test_encoding.py
├── test_exact.py
├── test_paywall.py
└── test_types.py
```
### Async Tests
The package uses `pytest-asyncio` with auto mode. Async tests work automatically:
```python
async def test_async_operation():
result = await some_async_function()
assert result is not None
```
## Code Quality
### Linting
The project uses [Ruff](https://docs.astral.sh/ruff/) for linting:
```bash
# Check for issues
uvx ruff check
# Fix auto-fixable issues
uvx ruff check --fix
```
### Formatting
```bash
uvx ruff format
```
### Type Hints
The package uses Pydantic for runtime validation and includes `py.typed` for type checker support. All public APIs should have type hints:
```python
def create_payment(
amount: str,
pay_to: str,
network: str = "eip155:8453"
) -> PaymentRequirements:
...
```
## Changelog
These instructions apply to the **`python/x402` package (v2)**.
For **user-facing changes** (behavior changes, bug fixes, new features, removals), add a Towncrier fragment:
- Location: `python/x402/changelog.d/<PR>.<type>.md`
- Naming convention: `<PR>.<type>.md` (for example, `123.bugfix.md`)
- Allowed types: `feature|bugfix|doc|removal|misc`
Create a fragment (from `python/x402/`):
```bash
uv run towncrier create --content "Fixed ..." 123.bugfix.md
```
### Building the Changelog (Maintainers)
During release, consolidate fragments:
```bash
uv run towncrier build --yes --version=X.Y.Z
```
Development v2 (#705) * chore: move packages, examples and e2e clients/servers/facilitators to legacy subfolders * feat: added @x402/core to /typescript/packages * feat: added @x402/evm to /typescript/packages/mechanism * feat: added @x402/svm to /typescript/packages/mechanism * feat: added @x402/extensions to /typescript/packages * feat: added @x402/fetch to /typescript/packages/http * feat: added @x402/axios to /typescript/packages/http * feat: added @x402/paywall to /typescript/packages/http * feat: added @x402/express to /typescript/packages/http * feat: added @x402/hono to /typescript/packages/http * feat: added @x402/next to /typescript/packages/http * chore: update /typescript pnpm packaging * feat: added core files to /go * feat: added evm mechanism to /go * feat: added svm mechanism to /go * feat: added extensions to /go * feat: added gin to /go/http * feat: added tests to /go * feat: rewrote e2e test suite system * feat: added axios client to e2e suite * feat: added fetch client to e2e suite * feat: added go http client to e2e suite * feat: added express server to e2e suite * feat: added hono server to e2e suite * feat: added next server to e2e suite * feat: added gin server to e2e suite * feat: added typescript facilitator to e2e suite * feat: added go facilitator to e2e suite * feat: added fetch example to examples/typescript/clients * feat: added axios example to examples/typescript/clients * feat: added advanced example to examples/typescript/clients * feat: added custom example to examples/typescript/clients * feat: added express example to examples/typescript/servers * feat: added hono example to examples/typescript/servers * feat: added advanced example to examples/typescript/servers * feat: added custom example to examples/typescript/servers * feat: added facilitator example to examples/typescript * chore: update /examples/typescript pnpm packaging * feat: added http client to examples/go/clients * feat: added advanced client to examples/go/clients * feat: added custom client to examples/go/clients * feat: added gin server to examples/go/servers * feat: added advanced server to examples/go/servers * feat: added custom server to examples/go/servers * feat: added facilitator to examples/go * chore: updated github workflows * fix: typescript examples fotmat/lint * v2: next example (#706) * fix legacy example builds * add next example * fix format * upgrade to next 16 * fix legacy build * fix e2e tests * V2: next api wrapper (#707) * add next route wrapper * add protected api to example page * add unit tests * fix missing settle failure check * added e2e tests for withX402 * add SettleResponse to ProcessSettleResultResponse * add requirements to payment-header * feat: add v2 support to x402.org facilitator * feat: dynamically load bazaar extension in Next only when used * fix: x402Facilitator in typescript calling onAfterVerify instead on onVerifyFailure on failure * feat: add ERC1271 and ERC6492 support to Typescript facilitator * feat: update typescript facilitator example & e2e test for ERC1271/ERC6492 support * feat: add ERC1271 and ERC6492 support to Go facilitators * feat: update go facilitator example & e2e test for ERC1271/ERC6492 support * v2: express fixes + unit tests (#712) * add express fixes from v1 * add units test for express/hono * added fetch/axios unit tests * v2: Clean up paywall (#710) * Remove cdpClientKey and sessionTokenEndpoint from PaywallConfig Remove Onramp functionality from EvmPaywall Remove Coinbase fields from paywall template generation * Migrate site to @x402/next with v2 protocol support * Clean up tests * remove CDP onramp from core paywall * Update templates and build process * Format * Lockfile * mock templates for CI * Format * Generate new templates * Format * v2: facilitator sync fix (#716) * update next/react versions * update site to next 16, tailwind 4 and fix env vars * fix initializeOnStart pattern * security: bump quic-go dependency for security fix GHSA-47m2-4cr7-mhcw * v2:fix ts advanced/custom examples (#717) * fix ts examples * add clients/advanced/preferred-network example * feat: improved e2e cli for external facilitator testing * feat: updated evm & svm signer interfaces in go * feat: updated evm & svm signer interfaces in typescript * feat: reverted SupportedKind's kinds structure in go * feat: reverted SupportedKind's kinds structure in typescript * feat: refactor facilitator SVM signer interface in typescript * go example fixes (#719) * feat: cleanup go bazaar extension * V2: docs update (#729) * ts example docs * improve ts package docs * feat: dynamic bazaar import for all server middleware * feat: allow dynamic response building for 402 response in typescript * feat: allow dynamic response building for 402 response in go * feat: added withBazaar HTTPFacilitatorClient wrapper * feat: added linting to go * fix: lint go * improve go example docs (#733) * feat: Solana PR review feedback in typescript * feat: Solana PR review feedback in go * fix: locks & paywall gen after rebase off main * fix: format * docs: improve @x402/extensions README with comprehensive documentation (#731) * First draft of contributor docs (#738) Correct ts contributing Clean up contribution guidelines * feat: updated specs for v2 * fix: merge with main, fixed lock * v2: go settlement failure and initOnStart fixes (#720) * go settlement failure and initOnStart fixes * update go unit tests * update readmes * feat: review & improve examples & READMEs * v2: add multiple payment options for go (#743) * add multiple payment options for go * fix SyncFacilitatorOnStart * v2: add hooks for advanced go example (#745) * add hooks for advanced go example * fix legacy ts deps * feat: added server initialization validation * feat: added @x402 package workflows * v2: add miniapp and mcp examples (#746) * add miniapp example * fix format * add mcp example * fix format * v2: add manifest to miniapp example (#751) * add manifest to miniapp * fix format * feat: x402 website redesign (#750) * port new website to public repo * chore: update pnpm-lock.yaml with motion dependency * feat: add x402 V2 launch blog post and update hero code snippet - Add /writing/x402-v2-launch blog post page - Add blog images (blog_intro.png, blog_x402_layers.png, homepage_build5.png) - Enable Writing nav link in NavBar and Footer - Update hero code snippet to show V2 SDK usage - Fix CodeSnippet to support multi-line code * feat: edit nav for mobile * Revert "feat: edit nav for mobile" This reverts commit 475999a2a84f1fab875cd0fe2bb74d44dba7e1bd. * feat: add ecosystem page and minor home page tweaks * feat: fix typography in ecosystem * homepage qa fixes * feat: add ecosystem icons and fix halftone * cleanup assets * fix: minor bug on faq * feat: add hamburger menu to mobile * Update README (#755) * Update readme * Install instructions and typos * feat: update site sample code & reduce supported networks * fix: v1 header in README updated to v2 --------- Co-authored-by: phdargen <p.dargent@cern.ch> Co-authored-by: A. McDermott <amanda.p.mcdermott@gmail.com> Co-authored-by: Vedant Anand <136731196+VedantAnand17@users.noreply.github.com> Co-authored-by: Faris Habib <frs@hbb.dev> Co-authored-by: erikreppel-cb <erik.reppel@coinbase.com>
2025-12-11 07:41:57 -08:00
## Examples
Examples live in `examples/python/`. When adding a new example:
1. Create a directory under the appropriate category (`clients/`, `servers/`, `fullstack/`)
2. Add a `pyproject.toml` with dependencies
3. Add a `README.md` with setup and run instructions
## Publishing
Package publishing to PyPI is handled by maintainers via GitHub Actions. Version bumps are made in `pyproject.toml`.
## Getting Help
- Open an issue on GitHub
- Check the [examples](../examples/python/) for usage patterns
- Reference the [README](x402/README.md) for API documentation