gfm-cmark-py

A Python wrapper for GitHub's fork of 'cmark', supporting GFM) extensions


Keywords
hosted, by, github, cmark, markdown, markup, gfm, ctypes, wrapper, debian-packaging
License
BSD-3-Clause
Install
pip install gfm-cmark-py

Documentation

gfm-cmark-py

 Travis CI  Coveralls  GitHub Issues  License  Development Status  Latest Version  Download format  Downloads

A Python wrapper for GitHub's fork of cmark, supporting GFM extensions. cmark is a CommonMark parsing and rendering library written in C, and the project also includes Debian packaging for it.

THIS IS IN ALPHA STATUS!

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.

Related Projects