Skip to main content

Pandoc Documents for Python

Project description

Pandoc (Python Library)
=======================

|PyPi| |Build Status|

**Warning.** This project is *not* a Python binding for
`pandoc <http://pandoc.org/>`__, the command-line tool. If this is what
you need, you can either use
`pypandoc <https://pypi.python.org/pypi/pypandoc/>`__,
`pyandoc <https://github.com/kennethreitz/pyandoc>`__, etc., or create
you own wrapper with
`subprocess <https://docs.python.org/2/library/subprocess.html>`__ or
`sh <https://amoffat.github.io/sh/>`__.

--------------

This library provides a Pythonic way to analyze, create and transform
documents. It targets the pandoc power users which are more productive
in Python than in Haskell (the native language of the pandoc library).

The pandoc Python library translates documents between the native pandoc
JSON format and a Python document model. If you need to manage other
formats (html, latex, etc.) use the pandoc command-line tool to convert
to/from the JSON format.

This library is still in the alpha stage and not documented; the typical
workflow is the following:

1. Get a document in the JSON format:

::

>>> json_input = [{"unMeta":{}},[{"t":"Para","c":[{"t":"Str","c":"Hello"}]}]]

2. Read it as a Python document

::

>>> import pandoc
>>> doc = pandoc.read(json_input)
>>> doc
Pandoc(Meta(map()), [Para([Str(u'Hello!')])])

3. Analyze and/or transform the document

::

>>> from pandoc.types import Space, Str
>>> doc[1].extend([Space(), Str(u"World!")])

4. Export the resulting document to JSON

::

>>> json_output = pandoc.write(doc)

To get a better feel of the Python document model, have a look at the
`test
suite <https://github.com/boisgera/pandoc/blob/master/pandoc/tests.md>`__.

.. raw:: html

<!--

Common Code
--------------------------------------------------------------------------------

For all examples, we use the following imports

import json
import sys
import pandoc
from pandoc.types import *

and the following depth-first document iterator:

def iter(elt, enter=None, exit=None):
yield elt
if enter is not None:
enter(elt)
if isinstance(elt, dict):
elt = elt.items()
if hasattr(elt, "__iter__"): # exclude strings
for child in elt:
for subelt in iter(child, enter, exit):
yield subelt
if exit is not None:
exit(elt)


Mathematics
--------------------------------------------------------------------------------

Define the file `math.py` to count the number of math items in documents:

def find_math(doc):
return [elt for elt in iter(doc) if type(elt) is Math]

if __name__ == "__main__":
doc = pandoc.read(json.load(sys.stdin))
print "math:", len(find_math(doc)), "items."

Then, use it on the (markdown) document `doc.txt`:

$ pandoc -t json doc.txt | python math.py


Implicit Sections
--------------------------------------------------------------------------------

I like to use bold text at the beginning of a paragraph to denote the existence
of a low-level section.
This pattern can be detected and the sections automatically explicited.

Define a `sections.py` file ; then, use the hooks defined in the depth-first
iterator factory to provide the full path from the root to the element at
each step:

def iter_path(elt):
parents = []
def enter(elt_):
parents.append(elt_)
def exit(elt_):
parents.pop()
for elt_ in iter(elt, enter, exit):
yield parents + [elt_]

Leverage this new iterator to find the parent of an element:

def find_parent(doc, elt):
for path in iter_path(doc):
elt_ = path[-1]
parent = path[-2] if len(path) >= 2 else None
if elt is elt_:
return parent

To detect a paragraph that is an implicit section, define:

def match_implicit_section(elt):
if type(elt) is Para:
content = elt[0]
if len(content) >= 1 and type(content[0]) is Strong:
return True
return False

The transformation itself:

def explicit_sections(doc, level=6):
for para in filter(match_implicit_section, iter(doc)):
blocks = find_parent(doc, para)
content = para[0].pop(0)[0]
if len(para[0]) >= 1 and para[0][0] == Space():
para[0].pop(0)
index = blocks.index(para)
header = Header(level, ("", [], []), content)
blocks.insert(index, header)
return doc

Finally, provide the command-line API with

if __name__ == "__main__":
doc = pandoc.read(json.load(sys.stdin))
doc = explicit_sections(doc)
print json.dumps(pandoc.write(doc))

and use it like that:

$ pandoc -t json doc.txt | \
> python sections.py | \
> pandoc -f json -o doc2.txt

-->

.. |PyPi| image:: https://img.shields.io/pypi/v/pandoc.svg
:target: https://pypi.python.org/pypi/pandoc
.. |Build Status| image:: https://travis-ci.org/boisgera/pandoc.svg?branch=master
:target: https://travis-ci.org/boisgera/pandoc

Project details


Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page