clientele 0.6.0

Loveable API Clients from OpenAPI schemas

⚜️ Clientele

Loveable API Clients from OpenAPI schemas

Clientele lets you generate fully-typed, loveable Python API Clients from OpenAPI schemas:

from my_api import client, schemas

# Pydantic-typed inputs
data = schemas.RequestDataRequest(my_input="test")

# Easy to read client functions
response = client.request_data_request_data_post(data=data)

# Handle responses elegantly
match response:
    case schemas.RequestDataResponse():
        # Handle valid response
        ...
    case schemas.ValidationError():
        # Handle validation error
        ...

The generated code is tiny - the example schema we use for documentation and testing only requires 250 lines of code and 5 files.

Choose either sync or async - we support both, and you can switch between them easily:

from my_async_api import client

# Async client functions
response = await client.simple_request_simple_request_get()

All generated from a single command:

# add -asyncio -t to make it async
clientele generate -u https://raw.githubusercontent.com/phalt/clientele/main/example_openapi_specs/best.json -o api_client/

(That works - try it now!)

Other features

• Supports authentication automatically (curently only HTTP Bearer and HTTP Basic auth).
• Written entirely in Python - no need to install any other languages.
• The client footprint only requires httpx and pydantic.
• Support your own configuration - we provide an entry point that will never be overwritten.
• Designed for easy testing with respx.

We're built on:

• Pydantic 2.0
• httpx
• openapi-core