Skip to content

vchrombie/pytrello2

 
 

Repository files navigation

pytrello2

CI Python Coverage Status PyPI version

Python wrapper for the Trello API

pytrello2 is a Python wrapper and ORM that provides an easy way to interact with the Trello API. Trello serves as a visual tool that enables teams to effectively oversee various projects, workflows, or task tracking via boards that can have files, checklists, and automation. pytrello2 handles authentication, mapping Python objects to Trello JSON, and provides a clean interface for all API endpoints.

Installation

You can install pytrello2 using pip:

pip install pytrello2

You can also install pytrello2 using Poetry:

cd pytrello2/
poetry install
poetry shell

Authentication

A Trello API key and token is needed to use pytrello2. To set up authentication, follow these steps:

  1. Obtain your Trello API key by logging into Trello, and then visiting https://trello.com/1/appKey/generate.
  2. Generate a token using the key, and grant the necessary permissions.

Example

import os
from pytrello2 import TrelloClient

# Replace 'YOUR_API_KEY' and 'YOUR_TOKEN' with your Trello API key and token.
token = os.environ["TRELLO_TOKEN"]
api_key = os.environ["TRELLO_API_KEY"]

client = TrelloClient(token, api_key)

# Get all boards of the authenticated user
boards = client.board.get_all_boards()

for board in boards:
    print(f"Board Name: {board.name}, Board ID: {board.id}")

Contributing

Contributions are welcome!

Check out the Contributing Guidelines for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Python wrapper for the Trello API

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%