Skip to content

Trello

TrelloReader #

Bases: BaseReader

Trello reader. Reads data from Trello boards and cards.

Parameters:

Name Type Description Default
api_key str

Trello API key.

 required
api_token str

Trello API token.

 required
Source code in llama-index-integrations/readers/llama-index-readers-trello/llama_index/readers/trello/base.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class TrelloReader(BaseReader):
    """Trello reader. Reads data from Trello boards and cards.

    Args:
        api_key (str): Trello API key.
        api_token (str): Trello API token.
    """

    def __init__(self, api_key: str, api_token: str) -> None:
        """Initialize Trello reader."""
        self.api_key = api_key
        self.api_token = api_token

    def load_data(self, board_id: str) -> List[Document]:
        """Load data from a Trello board.

        Args:
            board_id (str): Trello board ID.


        Returns:
            List[Document]: List of documents representing Trello cards.
        """
        from trello import TrelloClient

        client = TrelloClient(api_key=self.api_key, token=self.api_token)
        board = client.get_board(board_id)
        cards = board.get_cards()

        documents = []
        for card in cards:
            document = Document(
                doc_id=card.name,
                text=card.description,
                extra_info={
                    "id": card.id,
                    "url": card.url,
                    "due_date": card.due_date,
                    "labels": [label.name for label in card.labels],
                },
            )
            documents.append(document)

        return documents

load_data #

load_data(board_id: str) -> List[Document]

Load data from a Trello board.

Parameters:

Name Type Description Default
board_id str

Trello board ID.

 required

Returns:

Type Description
List[Document]

List[Document]: List of documents representing Trello cards.
Source code in llama-index-integrations/readers/llama-index-readers-trello/llama_index/readers/trello/base.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def load_data(self, board_id: str) -> List[Document]:
    """Load data from a Trello board.

    Args:
        board_id (str): Trello board ID.


    Returns:
        List[Document]: List of documents representing Trello cards.
    """
    from trello import TrelloClient

    client = TrelloClient(api_key=self.api_key, token=self.api_token)
    board = client.get_board(board_id)
    cards = board.get_cards()

    documents = []
    for card in cards:
        document = Document(
            doc_id=card.name,
            text=card.description,
            extra_info={
                "id": card.id,
                "url": card.url,
                "due_date": card.due_date,
                "labels": [label.name for label in card.labels],
            },
        )
        documents.append(document)

    return documents