/panflute

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

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Panflute: Pythonic Pandoc Filters

Python version PyPI version Development Status Build Status

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/. If you want to contribute, head here.

Install

To install panflute, open the command line and type:

pip install panflute
  • Support Python 2.7, 3.3 or later, pypy, and pypy3.
  • On windows, the command line (cmd) must be run as administrator.

Alternatively, if you use Python3 only, you can install it with

pip install git+git://github.com/sergiocorreia/panflute.git

An advantage of this later installation method is that it has better autocomplete hints:

autocomplete

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).