pyramid-client-builder 0.14.7

Introspect Pyramid views and generate an HTTP client for the app

pyramid-client-builder

Introspect a Pyramid application and generate typed HTTP clients — like protoc for gRPC, but for your Pyramid REST API. Generates Python and Go clients in a single invocation.

What it does

pclient-build boots your Pyramid app from its INI file, discovers routes and Cornice services, and generates client packages for multiple languages and HTTP transports. Each variant is written to its own subdirectory.

Pyramid app (INI file)
  → introspect routes, views, schemas
  → generate all client variants:
      python_requests/   (Python + requests)
      python_httpx/      (Python + httpx)
      go/                (Go + net/http)

Quick example

Generate clients from your payments service:

pclient-build development.ini --name payments --output ./generated/

Use the Python client:

from payments_client.client import PaymentsClient

client = PaymentsClient(base_url="http://localhost:6543")

# Methods are named from your URL paths
charges = client.list_charges()
charge = client.get_charge(id=42)
new_charge = client.create_charge(amount=1000, currency="usd")
client.cancel_charge(id=42)

# Versioned APIs get sub-clients
items = client.v1.list_items()

Use the Go client:

import "payments-client"

client := paymentsclient.NewClient(
    "http://localhost:6543",
    paymentsclient.WithAuthToken("your-token"),
)

charges, err := client.V1.ListCharges(nil)
charge, err := client.V1.GetCharge("42")
newCharge, err := client.V1.CreateCharge(&v1.ChargesRequestSchema{
    Amount:   1000,
    Currency: "usd",
})

Installation

pip install pyramid-client-builder

Or with uv:

uv add pyramid-client-builder

Documentation

Full documentation is available at the project docs site, including:

• Getting Started — installation and first client
• CLI Reference — all pclient-build options
• Generated Output — what files are produced
• Usage Guide — standalone and Pyramid integration
• Features — naming, schemas, versioning

Development

git clone https://github.com/cartaorobbin/pyramid-client-builder.git
cd pyramid-client-builder
uv sync --dev

Run tests:

uv run pytest          # single Python version
uv run tox             # full matrix (3.10–3.13)

Lint and format:

uv run ruff check .
uv run black .

Build docs locally:

uv run mkdocs serve

License

MIT