pidgy 0.2.1

Conventions for writing code in the notebook.

pidgy literate notebook programming

pidgy is literate programming kernel and shell for IPython. When pidgy is enabled:

• Write code in markdown, indented and fenced are executed.
• doctests in markdown are tested.
• Include objects in markdown with jinja2 template syntax.
• notebooks can be woven and tangled as documentation and code.
• notebooks can be reproduced as tests.
• ".md.ipynb" is a composite extension that indicates pidgy notebooks primarly written in markdown

The pidgy programming paper.

pidgy is written as literate programming in notebooks; the narrative develop together into a cohesive program that serves dually as literature and reusable source code.

import pidgy

pidgy command line application

Install the IPython kernels

Install the pidgy kernel so you can use whenever you want.

pidgy kernel install

Load the IPython extension

Otherwise, using the pidgy IPython extension any jupyter notebook.

%load_ext pidgy

Likely, the only other paper of the api you made need is the pidgy.pidgyLoader that allows pidgy documents to be imported as normal source code. The loader searches for notebooks with the ".md.ipynb" extension and adds them to the python import system.

reuse pidgy documents as modules

with pidgy.pidgyLoader():
    import readme
assert readme.__file__.endswith('.md.ipynb')

The plurality of pidgy

Above we've highlight a few outcomes of pidgy programming. pidgy is written as both documentation and source code therefore it can be viewed by the following tools.

• nbviewer
• github pages
• readthedocs
• binder
• actions