Skip to main content

Export Trello boards and cards to Markdown

Project description

trello2md

Export Trello boards and cards to Markdown. Currently tailored to my note-taking workflow.

Installation

Install on your path with pipx:

$ pipx install trello2md

Authorize use of the Trello API:

$ trello2md auth

Exporting a Trello board

Run with the URL for a Trello board as the only argument to write Markdown files to a directory. For example:

$ trello2md https://trello.com/b/WODq2cwg/sample-board

$ tree sample-board/
sample-board/
├── another-card-1.md
├── another-card-2.md
├── another-card.md
├── copied-card.md
├── index.md
└── sample-card.md

$ cat sample-board/index.md
# {Sample Board}

## Sample List

- [Sample Card](sample-card.md)
- [Copied Card](copied-card.md)

## Empty List

## Another List

- [Another Card](another-card.md)
- [Another Card](another-card-1.md)
- [Another Card](another-card-2.md)

Exporting a Trello card

Run with the URL for a Trello card as the only argument to print Markdown. For example:

$ trello2md https://trello.com/c/HGYGb5iM/2-sample-card
# Sample Card

**Due:** 2019-05-07

Sample description

## Checklist

- [x] Completed item
- [ ] Incomplete item

## Attachments

- [Example link](https://example.com)

## Comment from Brian Rutledge on 2019-05-06

Sample comment

Developing

  • Fork and clone this repository

  • Create and activate a virtual environment

    $ cd trello2md
    
    $ python3 -m venv venv
    
    $ source venv/bin/activate
    
  • Install this package and its dependencies for development

    $ pip install -e .[dev]
    

    This will install:

    • pytest for writing and running tests
    • mypy to check types
    • black to format the code
    • flake8 to identify coding errors and check code style
    • pydocstyle to check docstring style

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

trello2md-0.3.1b1.tar.gz (29.8 kB view hashes)

Uploaded Source

Supported by

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