Metadata-Version: 2.1
Name: commentary
Version: 0.2.1
Summary: comment-preserving docx <-- --> markdown converter
Home-page: https://github.com/hdb/commentary
Author: Hudson Bailey
Author-email: hudsondiggsbailey@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: pypandoc (>=1.4)
Requires-Dist: pyyaml (>=5.2)

# Commentary

Commentary is a command line document conversion tool that preserves native-style comments between Markdown and MS Word.

## Requirements

- [Python 3](https://www.python.org/downloads/)
- [Git](https://git-scm.com/) (optional; required for track changes)
- [Pandoc](https://pandoc.org/)

## Installation

```
pip install commentary
```

## Usage

```
usage: commentary [-h] [-o [OUTPUT]] [-a [AUTHOR]] [-m] [-t] [-p] [-D]
                  [-A [DEFAULT_AUTHOR]]
                  [input]

comment-preserving docx-markdown converter

positional arguments:
  input                 input

optional arguments:
  -h, --help            show this help message and exit
  -o [OUTPUT], --output [OUTPUT]
                        ouput filename. supports docx and txt/md
  -a [AUTHOR], --author [AUTHOR]
                        name to appear in docx comments
  -m, --metadata        preserve comment metadata in docx to md conversions
  -p, --print           print results to terminal
  -D, --force-docx-comments
                        force conversion to docx-style comments during md -->
                        md conversion. default is to use markdown-style
                        comments
  -A [DEFAULT_AUTHOR], --default-author [DEFAULT_AUTHOR]
                        configure default name to appear in docx comments

```

## Configuration

Use `-A 'AUTHOR NAME'` to save the default comment author name to `~/.config/commentary.yaml`.

## Converting Comments

Commentary handles comments well in most cases. Docx comments which highlight areas spanning multiple paragraphs may fail, however.

Using the `-m` flag, Commentary will save docx comment metadata within markdown html comment tags. For markdown-to-docx conversions, Commentary will re-convert these comments to docx with their original author and time-stamp metadata.


