Skip to main content

Pythonic Pandoc filters

Project description

# Panflute: Pythonic Pandoc Filters

[![Python version](https://img.shields.io/pypi/pyversions/panflute.svg)](https://pypi.python.org/pypi/panflute/) [![PyPI version](https://img.shields.io/pypi/v/panflute.svg)](https://pypi.python.org/pypi/panflute/) [![Development Status](https://img.shields.io/pypi/status/panflute.svg)](https://pypi.python.org/pypi/panflute/) [![Build Status](https://travis-ci.org/sergiocorreia/panflute.svg?branch=master)](https://travis-ci.org/sergiocorreia/panflute)

[panflute](http://scorreia.com/software/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](/CONTRIBUTING.md).

## Install

To install panflute, open the command line and type:

`bash 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

`bash pip3 install git+git://github.com/sergiocorreia/panflute.git `

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

![autocomplete](https://cloud.githubusercontent.com/assets/214056/21284243/76c922f8-c3e4-11e6-8d2d-03c2d30b3737.png)

## 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

In addition, if you use python2, you need to pasteurize the code before running tests. Run pasteurize -wnj 4 . in this directory.

## Contributing

Feel free to submit push requests. For consistency, code should comply with [pep8](https://pypi.python.org/pypi/pep8) (as long as its reasonable), and with the style guides by [@kennethreitz](http://docs.python-guide.org/en/latest/writing/style/) and [google](http://google.github.io/styleguide/pyguide.html). Read more [here](/CONTRIBUTING.md).

## License

BSD3 license (following pandocfilters by @jgm).

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

panflute-1.10.1.tar.gz (25.7 kB view hashes)

Uploaded Source

Built Distribution

panflute-1.10.1-py2.py3-none-any.whl (29.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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