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 system with pipx:

$ pipx install --python python3.8 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) 2019-05-07, @bhrutledge, `green`, `Sample Label`
- [Copied Card](copied-card.md) 2019-05-07

## 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

2019-05-07, @bhrutledge, `green`, `Sample Label`

Sample description

## Checklist

- [x] Completed item
- [ ] Incomplete item

## Attachments

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

## Comments

### bhrutledge on 2019-05-06

Sample comment

Developing

  • Install tox on your system, for example using pipx

    $ pipx install tox
    
  • Fork and clone this repository

  • Run the tests and generate a coverage report

    $ tox -e py38,coverage
    
  • Run the formatters and linters

    $ tox -e check
    
  • To run development tools individually, create and activate a virtual environment

    $ tox -e venv
    
    $ source venv/bin/activate
    

    This will install:

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.4.0.tar.gz (61.9 kB view hashes)

Uploaded Source

Built Distribution

trello2md-0.4.0-py2.py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 2 Python 3

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