Skip to main content

pannb—pandoc filter for ipynb

Project description

Date:
January 25, 2022

Documentation Status image1

GitHub Actions Coverage Status image2 Codacy Badge Scrutinizer Status CodeClimate Quality Status

Supported versions Supported implementations PyPI Wheel PyPI Package latest release GitHub Releases Development Status Downloads Commits since latest release License

Conda Recipe Conda Downloads Conda Version Conda Platforms

Introduction

Pandoc supports ipynb format. What this does is add support of

  1. jupytext style yaml metadata block

  2. filter out the Python code block

  3. convert raw block to native pandoc AST, e.g.

    • if a cell outputs HTML, then it is an HTML raw block by default, meaning only HTML-like output formats contains these output cells. This filter convert them using pandoc itself to native pandoc AST so that any output formats will contains the same output.

These 3 filters are implemented as 3 individual functions, so that you can cherry-pick your own combinations (See API doc). The command line program pannb have all 3 included.

Example

See `docs/example.ipynb <https://github.com/ickc/pannb/blob/master/docs/example.ipynb>`__ for the input notebook and its output without the filter and output with the filter.

Supported pandoc versions

pandoc versioning semantics is MAJOR.MAJOR.MINOR.PATCH and panflute’s is MAJOR.MINOR.PATCH. Below we shows matching versions of pandoc that pannb supports, in descending order. Only major version is shown as long as the minor versions doesn’t matter.

pannb

panflute version

supported pandoc versions

supported pandoc API versions

0.1.2

2.1.3

2.17.x

1.22.1

0.1.1

2.1.3

2.15–2.16.x

1.22–1.22.1

0.1.0

2.1

2.11.2—2.14.x

1.22

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

pannb-0.1.3.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pannb-0.1.3-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file pannb-0.1.3.tar.gz.

File metadata

  • Download URL: pannb-0.1.3.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for pannb-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d3411018981b396f49948aea1bbdf7f2c385f8cf66b4b2a551b08e11c20f6b67
MD5 38ec685c7f7defe31b01cd7b031d488b
BLAKE2b-256 e746d6ac0469c1522aae7b7eb86330d83152f7b4e81c9b5a2258914d716e8895

See more details on using hashes here.

File details

Details for the file pannb-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: pannb-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for pannb-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 76ed7f8bec3d87a333ecb43d815c0fc1fb37d4f9b852cdddfacdcaef17cc9483
MD5 0c89cd403a56d59f730f01aab27245e9
BLAKE2b-256 ac244141faed62ceb6ea93b57bf1ba94f567c4a64fcee4f5954569a94f71d337

See more details on using hashes here.

Supported by

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