https://github.com/jhermann/gfm-cmark-py

A Python wrapper for GitHub's fork of 'cmark', supporting GFM extensions
https://github.com/jhermann/gfm-cmark-py

cmark ctypes debian-packaging gfm markdown markup wrapper

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jhermann/gfm-cmark-py
• Owner: jhermann
• License: bsd-3-clause
• Created: 2017-03-15T10:29:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-03-16T22:43:11.000Z (over 7 years ago)
• Last Synced: 2024-10-07T20:08:25.724Z (about 1 month ago)
• Topics: cmark, ctypes, debian-packaging, gfm, markdown, markup, wrapper
• Language: Python
• Homepage:
• Size: 27.3 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
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. This project also includes Debian packaging for it,

to simplify deployment to platforms using APT.

**THIS IS IN ALPHA STATUS!**

.. contents:: **Contents**

.. _setup-start:

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)

.. _GFM: https://github.github.com/gfm/

.. _github/cmark: https://github.com/github/cmark

.. _`GitHub's fork of cmark`: https://github.com/github/cmark

.. _jgm/cmark: https://github.com/jgm/cmark

.. _rtfd/CommonMark-py: https://github.com/rtfd/CommonMark-py

.. _cmark 0.26.1-1 source package: https://launchpad.net/ubuntu/+source/cmark/0.26.1-1

.. |Travis CI| image:: https://api.travis-ci.org/jhermann/gfm-cmark-py.svg

    :target: https://travis-ci.org/jhermann/gfm-cmark-py

.. |Coveralls| image:: https://img.shields.io/coveralls/jhermann/gfm-cmark-py.svg

    :target: https://coveralls.io/r/jhermann/gfm-cmark-py

.. |GitHub Issues| image:: https://img.shields.io/github/issues/jhermann/gfm-cmark-py.svg

    :target: https://github.com/jhermann/gfm-cmark-py/issues

.. |License| image:: https://img.shields.io/pypi/l/gfm-cmark-py.svg

    :target: https://github.com/jhermann/gfm-cmark-py/blob/master/LICENSE

.. |Development Status| image:: https://pypip.in/status/gfm-cmark-py/badge.svg

    :target: https://pypi.python.org/pypi/gfm-cmark-py/

.. |Latest Version| image:: https://img.shields.io/pypi/v/gfm-cmark-py.svg

    :target: https://pypi.python.org/pypi/gfm-cmark-py/

.. |Download format| image:: https://pypip.in/format/gfm-cmark-py/badge.svg

    :target: https://pypi.python.org/pypi/gfm-cmark-py/

.. |Downloads| image:: https://img.shields.io/pypi/dw/gfm-cmark-py.svg

    :target: https://pypi.python.org/pypi/gfm-cmark-py/