Skip to content

karimbahgat/iPandoc

Repository files navigation

iPandoc

Pure Python bindings to the online Docverter Pandoc document format conversion API. This way, you get access to the power of Pandoc from anywhere, without having to meddle with installing anything. Useful for lightweight applications or when you want to avoid the overhead of a full pandoc installation.

See: http://www.docverter.com/

Platforms

Python 2 and 3.

Dependencies

Pure Python, no dependencies.

Installing it

iPandoc is installed with pip from the commandline:

pip install ipandoc

Usage

iPandoc is very simple to use. There is only one function, which converts a piece of text to another document format.

This can be pretty useful, especially for dynamically converting a project README file, which some people write in markdown format for displaying at GitHub, over to ReStructured text for displaying at PyPi (e.g. in your project's setup.py file).

import ipandoc
markdown = open("README.md").read()
rst = ipandoc.convert(text=markdowntext,
                      fromformat="markdown",
                      toformat="rst")

Of course, there are many other text formats you can convert between. See API documentation link for more details on usage and options.

More Information:

License:

This code is free to share, use, reuse, and modify according to the MIT license, see license.txt

Credits:

Karim Bahgat

Changes

1.0.0 (2018-09-14)

  • Bump to stable version
  • Python 3 support

About

Pure Python bindings to the online Docverter Pandoc document format conversion API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages