Skip to main content

A tool for loading Trello boards and converting them to Markdown for AI agents

Project description

Trello Loader

A tool for loading Trello boards and converting them to structured Markdown files for AI agents.

Features

  • Loads Trello boards via the official API
  • Converts Trello lists and cards into structured Markdown files
  • Preserves important information such as descriptions, checklists, labels, and due dates
  • Formats tasks as Markdown ToDo lists, ideal for AI agents

Installation with uv

This project is managed with uv, an ultra-fast Python package manager.

If you don't have uv installed yet, you can install it with the following command:

curl -sSf https://install.astronomer.dev | sh

Or on Windows with:

powershell -c "irm https://install.astronomer.dev | iex"

Project Installation

  1. Clone the repository
  2. Change to the project directory
  3. Install dependencies with uv:
uv pip install -e .

Configuration

  1. Create a .env file in the project's root directory
  2. Add your Trello API keys (see .env.example)

To obtain Trello API keys:

  1. Visit https://trello.com/app-key
  2. Log in with your Trello account
  3. Copy your API key
  4. Generate a token with appropriate permissions

Usage

List all boards

uv run trello-to-md list-boards

Convert a board

uv run trello-to-md convert BOARD_ID

Where BOARD_ID is the ID of the Trello board, which you can find using list-boards.

Options

  • --output / -o: Path to the output Markdown file
  • --archived / -a: Include archived cards

Example

trello-to-md convert abc123 -o my_tasks.md

Output Format

The generated Markdown file is structured as follows:

# Board Name

Board description, if available

*Created on: YYYY-MM-DD HH:MM*

*Board ID: abc123*

---

## List 1

- [ ] **Card name**
  Card description
  - Checklists:
    - Checklist 1
      - [ ] Item 1
      - [x] Item 2
  - Tags: `Tag1`, `Tag2`
  - Due: YYYY-MM-DD HH:MM
  - [Go to card](https://trello.com/...)

## List 2

- [ ] **Card name 2**
  ...

Publishing to PyPI

If you want to publish this package to PyPI:

  1. Update the version in pyproject.toml and trello_loader/__init__.py
  2. Install the required build tools:
    uv pip install build twine
    
  3. Build the package:
    uv run -m build
    
  4. Upload to PyPI:
    uv run -m twine upload dist/*
    

You'll need PyPI credentials to publish the package.

Installation from PyPI

Once published, the package can be installed with:

uv pip install trello-loader

License

MIT

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

trello_loader-0.1.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

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

trello_loader-0.1.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file trello_loader-0.1.0.tar.gz.

File metadata

  • Download URL: trello_loader-0.1.0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for trello_loader-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8857daeff4c7b3239126122aca9b06e4e5793ac4be4cc3a30fa7c87f54057c2e
MD5 c9f9e8754cdb189cc80772396ab15695
BLAKE2b-256 c81f2f5b454ab20f3a8648d8674a71821f9fb94d0efdfa579804c67e72152575

See more details on using hashes here.

File details

Details for the file trello_loader-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: trello_loader-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for trello_loader-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1fa141971c2e315c05e5ec5223a0c150381d649612fe6a7d7a65e50c345dfb36
MD5 e84f68fdebf15fe6bad4e066d805342f
BLAKE2b-256 13eaa296a095b9dd88cb9fed31b0a10628cc0c45e66ec18a9ed14cc2d4c56b97

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