Skip to main content

Tillcast Python Library

fern shield pypi

Pre-release (0.x). The Tillcast API is live, but method names can still change before 1.0, so pin the version.

Table of Contents

Documentation

API reference documentation is available here.

Installation

pip install tillcast

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from tillcast import Tillcast

client = Tillcast(
    token="<token>",
)

client.customers.create(
    idempotency_key="order-4711-bill",
    client_reference_id="acct-1042",
    name="Baltic Hotels Sp. z o.o.",
)

Environments

This SDK allows you to configure different environments for API requests.

from tillcast import Tillcast
from tillcast.environment import TillcastEnvironment

client = Tillcast(
    environment=TillcastEnvironment.PRODUCTION,
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from tillcast import AsyncTillcast

client = AsyncTillcast(
    token="<token>",
)


async def main() -> None:
    await client.customers.create(
        idempotency_key="order-4711-bill",
        client_reference_id="acct-1042",
        name="Baltic Hotels Sp. z o.o.",
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from tillcast.core.api_error import ApiError

try:
    client.customers.create(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from tillcast import Tillcast

client = Tillcast(...)
response = client.customers.with_raw_response.create(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

recommended: retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 502 (Bad Gateway)
  • 503 (Service Unavailable)
  • 504 (Gateway Timeout)

Use the max_retries request option to configure this behavior.

client.customers.create(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from tillcast import Tillcast

client = Tillcast(..., timeout=20.0)

# Override timeout for a specific method
client.customers.create(..., request_options={
    "timeout": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from tillcast import Tillcast

client = Tillcast(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

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 tillcast 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tillcast 0.2.0
File Size Uploaded Provenance Actions
tillcast-0.2.0.tar.gz 102.8 kB Without provenance Details for tillcast-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tillcast 0.2.0
File Interpreter ABI Platform Actions
tillcast-0.2.0-py3-none-any.whl Python 3 none any Details for tillcast-0.2.0-py3-none-any.whl

Total release size: 300.8 kB

Release files / tillcast-0.2.0.tar.gz

Download URL tillcast-0.2.0.tar.gz
Size 102.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3c115369bcf0ffc8c150a58928d9facd2761e43a25de29035d7feb53558d2062
BLAKE2b-256 checksum
How to use checksums
f9374824c5cb53b5834487b4b7beed7bb635e005005e092e0cb6a95af91f8dd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / tillcast-0.2.0-py3-none-any.whl

Download URL tillcast-0.2.0-py3-none-any.whl
Size 198.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f4ddc0a87604a3fe9f25383342928c25fde26a46b1bf8c507e3c73dc04cec887
BLAKE2b-256 checksum
How to use checksums
193f973966e3730b1e29bb8ded8342e549a95dc267c832b413d68b88a579ffee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Security for tillcast 0.2.0

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page