⚜️ Clientele
Generate loveable Python HTTP API Clients
Clientele lets you generate fully-typed, pythonic HTTP API Clients using an OpenAPI schema.
It's easy to use:
# Install as a global tool - it's not a dependency!
pipx install clientele
# Generate a client
clientele generate -u https://raw.githubusercontent.com/phalt/clientele/main/example_openapi_specs/best.json -o api_client/
Generated code
The generated code is designed by python developers, for python developers.
It uses modern tooling and has a great developer experience.
from my_api import client, schemas
# Pydantic models for inputs and outputs
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.
Async support
You can choose to generate either a sync or an async client - we support both:
from my_async_api import client
# Async client functions
response = await client.simple_request_simple_request_get()
Other features
- Written entirely in Python.
- Designed to work with FastAPI's and Ddrf-spectacular's OpenAPI schema generator.
- The generated client only depends on httpx and Pydantic 2.4.
- HTTP Basic and HTTP Bearer authentication support.
- Support your own configuration - we provide an entry point that will never be overwritten.
- Designed for easy testing with respx.
- API updated? Just run the same command again and check the git diff.
- Automatically formats the generated client with black.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file clientele-0.7.0.tar.gz.
File metadata
- Download URL: clientele-0.7.0.tar.gz
- Upload date:
- Size: 16.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.8.10 Linux/5.15.0-87-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e393a81bdee06b24749e128b3c270811ab78457163aa1374747eace157becbd1
|
|
| MD5 |
927c313ffd6b3bc1dbddd77caf060b01
|
|
| BLAKE2b-256 |
da71c598d443a10405438961e63a7428711f3bd64a805ca5b581f659cf0dc068
|
File details
Details for the file clientele-0.7.0-py3-none-any.whl.
File metadata
- Download URL: clientele-0.7.0-py3-none-any.whl
- Upload date:
- Size: 26.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.8.10 Linux/5.15.0-87-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f8f9c659ffeeab6fd78b200236ae4c1c3df82053ea7c2c18faae451245910ac
|
|
| MD5 |
f2ccd36b7a2f8dc3ba4776a2f3295cb7
|
|
| BLAKE2b-256 |
b4a72f5dd1eb58efa233b1301db8b4926f53bb5f8a6a2c819c407954a7bb3293
|
