Python SDK

IntroCopy Anchor Link

The LogChimp SDK provides access to the LogChimp REST APIs.

LogChimp is open-source customer feedback software: collect feedback as posts on boards, let users vote, and turn it into a public roadmap.

• Website
• Documentation
• GitHub

InstallationCopy Anchor Link

Add the SDK to your project from its folder, with whichever package manager your project uses. Give each tool a path containing a slash, such as ../log-chimp — a bare folder name is looked up on PyPI instead, and resolves to whatever project holds that name there:

pip install <path-to-sdk>

uv add <path-to-sdk>

poetry add <path-to-sdk>

Quick StartCopy Anchor Link

Synchronous clientCopy Anchor Link

Construct LogChimpClient with keyword arguments, and call close() when you are done. Every argument is optional.

from log_chimp import LogChimpClient

client = LogChimpClient(bearer_auth="YOUR_BEARER_TOKEN")

client.close()

Alternatively, scope it — with LogChimpClient(...) as client: closes the pool on exit.

Asynchronous clientCopy Anchor Link

AsyncLogChimpClient mirrors LogChimpClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences — for example, the transport argument is custom_async_http_client.

from asyncio import run

from log_chimp import AsyncLogChimpClient


async def main() -> None:
    client = AsyncLogChimpClient(bearer_auth="YOUR_BEARER_TOKEN")
    await client.aclose()


run(main())

Alternatively, scope it — async with AsyncLogChimpClient(...) as client: closes the pool on exit.