Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.1 KB

README.rst

File metadata and controls

35 lines (24 loc) · 1.1 KB

mwcomposerfromhell

image

mwcomposerfromhell is a Python package that provides an easy-to-use method to convert MediaWiki Wikicode to HTML via mwparserfromhell. It supports Python 3.

Usage

Normal usage is rather straightforward to convert from a str of Wikicode to a str of HTML. It involves two steps:

  1. Parse the Wikicode to an abstract syntax tree using mwparserfromhell.
  2. Convert the AST to HTML.
>>> import mwparserfromhell
>>> import mwcomposerfromhell
>>> wikicode = mwparserfromhell.parse(text)  # Step 1
>>> html = mwcomposerfromhell.compose(wikicode)  # Step 2

You can also use it from the command line if you already have your wikicode in a file. The convert HTML is output on standard out.

python -m mwcomposerfromhell path/to/my/wikicode