A wrapper around various text markups
Project description
This module provides a wrapper around various text markup languages.
Available by default are Markdown, reStructuredText and Textile, but you can easily add your own markups.
Usage example:
>>> import markups >>> markup = markups.get_markup_for_file_name("myfile.rst") >>> markup.name 'reStructuredText' >>> markup.attributes[markups.common.SYNTAX_DOCUMENTATION] 'https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html' >>> text = """ ... Hello, world! ... ============= ... ... This is an example **reStructuredText** document. ... """ >>> result = markup.convert(text) >>> result.get_document_title() 'Hello, world!' >>> print(result.get_document_body()) # doctest: +NORMALIZE_WHITESPACE <main id="hello-world"> <h1 class="title" data-posmap="3">Hello, world!</h1> <p data-posmap="5">This is an example <strong>reStructuredText</strong> document.</p> </main>
The release version can be downloaded from PyPI or installed using:
pip install Markups
The source code is hosted on GitHub.
The documentation is available online or can be generated from source by installing Sphinx and running:
python3 setup.py build_sphinx
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Markups-3.1.3.tar.gz
(20.9 kB
view hashes)
Built Distribution
Markups-3.1.3-py3-none-any.whl
(12.8 kB
view hashes)