conduktor-public-api-client 0.0.1

Description:

conduktorpublicapiclient 0.0.1

conduktor-public-api-client
A client library for accessing Conduktor Public API
Generated with openapi-python-client generate --path docs.yaml
Usage
First, create a client:
from conduktor_public_api_client import AuthenticatedClient

client = AuthenticatedClient(
base_url="https://api.example.com", token="SuperSecretToken"
)

Things to know:


Every path/method combo becomes a Python module with four functions:

sync: Blocking request that returns parsed data (if successful) or None
sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
asyncio: Like sync but async instead of blocking
asyncio_detailed: Like sync_detailed but async instead of blocking



All path/query params, and bodies become method arguments.


If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)


Any endpoint which did not have a tag will be in conduktor_public_api_client.api.default


Advanced customizations
There are more settings on the generated Client class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying httpx.Client or httpx.AsyncClient (depending on your use-case):
from conduktor_public_api_client import Client


def log_request(request):
print(f"Request event hook: {request.method} {request.url} - Waiting for response")


def log_response(response):
request = response.request
print(
f"Response event hook: {request.method} {request.url} - Status {response.status_code}"
)


client = Client(
base_url="https://api.example.com",
httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
)

# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()

You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
import httpx
from conduktor_public_api_client import Client

client = Client(
base_url="https://api.example.com",
)
# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
client.set_httpx_client(
httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030")
)