Skip to main content

A client module for accessing the Trixel Management Service (API)

Project description

This python client module for the Trixel Management Service was entirely generated using openapi-pyhton-client.


trixelmanagementclient

A client library for accessing Trixel Management Service

Usage

First, create a client:

from trixelmanagementclient import Client

client = Client(base_url="https://api.example.com")

If the endpoints you're going to hit require authentication, use AuthenticatedClient instead:

from trixelmanagementclient import AuthenticatedClient

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

Now call your endpoint and use your models:

from trixelmanagementclient.models import MyDataModel
from trixelmanagementclient.api.my_tag import get_my_data_model
from trixelmanagementclient.types import Response

with client as client:
    my_data: MyDataModel = get_my_data_model.sync(client=client)
    # or if you need more info (e.g. status_code)
    response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)

Or do the same thing with an async version:

from trixelmanagementclient.models import MyDataModel
from trixelmanagementclient.api.my_tag import get_my_data_model
from trixelmanagementclient.types import Response

async with client as client:
    my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
    response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)

By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

You can also disable certificate validation altogether, but beware that this is a security risk.

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

Things to know:

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

    1. sync: Blocking request that returns parsed data (if successful) or None
    2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
    3. asyncio: Like sync but async instead of blocking
    4. asyncio_detailed: Like sync_detailed but async instead of blocking
  2. All path/query params, and bodies become method arguments.

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

  4. Any endpoint which did not have a tag will be in trixelmanagementclient.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 trixelmanagementclient 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 trixelmanagementclient 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"))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trixelmanagementclient-0.2.0.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

trixelmanagementclient-0.2.0-py3-none-any.whl (41.4 kB view details)

Uploaded Python 3

File details

Details for the file trixelmanagementclient-0.2.0.tar.gz.

File metadata

File hashes

Hashes for trixelmanagementclient-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d5d527e0bfad4127f844fe34fbe2cf6dd01c81129f9b87740b639a5bfcb67e4b
MD5 c6a37005730c4cb7fd4239a963c48c86
BLAKE2b-256 9562c0ca9a540f6163170fe0f27f2e814327f1995e9b1f97d2880794effc92b2

See more details on using hashes here.

File details

Details for the file trixelmanagementclient-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for trixelmanagementclient-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 704312a5d4675a94f1bdd93cc70ca78bf3336ec81fe2d64b558568225d691fe0
MD5 46acbb6ad4927a071275cf289608d3cb
BLAKE2b-256 f8116138b01e015b4c382b0cdf1e153cef63580f5f36f9011bca792f5f560fcf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page