Pandoc Documents for Python


License
MIT
Install
pip install pandoc==2.0a4

Documentation

Pandoc (Python Library)

Travis CI Build Status AppVeyor Build status

This README is about the 2.x branch of the library (alpha stage!).

Getting started

Install the latest version with:

$ pip install --upgrade git+https://github.com/boisgera/pandoc.git

The Pandoc command-line tool is a also required dependency ; you may install it with :

$ conda install -c conda-forge pandoc 

Overview

This project brings Pandoc's data model for markdown documents to Python:

$ echo "Hello world!" | python -m pandoc read 
Pandoc(Meta({}), [Para([Str('Hello'), Space(), Str('world!')])])

It can be used to analyze, create and transform documents, in Python :

>>> import pandoc
>>> text = "Hello world!"
>>> doc = pandoc.read(text)
>>> doc
Pandoc(Meta({}), [Para([Str('Hello'), Space(), Str('world!')])])

>>> paragraph = doc[1][0]
>>> paragraph
Para([Str('Hello'), Space(), Str('world!')])
>>> from pandoc.types import Str
>>> paragraph[0][2] = Str('Python!')
>>> text = pandoc.write(doc)
>>> print(text)
Hello Python!

Pandoc is the general markup converter (and Haskell library) written by John MacFarlane.