Skip to main content

Pandoc Documents for Python

Project description

[![PyPi](https://img.shields.io/pypi/v/pandoc.svg)](https://pypi.python.org/pypi/pandoc) ![Python](https://img.shields.io/pypi/pyversions/pandoc.svg) ![Status](https://img.shields.io/pypi/status/pandoc.svg) [![Travis CI Build Status](https://travis-ci.org/boisgera/pandoc.svg?branch=master)](https://travis-ci.org/boisgera/pandoc) [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/usube01hmjcl1m0t?svg=true)](https://ci.appveyor.com/project/boisgera/pandoc)

A Pythonic Version of Pandoc

[Pandoc] is the “document swiss army knife” made by [John MacFarlane]. It brings:

  • a command-line tool,

  • a Haskell library,

  • a document (meta-)model.

If you only need to convert some documents from one format into another (say Markdown to HTML or Markdown to PDF), the command line tool is what you need. But if additionally you need to analyze, create or transform documents, you may find this Python library useful, especially if you’re proficient in Python but don’t know Haskell.

[Pandoc]: http://pandoc.org/ [John MacFarlane]: http://johnmacfarlane.net/ [Haskell]: https://www.haskell.org/ [Python]: https://www.python.org/

The basic process is the following:

  1. First, create a document; for example, read a Markdown text

    >>> import pandoc
    >>> markdown = "Hello"
    >>> doc = pandoc.read(markdown)
    >>> doc
    Pandoc(Meta(map()), [Para([Str(u'Hello!')])])
    
  2. Then, analyze and/or transform the document as you like

    >>> from pandoc.types import *
    >>> para = doc[1][0]
    >>> para
    Para([Str(u'Hello')])
    >>> contents = para[0]
    >>> contents
    [Str(u'Hello')]
    >>> contents.extend([Space(), Str("World!")])
    >>> doc
    Pandoc(Meta(map()), [Para([Str(u'Hello'), Space(), Str('World')])])
    
  3. Finally, output the new document as Markdown

    >>> pandoc.write(doc)
    u'Hello World\n'
    

    and optionally, generate its HTML version

    >>> pandoc.write(doc, file="doc.html")
    u'<p>Hello World</p>\n'
    

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

pandoc-2.0a1.tar.gz (37.0 kB view details)

Uploaded Source

File details

Details for the file pandoc-2.0a1.tar.gz.

File metadata

  • Download URL: pandoc-2.0a1.tar.gz
  • Upload date:
  • Size: 37.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for pandoc-2.0a1.tar.gz
Algorithm Hash digest
SHA256 b40aeb98d83fda8a168575b5d20d4eeec7c0c294475f90c587729dcbab63f791
MD5 9767506bda52b2761194f40ca66508a2
BLAKE2b-256 2f0e3e4e26503e0f8c341ed3bb0f30e7bb8c92050ec8cf6fdf47d225e75cbfc9

See more details on using hashes here.

Supported by

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