pypandoc 0.9.3

Thin wrapper for pandoc.

pypandoc provides a thin wrapper for pandoc, a universal document converter.

Installation

• Install pandoc

• Ubuntu/Debian: sudo apt-get install pandoc

• Fedora/Red Hat: sudo yum install pandoc

• Mac OS X with Homebrew: brew install pandoc

• Machine with Haskell: cabal-install pandoc

• Windows: There is an installer available here

• FreeBSD port

• Or see http://johnmacfarlane.net/pandoc/installing.html

• pip install pypandoc

Usage

The basic invocation looks like this: pypandoc.convert('input', 'output format'). pypandoc tries to infer the type of the input automatically. If it’s a file, it will load it. In case you pass a string, you can define the format using the parameter. The example below should clarify the usage:

import pypandoc

output = pypandoc.convert('somefile.md', 'rst')

# alternatively you could just pass some string to it and define its format
output = pypandoc.convert('#some title', 'rst', format='md')
# output == 'some title\r\n==========\r\n\r\n'

In addition to format, it is possible to pass extra_args. That makes it possible to access various pandoc options easily.

output = pypandoc.convert(
    '<h1>Primary Heading</h1>',
    'md', format='html',
    extra_args=['--atx-headers'])
# output == '# Primary Heading\r\n'
output = pypandoc.convert(
    '# Primary Heading',
    'html', format='md',
    extra_args=['--base-header-level=2'])
# output == '<h2 id="primary-heading">Primary Heading</h2>\r\n'

Please refer to pandoc -h and the official documentation for further details.

Related

pydocverter is a client for a service called Docverter, which offers pandoc as a service (plus some extra goodies). It has the same API as pypandoc, so you can easily write code that uses one and falls back to the other. E.g.:

try:
    import pypandoc as converter
except ImportError:
    import pydocverter as converter

converter.convert('somefile.md', 'rst')

See pyandoc for an alternative implementation of a pandoc wrapper from Kenneth Reitz. This one hasn’t been active in a while though.

Contributors

• Valentin Haenel - String conversion fix

• Daniel Sanchez - Automatic parsing of input/output formats

• Thomas G. - Python 3 support

• Ben Jao Ming - Fail gracefully if pandoc is missing

• Ross Crawford-d’Heureuse - Encode input in UTF-8 and add Django example

• Michael Chow - Decode output in UTF-8

• Janusz Skonieczny - Support Windows newlines and allow encoding to be specified.

• gabeos - Fix help parsing

• Marc Abramowitz - Make setup.py fail hard if pandoc is missing, Travis, Dockerfile, PyPI badge, Tox, PEP-8, improved documentation

• Daniel L. - Add extra_args example to README

• Amy Guy - Exception handling for unicode errors

• Florian Eßer - Allow Markdown extensions in output format

• Philipp Wendler - Allow Markdown extensions in input format

License

pypandoc is available under MIT license. See LICENSE for more details.