{ "info": { "author": "Andrew Fricke", "author_email": "andrew@uhnomoli.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: C", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Topic :: Internet", "Topic :: Internet :: WWW/HTTP", "Topic :: Text Processing", "Topic :: Utilities" ], "description": "Hoep\n====\n\nHoep is a Python binding for the `Hoedown`_ Markdown library.\n\n\nInstall\n-------\n\nHoep is available on PyPI so installation is only a quick ``pip`` away.\n\n::\n\n $ pip install hoep\n\n\nUnicode\n-------\n\nHoep only accepts and returns ``unicode`` objects in Python 2 and ``str`` objects in Python 3. This goes for custom renderers as well. All callbacks receive and must return ``unicode`` or ``str`` objects, respective to the Python version.\n\n\nBasic Usage\n-----------\n\nUsing Hoep is pretty straightforward. You can either use the ``render`` module function or the ``Hoep`` module class. The latter is more efficient if you are rendering multiple documents in a single go.\n\n.. code:: python\n\n # -*- coding: utf-8 -*-\n\n from __future__ import unicode_literals\n\n import hoep as h\n\n\n extensions = h.EXT_STRIKETHROUGH\n render_flags = h.HTML_SMARTYPANTS\n\n\n # Method form.\n html = h.render('Some ~~bold~~ __\"strong\"__ text.', extensions, render_flags)\n\n\n # Class form.\n md = h.Hoep(extensions, render_flags)\n\n html = md.render('Some ~~bold~~ __\"strong\"__ text.')\n\nExtensions\n~~~~~~~~~~\n\nYou can enable multiple extensions by bitwise ORing them.\n\n- ``EXT_AUTOLINK``: Automatically parse URLs into links.\n- ``EXT_DISABLE_INDENTED_CODE``: Disables indented code blocks.\n- ``EXT_FENCED_CODE``: Enables fenced code blocks.\n- ``EXT_FOOTNOTES``: Enables `Markdown Extra style footnotes`_.\n- ``EXT_HIGHLIGHT``: Enables ==marking== text.\n- ``EXT_LAX_SPACING``: Removes the need for an empty line between Markdown and raw HTML.\n- ``EXT_NO_INTRA_EMPHASIS``: Disables emphasis\\_between\\_words.\n- ``EXT_QUOTE``: \"Quotes\" are translated into ```` tags.\n- ``EXT_SPACE_HEADERS``: ATX style headers require a space after the opening number sign(s).\n- ``EXT_STRIKETHROUGH``: Enables ~~striking~~ text.\n- ``EXT_SUPERSCRIPT``: Enables super^script.\n- ``EXT_TABLES``: Enables `Markdown Extra style tables`_.\n- ``EXT_UNDERLINE``: Translates ```` tags into ```` tags.\n\nRender flags\n~~~~~~~~~~~~\n\nYou can enable multiple render flags by bitwise ORing them.\n\n- ``HTML_ESCAPE``: All HTML is escaped.\n- ``HTML_EXPAND_TABS``: Tabs are expanded to spaces.\n- ``HTML_HARD_WRAP``: Line breaks are translated into ``
`` tags.\n- ``HTML_SAFELINK``: Only links to safe protocols are allowed.\n- ``HTML_SKIP_HTML``: All HTML tags are stripped.\n- ``HTML_SKIP_IMAGES``: Images are ignored.\n- ``HTML_SKIP_LINKS``: Links are ignored.\n- ``HTML_SKIP_STYLE``: ``