gituser/production/: cmarkgfm-0.4.0 metadata and description

Homepage Simple index

Minimal bindings to GitHub's fork of cmark

author The Python Packaging Authority
author_email thea@skeletonbuddy.com, pypa-dev@googlegroups.com
classifiers
  • Development Status :: 3 - Alpha
  • Intended Audience :: Developers
  • Topic :: Software Development :: Build Tools
  • License :: OSI Approved :: MIT License
  • Programming Language :: Python :: 2
  • Programming Language :: Python :: 2.7
  • Programming Language :: Python :: 3
  • Programming Language :: Python :: 3.4
  • Programming Language :: Python :: 3.5
  • Programming Language :: Python :: 3.6
File Tox results History
cmarkgfm-0.4.0.tar.gz
Size
129 KB
Type
Source

Minimalist bindings to GitHub’s fork of cmark.

Installation

This package is published as cmarkgfm and can be installed with pip or pipenv:

pip install --user cmarkgfm
pipenv install cmarkgfm

Usage

High-level usage is really straightforward. To render normal CommonMark markdown:

import cmarkgfm

html = cmarkgfm.markdown_to_html(markdown_text)

To render GitHub-flavored markdown:

import cmarkgfm

html = cmarkgfm.github_flavored_markdown_to_html(markdown_text)

Contributing

Pull requests are welcome. :)

License

This project is under the MIT License. It includes components under differing copyright under the third_party directory in this source tree.

TODO

  • Setup automatic wheel building.

  • Add more tests.