https://github.com/bhrutledge/trello2md
Export Trello boards and cards to Markdown
https://github.com/bhrutledge/trello2md
Last synced: 10 months ago
JSON representation
Export Trello boards and cards to Markdown
- Host: GitHub
- URL: https://github.com/bhrutledge/trello2md
- Owner: bhrutledge
- License: mit
- Created: 2019-05-06T18:29:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-21T22:10:01.000Z (almost 6 years ago)
- Last Synced: 2025-06-23T06:17:51.271Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 169 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# trello2md
Export Trello boards and cards to Markdown. Currently tailored to my note-taking workflow.
## Installation
Install on your system with [pipx](https://github.com/pipxproject/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](https://tox.readthedocs.io/en/latest/) on your system, for example using [pipx](pipxproject.github.io/)
```
$ pipx install tox
```
- [Fork and clone](https://help.github.com/en/articles/fork-a-repo) 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](https://docs.python.org/3/tutorial/venv.html)
```
$ tox -e venv
$ source venv/bin/activate
```
This will install:
- [pytest](https://docs.pytest.org/en/latest/) and [coverage.py](https://coverage.readthedocs.io/en/latest/) to run the tests
- [mypy](https://mypy.readthedocs.io/en/latest/) to check types
- [black](https://black.readthedocs.io/en/stable/) to format the code
- [flake8](http://flake8.pycqa.org/en/latest/) to identify coding errors and check code style