{"author":"Bibek Kafle , Roland Shoemaker ","author_email":"rolandshoemaker@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Environment :: Console","Environment :: Other Environment","Intended Audience :: Developers","License :: OSI Approved :: BSD License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 2","Programming Language :: Python :: 3","Topic :: Documentation","Topic :: Internet :: WWW/HTTP :: Dynamic Content","Topic :: Software Development :: Documentation","Topic :: Software Development :: Libraries :: Python Modules","Topic :: Text Processing :: Markup","Topic :: Utilities"],"description":"commonmark.py\n=============\n\ncommonmark.py is a pure Python port of `jgm `__'s\n`commonmark.js `__, a\nMarkdown parser and renderer for the\n`CommonMark `__ specification, using only native\nmodules. Once both this project and the CommonMark specification are\nstable we will release the first ``1.0`` version and attempt to keep up\nto date with changes in ``commonmark.js``.\n\ncommonmark.py is tested against the CommonMark spec with Python versions\n2.7, 3.4, 3.5, 3.6, and 3.7.\n\n**Current version:** 0.9.1\n\n|Pypi Link| |Build Status| |Doc Link|\n\nInstallation\n------------\n\n::\n\n $ pip install commonmark\n\nUsage\n-----\n\n::\n\n >>> import commonmark\n >>> commonmark.commonmark('*hello!*')\n '

hello!

\\n'\n\nOr, without the syntactic sugar:\n\n.. code:: python\n\n import commonmark\n parser = commonmark.Parser()\n ast = parser.parse(\"Hello *World*\")\n\n renderer = commonmark.HtmlRenderer()\n html = renderer.render(ast)\n print(html) #

Hello World

\n\n # inspecting the abstract syntax tree\n json = commonmark.dumpJSON(ast)\n commonmark.dumpAST(ast) # pretty print generated AST structure\n\nThere is also a CLI:\n\n::\n\n $ cmark README.md -o README.html\n $ cmark README.md -o README.json -aj # output AST as JSON\n $ cmark README.md -a # pretty print generated AST structure\n $ cmark -h\n usage: cmark [-h] [-o [O]] [-a] [-aj] [infile]\n\n Process Markdown according to the CommonMark specification.\n\n positional arguments:\n infile Input Markdown file to parse, defaults to stdin\n\n optional arguments:\n -h, --help show this help message and exit\n -o [O] Output HTML/JSON file, defaults to stdout\n -a Print formatted AST\n -aj Output JSON AST\n\n\nContributing\n------------\n\nIf you would like to offer suggestions/optimizations/bugfixes through\npull requests please do! Also if you find an error in the\nparser/renderer that isn't caught by the current test suite please open\na new issue and I would also suggest you send the\n`commonmark.js `__ project\na pull request adding your test to the existing test suite.\n\nTests\n-----\n\nTo work on commonmark.py, you will need to be able to run the test suite to\nmake sure your changes don't break anything. To run the tests, you can do\nsomething like this:\n\n::\n\n $ pyvenv venv\n $ ./venv/bin/python setup.py develop test\n\nThe tests script, ``commonmark/tests/run_spec_tests.py``, is pretty much a devtool. As\nwell as running all the tests embedded in ``spec.txt`` it also allows you\nto run specific tests using the ``-t`` argument, provide information\nabout passed tests with ``-p``, percentage passed by category of test\nwith ``-s``, and enter markdown interactively with ``-i`` (In\ninteractive mode end a block by inputting a line with just ``end``, to\nquit do the same but with ``quit``). ``-d`` can be used to print call\ntracing.\n\n::\n\n $ ./venv/bin/python commonmark/tests/run_spec_tests.py -h\n usage: run_spec_tests.py [-h] [-t T] [-p] [-f] [-i] [-d] [-np] [-s]\n\n script to run the CommonMark specification tests against the commonmark.py\n parser.\n\n optional arguments:\n -h, --help show this help message and exit\n -t T Single test to run or comma separated list of tests (-t 10 or -t 10,11,12,13)\n -p Print passed test information\n -f Print failed tests (during -np...)\n -i Interactive Markdown input mode\n -d Debug, trace calls\n -np Only print section header, tick, or cross\n -s Print percent of tests passed by category\n\nAuthors\n-------\n\n- `Bibek Kafle `__\n- `Roland Shoemaker `__\n- `Nikolas Nyby `__\n\n.. |Pypi Link| image:: https://img.shields.io/pypi/v/commonmark.svg\n :target: https://pypi.org/project/commonmark/\n\n.. |Build Status| image:: https://travis-ci.org/rtfd/commonmark.py.svg?branch=master\n :target: https://travis-ci.org/rtfd/commonmark.py\n\n.. |Doc Link| image:: https://readthedocs.org/projects/commonmarkpy/badge/?version=latest\n :target: https://commonmarkpy.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\n","description_content_type":"text/x-rst","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/rtfd/commonmark.py","keywords":"markup,markdown,commonmark","license":"BSD-3-Clause","license_expression":null,"license_files":null,"maintainer":"Nikolas Nyby","maintainer_email":"nikolas@gnu.org","name":"commonmark","package_url":"https://pypi.org/project/commonmark/","platform":"","project_url":"https://pypi.org/project/commonmark/","project_urls":{"Homepage":"https://github.com/rtfd/commonmark.py"},"provides_extra":null,"release_url":"https://pypi.org/project/commonmark/0.9.1/","requires_dist":["future (>=0.14.0) ; python_version < \"3\"","flake8 (==3.7.8) ; extra == 'test'","hypothesis (==3.55.3) ; extra == 'test'"],"requires_python":"","summary":"Python parser for the CommonMark Markdown spec","version":"0.9.1","yanked":false,"yanked_reason":null}

Dependencies of commonmark (3).
Dependency	Optional
future	false
flake8	true
hypothesis	true

Package search

commonmark

project_urls

Dependencies

All package metadata

Releases