Is this pandoc or a pandoc wrapper?

[buhtz]

It is not clear for me from reading the code or the docu.

Is this repo the official pandoc or is it a pandoc wrapper? In the latter case I need a pandoc executable/binary installed on my system right?

[boisgera]

Hi @buhtz ,

This is not the official pandoc repo, which is https://github.com/jgm/pandoc. I was expecting my README to be good enough to disambiguate this issue, but maybe I was too optimistic 😕:

🚀 Getting started

Pandoc – the general markup converter (and Haskell library) written by John MacFarlane – needs to be available.
You may follow the official installation instructions or use conda:

$ conda install -c conda-forge pandoc

[...]

Anyway, if you search for "pandoc Python" on Github, here is what you get:

• jgm/pandocfilters requires the pandoc CLI and it's official (@jgm being the author of pandoc). But it's not a wrapper of the Pandoc CLI ; it's a Python module to support the development of Pandoc filters in Python. E.g. it helps you to write a caps.py Python script to capitalize all words in a document. You use it like this:

  pandoc -t json -s | ./caps.py | pandoc -f json

• Panflute is an unofficial but (arguably) more Pythonic library to design Pandoc filters in Python. Since it provides filters, the pandoc CLI is still necessary to do anything useful with it.

• Pandoc (Python library) (this project) is similar to Panflute in many ways ; it also tries to be Pythonic, it also requires the Pandoc CLI to be installed, it also focuses on document transformations, etc. However, it doesn't use (or provide) filters ; your document transform will be a Python program.

• JessicaTegner/pypandoc is a wrapper of the pandoc CLI. It requires the pandoc CLI, but its API can even help you with this (see https://github.com/JessicaTegner/pypandoc#installing-pandoc).

Does it help?

Cheers,

Sébastien

[buhtz]

Thanks a lot for explaining.

Pandoc – the general markup converter (and Haskell library) written by John MacFarlane – needs to be available.

Maybe it depends on my none-native English that this sentences isn't 100% clear to me.

Something like this (from PyPandas) is more clear to someone like me:

Pypandoc uses pandoc, so it needs an available installation of pandoc.

[boisgera]

You're right, my sentence is convoluted ... In my defence, English is not my native langage either! 😊