Metadata-Version: 2.1
Name: trello2md
Version: 0.5.0
Summary: Export Trello boards and cards to Markdown
Home-page: https://github.com/bhrutledge/trello2md
Author: Brian Rutledge
Author-email: brian@bhrutledge.com
License: MIT
Description: # 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
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
