Skip to main content

Commentary

Commentary is a command line document conversion tool and pandoc filter that preserves native-style comments between Markdown and docx files.

Installation

pip install commentary

Basic Usage

echo 'Hello <!-- this is a comment --> world' > doc.md

# convert from md to docx using the CLI
commentary doc.md -o out.docx

# or invoke as a filter from pandoc
pandoc doc.md -F commentary-filter --wrap=none -o out.docx

# add metadata to your markdown comments
commentary doc.md -o doc.md

See documentation for full usage guide.

Metadata

Release files for commentary 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for commentary 0.3.1
File Interpreter ABI Platform Actions
commentary-0.3.1-py3-none-any.whl Python 3 none any Details for commentary-0.3.1-py3-none-any.whl

Release files / commentary-0.3.1-py3-none-any.whl

Download URL commentary-0.3.1-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
edfa78e36f8ee6d3edf85dc0c97d8a6c855edb3a506914f37d9d453863d2db67
BLAKE2b-256 checksum
How to use checksums
b81096e5e267526ca56669ea19391f03e0168f1cd55f4c105a00467eab47218d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.11.0 pkginfo/1.7.0 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.10

Security for commentary 0.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page