gorlins / panflute

An Pythonic alternative to John MacFarlane's pandocfilters, with extra helper functions

Panflute: Pythonic Pandoc Filters

panflute is a Python package that makes creating Pandoc filters fun.

For a detailed user guide, documentation, and installation instructions, see http://scorreia.com/software/panflute/. For examples that you can use as starting points, check the examples repo, the sample template, or this github search. If you want to contribute, head here.

You might also find useful this presentation on how I use markdown+pandoc+panflute to write research papers (at the Banco de Portugal 2019 Workshop on Reproductible Research).

Install

To install panflute, open the command line and type:

pip install panflute

Python 3.6+ and PyPy3 are supported (Python 2.7 and Python 3.3-3.5 were supported up to version 1.11.4).

Uninstall

pip uninstall panflute

Dev Install

After cloning the repo and opening the panflute folder:

python setup.py install: installs the package locally

python setup.py develop: installs locally with a symlink so changes are automatically updated

Contributing

Feel free to submit push requests. For consistency, code should comply with pep8 (as long as its reasonable), and with the style guides by @kennethreitz and google. Read more here.

License

BSD3 license (following pandocfilters by @jgm).