Skip to main content

Async Trello API client for Python

Project description

Trellio - Async Trello API Client for Python

License: GPL v3 Python 3.9+

Trellio is a production-ready, asynchronous Python client for the Trello API, built on httpx and pydantic. Designed for use in long-running services like MCP servers, it provides retry with backoff, request timeouts, structured logging, and full CRUD coverage across 10 Trello resource types.

Features

Infrastructure

  • Async I/O -- built on httpx.AsyncClient, non-blocking
  • Retry with exponential backoff -- automatic retry on 429/5xx, respects Retry-After header, configurable max_retries, initial_delay, backoff_factor
  • Request timeout -- configurable per-client, raises TrelloAPIError on timeout
  • Pagination -- list_boards(limit, since) for single pages, list_all_boards(page_size) async generator for auto-pagination
  • Structured logging -- trellio logger with DEBUG (every request), WARNING (retries), ERROR (failures)
  • Typed exceptions -- TrelloAPIError(status_code, message) for all API errors
  • Pydantic models -- type-safe response objects with alias support for Trello's camelCase API

Resources (46 client methods)

Resource Methods
Auth get_me
Boards list_boards, list_all_boards, create_board, get_board, update_board, delete_board
Lists list_lists, create_list, get_list, update_list
Cards list_cards, create_card, get_card, update_card, delete_card, add_label_to_card, remove_label_from_card
Labels list_board_labels, create_label, update_label, delete_label
Checklists list_card_checklists, create_checklist, get_checklist, delete_checklist, create_check_item, update_check_item, delete_check_item
Comments add_comment, list_comments, update_comment, delete_comment
Members list_board_members, get_member
Attachments list_attachments, create_attachment, get_attachment, upload_attachment, download_attachment, delete_attachment
Webhooks create_webhook, list_webhooks, get_webhook, update_webhook, delete_webhook
Search search

Models

TrelloMember, TrelloBoard, TrelloList, TrelloCard, TrelloLabel, TrelloChecklist, TrelloCheckItem, TrelloComment, TrelloAttachment, TrelloWebhook, TrelloSearchResult

Quick Start

import asyncio
from trellio import TrellioClient

async def main():
    async with TrellioClient(
        api_key="your_key",
        token="your_token",
        max_retries=3,
        timeout=30.0,
    ) as client:
        boards = await client.list_boards()
        for board in boards:
            print(board.name)

        results = await client.search("project")
        for card in results.cards:
            print(card.name)

asyncio.run(main())

MCP Server Usage

from trellio import TrellioClient, TrelloAPIError

client = TrellioClient(
    api_key=os.environ["TRELLO_API_KEY"],
    token=os.environ["TRELLO_TOKEN"],
    max_retries=3,
    initial_delay=1.0,
    timeout=30.0,
)

# Use in MCP tool handlers:
async def handle_create_card(list_id: str, name: str):
    try:
        card = await client.create_card(list_id, name)
        return {"id": card.id, "name": card.name}
    except TrelloAPIError as e:
        return {"error": e.message, "status": e.status_code}

Philosophy: BDD & Single Source of Truth

This project follows strict Behavior-Driven Development (BDD) where Gherkin feature files are the Single Source of Truth for business logic. All implementation is derivative of the specifications.

Test Coverage

The BDD suite covers 19 features, 144 scenarios, 1048 steps:

Feature Scenarios
Authentication 6
Boards 11
Cards 13
Lists 10
Labels 9
Checklists 13
Comments 9
Members 4
Attachments 10
Upload Attachment 6
Download Attachment 5
Webhooks 13
Retry 7
Pagination 4
Connection 2
Timeout 2
Search 4
Logging 3
Large Payload 4
Total 144

Development Setup

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt -r requirements-dev.txt

# Run BDD suite
PYTHONPATH=src python -m behave

# Run mock validation
PYTHONPATH=src pytest tests/validation/

Quick Start with Make

For a fresh checkout, the simplest path is:

make test

This will:

  • create .venv if it does not exist
  • install dependencies if they are not available yet
  • run the validation tests with pytest
  • run the BDD suite with behave

You can also use:

make
make deps
make test-pytest
make test-behave

Architecture Decisions

ADR Title Status
001 Custom Mock Server and Validation Strategy Accepted
002 Mock Strategy: Custom Python vs. MockServer Accepted
003 Failure Path Enumeration Accepted

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

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

trellio_client-1.7.0.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trellio_client-1.7.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file trellio_client-1.7.0.tar.gz.

File metadata

  • Download URL: trellio_client-1.7.0.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for trellio_client-1.7.0.tar.gz
Algorithm Hash digest
SHA256 82731f8d77cbac4e9c1996738a9b56f4990c99e70a3818167fc8942638fe3cf4
MD5 d9bcee79f49f4a2eed2d64b56b320f8c
BLAKE2b-256 cab9dc1ff47a55f31a204e11852a98d462a6b1feceb11e6d13b1b621c6974ea4

See more details on using hashes here.

File details

Details for the file trellio_client-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: trellio_client-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for trellio_client-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0748a5fae10084f0921dc130f69653d339a28133dfc0d69abd567c15bd2155f
MD5 0d7d1dba6ce315321d7dbb9e77a2ae16
BLAKE2b-256 679433d7dcb136a4c052b6d3e197e420f044799f2215d1140f44b46113c9f312

See more details on using hashes here.

Supported by

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