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!
Metadata
Release files for fern-balkan-id 0.0.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fern_balkan_id-0.0.11.tar.gz | 20.1 kB | Without provenance | Details for fern_balkan_id-0.0.11.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fern_balkan_id-0.0.11-py3-none-any.whl | Python 3 | none | any | Details for fern_balkan_id-0.0.11-py3-none-any.whl |
Total release size: 54.6 kB
Release files / fern_balkan_id-0.0.11.tar.gz
| Download URL | fern_balkan_id-0.0.11.tar.gz |
|---|---|
| Size | 20.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e1b4b026a8d6379f176cd6b60c2feb377ca980d2025cbfc74ce00073610b49c6
|
|
BLAKE2b-256 checksum How to use checksums |
c62f5985f00e2b286473f628ec5b4c69fb591a5bfb9b3fea93ce8551715dc6c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.7.17 Linux/5.15.0-1050-azure
|
Release files / fern_balkan_id-0.0.11-py3-none-any.whl
| Download URL | fern_balkan_id-0.0.11-py3-none-any.whl |
|---|---|
| Size | 34.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4d7ed4e6ba7478bad0661d8acae6b9432964d069d1e49f4ed8ed1fb8dfdc950c
|
|
BLAKE2b-256 checksum How to use checksums |
7bf577b8a84a79ccf07f439917e1438e2d29b5902179d402f9f87d39d5348d5f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.7.17 Linux/5.15.0-1050-azure
|
Security for fern-balkan-id 0.0.11
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.