BalkanID Python Library

The BalkanID Python Library provides convenient access to the Balkan-id API from applications written in Python.

Installation

pip install --upgrade fern-balkan-id

Usage

from balkanid.client import BalkanID

client = BalkanID(
    api_key_id="YOUR_API_KEY_ID",
    api_key_secret="YOUR_API_KEY_SECRET",
)

response = client.campaigns.download(include_completed=True, include_draft=False)
print("Received campaigns data", response.url)

Async Client

import asyncio
from balkanid.client import AsyncBalkanID

client = AsyncBalkanID(
    api_key_id="YOUR_API_KEY_ID",
    api_key_secret="YOUR_API_KEY_SECRET",
)

async def get_entity() -> None:
    response = await client.campaigns.download(include_completed=True, include_draft=False)
    print("Received campaigns data", response.url)

asyncio.run(get_entity())

Timeouts

By default, the client is configured to have a timeout of 60 seconds. You can customize this value at client instantiation.

from balkanid.client import BalkanID

client = BalkanID(
    api_key_id="YOUR_API_KEY_ID", 
    api_key_secret="YOUR_API_KEY_SECRET", 
    timeout=15,
)

Handling Exceptions

All exceptions thrown by the SDK will sublcass cohere.ApiError.

from balkanid.core import ApiError

try:
  client.campaigns.download(...)
except APIError as e:
  # handle any api related error

Helper Utilities

When using our API, you may find yourself uploading to and download from presigned URLs. The client exports helper functions you can use to make the API easier to use.

from balkanid.helpers import upload_to_presigned_url

upload_to_presigned_url(
  presigned_url="https://mypresigned_url",
  file_path="/file/path/to/data.csv",
)

Beta Status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version. This way, you can install the same version each time without breaking changes.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!