Conventions for writing code in the notebook.
Project description
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. doctest
s inmarkdown
are tested.- Include
object
s inmarkdown
withjinja2
template
syntax. notebook
s can be woven and tangled as documentation and code.notebook
s can be reproduced as tests.".md.ipynb"
is a composite extension that indicatespidgy
notebook
s primarly written inmarkdown
The pidgy
programming paper.
pidgy
is written as literate programming in notebook
s;
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 notebook
s 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')
testing pidgy
notebooks.
pidgy
is a pytest
plugin that can be used to include literature (eg. blog posts, issues, docs)
in software test suites.
pytest --nbval--doctest-modules readme.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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.