trello-sdk

Getting Started with Trello

Introduction

This document describes the REST API of Trello as published by Trello.com.

• Official Documentation
• The HTML pages that were scraped in order to generate this specification.

Find out more here: https://developers.trello.com

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install trello-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/trello-sdk/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
api_key_credentials	ApiKeyCredentials	The credential object for Custom Query Parameter
api_token_credentials	ApiTokenCredentials	The credential object for Custom Query Parameter

The API client can be initialized as follows:

from trello.configuration import Environment
from trello.http.auth.api_key import ApiKeyCredentials
from trello.http.auth.api_token import ApiTokenCredentials
from trello.trello_client import TrelloClient

client = TrelloClient(
    api_key_credentials=ApiKeyCredentials(
        key='key'
    ),
    api_token_credentials=ApiTokenCredentials(
        token='token'
    ),
    environment=Environment.PRODUCTION
)

Authorization

This API uses the following authentication schemes.

• api_key (Custom Query Parameter)
• api_token (Custom Query Parameter)

List of APIs

• Action
• Batch
• Board
• Card
• Checklist
• Label
• List
• Member
• Notification
• Organization
• Search
• Session
• Token
• Type
• Webhook

SDK Infrastructure

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime