Skip to content

Repository files navigation

httpware

PyPI version Supported Python versions Downloads Coverage CI License GitHub stars Context7 uv Ruff ty

Typed, resilient HTTP clients for Python, sync and async.

Why httpware

  • A 4xx or 5xx response raises an exception named after its status, such as NotFoundError for 404 or RateLimitedError for 429. All of them subclass httpware.StatusError, so you never call raise_for_status().
  • response_model=User decodes the body into your pydantic or msgspec type. If no installed decoder handles the type, the call fails before the request is sent.
  • Retry with a retry budget, bulkhead, circuit breaker, and timeout ship as middleware you compose per client.

httpware is a thin layer over httpx2: requests and responses are plain httpx2.Request and httpx2.Response objects.

Status: Pre-1.0. Public API is subject to change between minor releases until v1.0.

Install

pip install httpware                     # core only, no decoder
pip install httpware[pydantic]           # PydanticDecoder: BaseModel, dataclasses, primitives, generics
pip install httpware[msgspec]            # MsgspecDecoder: Struct, dataclasses, primitives, generics
pip install httpware[pydantic,msgspec]   # both; BaseModel goes to pydantic, Struct to msgspec
pip install httpware[otel]               # OpenTelemetry span events
pip install httpware[all]                # pydantic, msgspec, and otel

Quickstart

A typed GET against a live API (needs pip install httpware[pydantic]):

import asyncio

from httpware import AsyncClient
from pydantic import BaseModel


class User(BaseModel):
    id: int
    name: str


async def main() -> None:
    async with AsyncClient(base_url="https://jsonplaceholder.typicode.com") as client:
        user = await client.get("/users/1", response_model=User)
        print(user.name)  # Leanne Graham


asyncio.run(main())

The sync Client works the same way: use Client instead of AsyncClient, and drop await and async with. A 4xx/5xx response raises a typed StatusError; a malformed body raises DecodeError. Both subclass httpware.ClientError.

Documentation

Full guides live at httpware.modern-python.org:

  • Quickstart: first requests, client options, streaming.
  • Resilience: retry and retry budget, bulkhead, circuit breaker, timeout.
  • Errors: the exception tree and how to catch it.
  • Decoders: typed response bodies and custom decoders.
  • Middleware: writing your own (auth, tracing, request IDs).
  • Observability: logger and event names, OpenTelemetry wiring.
  • Testing: injecting httpx2.MockTransport.
  • Recipes: DI wiring, phase decorators, Link header pagination.

🗒️ Release notes · 📦 PyPI · 📝 License

Part of modern-python

Browse the full list of templates and libraries in modern-python; the org profile has the categorized index.

About

Python HTTP client framework with sync & async clients and built-in resilience

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Sponsor this project

Contributors

Languages