gfm-cmark-py

               

A Python wrapper for GitHub's fork of cmark, supporting GFM extensions. cmark is a CommonMark parsing and rendering library written in C. This project also includes Debian packaging for it, to simplify deployment to platforms using APT.

THIS IS IN ALPHA STATUS!

Contents

Introduction

TODO

It also features Debian packaging for the underlying cmark library, for easy installation on distros using APT.

Usage

TODO

Installation

gfm-cmark-py can be installed via pip install gfm-cmark-py as usual, see releases for an overview of available versions. To get a bleeding-edge version from source, use these commands:

repo="jhermann/gfm-cmark-py"
pip install -r "https://raw.githubusercontent.com/$repo/master/requirements.txt"
pip install -UI -e "git+https://github.com/$repo.git#egg=${repo#*/}"

As a developer, to create a working directory for this project, call these commands:

git clone "https://github.com/jhermann/gfm-cmark-py.git"
cd "gfm-cmark-py"
command . .env --yes --develop  # add '--virtualenv /usr/bin/virtualenv' for Python2
invoke build check

You might also need to follow some setup procedures to make the necessary basic commands available on Linux, Mac OS X, and Windows.

Building the Debian Package

Call these commands:

version=0.27.1
curl -sLSo "cmark-gfm_$version.orig.tar.gz" "https://github.com/github/cmark/archive/$version.tar.gz"
cd cmark-gfm

# The "debian/" directorxy wa sinitially made using…
#   dh_make -f "cmark-gfm_$version.orig.tar.gz" --packagename cmark-gfm_$version -c bsd --multi
dpkg-buildpackage -uc -us

dpkg-deb -I ../cmark-gfm_$version-*_amd64.deb
dpkg-deb -I ../libcmark-gfm_$version-*_amd64.deb

Related Projects

• github/cmark – GitHub's fork of cmark, supporting GFM extensions.
• jgm/cmark – CommonMark parsing and rendering library and program in C.
• rtfd/CommonMark-py – Pure Python implementation of CommonMark.
• cmark 0.26.1-1 source package (Ubuntu Zesty)