Skip to main content

Thin wrapper for pandoc.

Project description

Latest Version Build Status

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'

It’s also possible to directly let pandoc write the output to a file. This is the only way to convert to some output formats (e.g. odt, docx, epub, epub3). In that case convert() will return an empty string.

import pypandoc

output = pypandoc.convert('somefile.md', 'docx', outputfile="somefile.docx")
assert output == ""

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.

Contributing

Contributions are welcome. When opening a PR, please keep the following guidelines in mind:

  1. Before implementing, please open an issue for discussion.

  2. Make sure you have tests for the new logic.

  3. Make sure your code passes flake8 pypandoc.py tests.py

  4. Add yourself to contributors at README.md unless you are already there. In that case tweak your contributions.

Contributors

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypandoc-0.9.4.tar.gz (5.8 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page